delete_option( string $option ): bool

Removes an option by name. Prevents removal of protected WordPress options.

Parameters

$optionstringrequired

Name of the option to delete. Expected to not be SQL-escaped.

Return

Source

function delete_option( $option ) {
	global $wpdb;
	if ( is_scalar( $option ) ) {
		$option = trim( $option );
	}
	if ( empty( $option ) ) {
		return false;
	}
	wp_protect_special_option( $option );
	// Get the ID, if no ID then return.
	$row = $wpdb->get_row( $wpdb->prepare( "SELECT autoload FROM $wpdb->options WHERE option_name = %s", $option ) );
	if ( is_null( $row ) ) {
		return false;
	}
	/**
	 * Fires immediately before an option is deleted.
	 *
	 * @since 2.9.0
	 *
	 * @param string $option Name of the option to delete.
	 */
	do_action( 'delete_option', $option );
	$result = $wpdb->delete( $wpdb->options, array( 'option_name' => $option ) );
	if ( ! wp_installing() ) {
		if ( in_array( $row->autoload, wp_autoload_values_to_autoload(), true ) ) {
			$alloptions = wp_load_alloptions( true );
			if ( is_array( $alloptions ) && isset( $alloptions[ $option ] ) ) {
				unset( $alloptions[ $option ] );
				wp_cache_set( 'alloptions', $alloptions, 'options' );
			}
		} else {
			wp_cache_delete( $option, 'options' );
		}
		$notoptions = wp_cache_get( 'notoptions', 'options' );
		if ( ! is_array( $notoptions ) ) {
			$notoptions = array();
		}
		$notoptions[ $option ] = true;
		wp_cache_set( 'notoptions', $notoptions, 'options' );
	}
	if ( $result ) {
		/**
		 * Fires after a specific option has been deleted.
		 *
		 * The dynamic portion of the hook name, `$option`, refers to the option name.
		 *
		 * @since 3.0.0
		 *
		 * @param string $option Name of the deleted option.
		 */
		do_action( "delete_option_{$option}", $option );
		/**
		 * Fires after an option has been deleted.
		 *
		 * @since 2.9.0
		 *
		 * @param string $option Name of the deleted option.
		 */
		do_action( 'deleted_option', $option );
		return true;
	}
	return false;
}

View all references View on Trac View on GitHub

Hooks

do_action( ‘deleted_option’, string $option )

Fires after an option has been deleted.

do_action( ‘delete_option’, string $option )

Fires immediately before an option is deleted.

do_action( “delete_option_{$option}”, string $option )

Fires after a specific option has been deleted.

Related

Changelog

User Contributed Notes

1. Skip to note 3 content

   Codex 10 years ago

   You must log in to vote on the helpfulness of this note Vote results for this note: 2You must log in to vote on the helpfulness of this note

   Delete a single option

   This will delete ‘my_option’ from the options table within your MySQL database.

   <?php delete_option( 'my_option' ); ?>
2. Skip to note 4 content

   MakeWebBetter 6 years ago

   You must log in to vote on the helpfulness of this note Vote results for this note: 1You must log in to vote on the helpfulness of this note

   On Plugin deactivation if want to delete all settings.

   $settingOptions = array( 'plugin_status', 'export_status', 'notifications', 'label_settings' ); // etc
   // Clear up our settings
   foreach ( $settingOptions as $settingName ) {
    delete_option( $settingName );
   }