Function: add_option

add_option( string $option, mixed $value, string $deprecated, string | boolean $autoload )

Add a new option.

Shortcut: ao

You can use above key combination to trigger the associated snippet for this function in the WordPress Snippets for Visual Studio Code extension. You can also use this shortcut to search for this function on this website.

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

Name Type(s) Default Value Description
$option string

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.

$deprecated string ''

Optional. Description. Not used anymore.

$autoload string | boolean 'yes'

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

Returns

boolean

False if option was not added and true if option was added.

WordPress Developer Newsletter

Stay informed of new chapter releases, important WordPress API updates and more.