Function: get_option

get_option( string $option, mixed $default )

Retrieves an option value based on an option name.

Shortcut: go

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.

If the option does not exist or does not have a value, then the return value will be false. This is useful to check whether you need to install an option and is commonly used during installation of plugin options and to test whether upgrading is required.

If the option was serialized then it will be unserialized when it is returned.

Any scalar values will be returned as strings. You may coerce the return type of a given option by registering an \'option_$option' filter callback.

Parameters

Name Type(s) Default Value Description
$option string

Name of option to retrieve. Expected to not be SQL-escaped.

$default mixed false

Optional. Default value to return if the option does not exist.

Returns

mixed

Value set for the option.

WordPress Developer Newsletter

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