add_option() – Adds a new option.

You appear to be a bot. Output may be restricted

Description

Adds a new option.

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 cannot 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.

Usage

$bool = add_option( $option, $value, $deprecated, $autoload );

Parameters

$option
( string ) required – Name of the option to add. Expected to not be SQL-escaped.
$value
( mixed ) optional – Optional. Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
$deprecated
( string ) optional – Optional. Description. Not used anymore.
$autoload
( string|bool ) optional default: yes – Optional. Whether to load the option when WordPress starts up. Accepts 'yes'|true to enable or 'no'|false to disable. Autoloading too many options can lead to performance problems, especially if the options are not frequently used. For options which are accessed across several places in the frontend, it is recommended to autoload them, by using 'yes'|true. For options which are accessed only on few specific URLs, it is recommended to not autoload them, by using 'no'|false. Default 'yes'.

Returns

bool True if the option was added, false otherwise.

Source

File name: wordpress/wp-includes/option.php
Lines:

101 to 120 of 120
   * @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;
}
 

 View on GitHub View on Trac