delete_option( string $option )

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

Contents

Description Description

Parameters Parameters

$option

(string) (Required) Name of option to remove. Expected to not be SQL-escaped.

Top ↑

Return Return

(bool) True, if option is successfully deleted. False on failure.

Top ↑

Source Source

File: wp-includes/option.php

548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
function delete_option( $option ) {
    global $wpdb;
 
    $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 ( 'yes' == $row->autoload ) {
            $alloptions = wp_load_alloptions();
            if ( is_array( $alloptions ) && isset( $alloptions[ $option ] ) ) {
                unset( $alloptions[ $option ] );
                wp_cache_set( 'alloptions', $alloptions, 'options' );
            }
        } else {
            wp_cache_delete( $option, '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;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
1.2.0 Introduced.

Top ↑

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/load.php: wp_installing()

Check or set whether WordPress is in “installation” mode.
wp-includes/cache.php: wp_cache_set()

Saves the data to the cache.
wp-includes/cache.php: wp_cache_delete()

Removes the cache contents matching key and group.
wp-includes/plugin.php: do_action()

Execute functions hooked on a specific action hook.
wp-includes/option.php: wp_load_alloptions()

Loads and caches all autoloaded options, if available or all options.
wp-includes/option.php: delete_option

Fires immediately before an option is deleted.
wp-includes/option.php: delete_option_{$option}

Fires after a specific option has been deleted.
wp-includes/option.php: deleted_option

Fires after an option has been deleted.
wp-includes/option.php: wp_protect_special_option()

Protect WordPress special option from being modified.
wp-includes/wp-db.php: wpdb::get_row()

Retrieve one row from the database.
wp-includes/wp-db.php: wpdb::delete()

Delete a row in the table
wp-includes/wp-db.php: wpdb::prepare()

Prepares a SQL query for safe execution. Uses sprintf()-like syntax.
Show 7 more uses Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/taxonomy.php: clean_taxonomy_cache()

Clean the caches for a taxonomy.
wp-includes/nav-menu.php: _wp_menus_changed()

Handle menu config after theme change.
wp-includes/rest-api/endpoints/class-wp-rest-settings-controller.php: WP_REST_Settings_Controller::update_item()

Updates settings for the settings object.
wp-admin/includes/class-wp-upgrader.php: WP_Upgrader::release_lock()

Releases an upgrader lock.
wp-includes/option.php: delete_network_option()

Removes a network option by name.
wp-includes/taxonomy.php: _wp_batch_split_terms()

Splits a batch of shared taxonomy terms.
wp-admin/includes/class-wp-site-icon.php: WP_Site_Icon::delete_attachment_data()

Deletes the Site Icon when the image file is deleted.
wp-admin/includes/misc.php: update_home_siteurl()

Flushes rewrite rules if siteurl, home or page_on_front changed.
wp-admin/includes/schema.php: populate_options()

Create WordPress options and set the default values.
wp-admin/includes/update-core.php: update_core()

Upgrades the core of WordPress.
wp-includes/theme.php: remove_theme_mods()

Remove theme modifications option for current theme.
wp-includes/theme.php: switch_theme()

Switches the theme.
wp-includes/theme.php: get_theme_mods()

Retrieve all theme modifications.
wp-includes/class-wp-theme.php: WP_Theme::get_allowed_on_site()

Returns array of stylesheet names of themes allowed on the site.
wp-includes/option.php: get_transient()

Get the value of a transient.
wp-includes/option.php: set_transient()

Set/update the value of a transient.
wp-includes/option.php: delete_transient()

Delete a transient.
wp-includes/post.php: _reset_front_page_settings_for_post()

Reset the page_on_front, show_on_front, and page_for_post settings when a linked page is deleted or trashed.
wp-includes/revision.php: _wp_upgrade_revisions_of_post()

Upgrade the revisions author, add the current post as a revision and set the revisions version to 1
wp-includes/ms-functions.php: maybe_add_existing_user_to_blog()

Add a new user to a blog by visiting /newbloguser/{key}/.
wp-includes/ms-blogs.php: delete_blog_option()

Removes option by name for a given blog id. Prevents removal of protected WordPress options.
Show 16 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.