WPDev.one
Core Function
View Source on Trac ↗

add_option()

add_option( mixed $option, mixed $value = '', mixed $deprecated = '', mixed $autoload = null )

Adds a new option.

Parameters 3 required

Name / Type Description
$option
string

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

Required
mixed

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

Required
$deprecated
string

Optional. Description. Not used anymore.

mixed

(bool | null) $autoload Optional. Whether to load the option when WordPress starts up. Accepts a boolean, or `null` to leave the decision up to default heuristics in WordPress. For backward compatibility 'yes' and 'no' are also accepted, though using these values is deprecated. 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 true. For options which are accessed only on few specific URLs, it is recommended to not autoload them, by using false. Default is null, which means WordPress will determine the autoload value.

Required

Return Value

(bool)
True if the option was added, false otherwise.

Function Information

Since Version
1.0.0
Source File
wp-includes/option.php
Advertisement