add_option( string $option, mixed $value = '', string $deprecated = '', string|bool $autoload = 'yes' )

Add a new option.

Contents

Description Description

You do not need to serialize values. If the value needs to be serialized, then it will be serialized before it is inserted into the database. Remember, resources can not be serialized or added as an option.

You can create options without values and then update the values later. Existing options will not be updated and checks are performed to ensure that you aren’t adding a protected WordPress option. Care should be taken to not name options the same as the ones which are protected.

Parameters Parameters

$option

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

$value

(mixed) (Optional) Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.

Default value: ''

$deprecated

(string) (Optional) Description. Not used anymore.

Default value: ''

$autoload

(string|bool) (Optional) Whether to load the option when WordPress starts up. Default is enabled. Accepts 'no' to disable for legacy reasons.

Default value: 'yes'

Top ↑

Return Return

(bool) False if option was not added and true if option was added.

Top ↑

Source Source

File: wp-includes/option.php

449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) {
    global $wpdb;
 
    if ( ! empty( $deprecated ) ) {
        _deprecated_argument( __FUNCTION__, '2.3.0' );
    }
 
    $option = trim( $option );
    if ( empty( $option ) ) {
        return false;
    }
 
    wp_protect_special_option( $option );
 
    if ( is_object( $value ) ) {
        $value = clone $value;
    }
 
    $value = sanitize_option( $option, $value );
 
    // Make sure the option doesn't already exist. We can check the 'notoptions' cache before we ask for a db query
    $notoptions = wp_cache_get( 'notoptions', 'options' );
    if ( ! is_array( $notoptions ) || ! isset( $notoptions[ $option ] ) ) {
        /** This filter is documented in wp-includes/option.php */
        if ( apply_filters( "default_option_{$option}", false, $option, false ) !== get_option( $option ) ) {
            return false;
        }
    }
 
    $serialized_value = maybe_serialize( $value );
    $autoload         = ( 'no' === $autoload || false === $autoload ) ? 'no' : 'yes';
 
    /**
     * Fires before an option is added.
     *
     * @since 2.9.0
     *
     * @param string $option Name of the option to add.
     * @param mixed  $value  Value of the option.
     */
    do_action( 'add_option', $option, $value );
 
    $result = $wpdb->query( $wpdb->prepare( "INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s) ON DUPLICATE KEY UPDATE `option_name` = VALUES(`option_name`), `option_value` = VALUES(`option_value`), `autoload` = VALUES(`autoload`)", $option, $serialized_value, $autoload ) );
    if ( ! $result ) {
        return false;
    }
 
    if ( ! wp_installing() ) {
        if ( 'yes' == $autoload ) {
            $alloptions            = wp_load_alloptions();
            $alloptions[ $option ] = $serialized_value;
            wp_cache_set( 'alloptions', $alloptions, 'options' );
        } else {
            wp_cache_set( $option, $serialized_value, 'options' );
        }
    }
 
    // This option exists now
    $notoptions = wp_cache_get( 'notoptions', 'options' ); // yes, again... we need it to be fresh
    if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) {
        unset( $notoptions[ $option ] );
        wp_cache_set( 'notoptions', $notoptions, 'options' );
    }
 
    /**
     * Fires after a specific option has been added.
     *
     * The dynamic portion of the hook name, `$option`, refers to the option name.
     *
     * @since 2.5.0 As "add_option_{$name}"
     * @since 3.0.0
     *
     * @param string $option Name of the option to add.
     * @param mixed  $value  Value of the option.
     */
    do_action( "add_option_{$option}", $option, $value );
 
    /**
     * Fires after an option has been added.
     *
     * @since 2.9.0
     *
     * @param string $option Name of the added option.
     * @param mixed  $value  Value of the option.
     */
    do_action( 'added_option', $option, $value );
    return true;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version Description
1.0.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_get()

Retrieves the cache contents from the cache by key and group.
wp-includes/cache.php: wp_cache_set()

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

Sanitises various option values based on the nature of the option.
wp-includes/functions.php: _deprecated_argument()

Mark a function argument as deprecated and inform when it has been used.
wp-includes/functions.php: maybe_serialize()

Serialize data, if needed.
wp-includes/plugin.php: apply_filters()

Call the functions added to a filter hook.
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: add_option

Fires before an option is added.
wp-includes/option.php: add_option_{$option}

Fires after a specific option has been added.
wp-includes/option.php: added_option

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

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

Retrieves an option value based on an option name.
wp-includes/option.php: default_option_{$option}

Filters the default value for an option.
wp-includes/wp-db.php: wpdb::query()

Perform a MySQL database query, using current database connection.
wp-includes/wp-db.php: wpdb::prepare()

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

Top ↑

User Contributed Notes User Contributed Notes

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