get_option


get_option ( $option, $default = false )

Parameters:
  • (string) $option Name of option to retrieve. Expected to not be SQL-escaped.
  • (mixed) $default Optional. Default value to return if the option does not exist.
Returns:
  • (mixed) Value set for the option.
Defined at:

Description

Retrieves an option value based on an option name.

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 {@see 'option_$option'} filter callback.

Related Functions

__get_option, get_alloptions, get_blog_option, get_site_option, get_user_option

Top Google Results

User discussions

wpseek mobile