Summery Summery
Filters the value of an existing option before it is retrieved.
Syntax Syntax
Description Description
The dynamic portion of the hook name, $option
, refers to the option name.
Passing a truthy value to the filter will short-circuit retrieving the option value, returning the passed value instead.
Parameters Parameters
- $pre_option
-
The value to return instead of the option value. This differs from
$default
, which is used as the fallback value in the event the option doesn't exist elsewhere in get_option(). Default false (to skip past the short-circuit). - $option
-
Option name.
- $default
-
The fallback value to return if the option does not exist. Default is false.
Source Source
File: wp-includes/option.php
Advertisement
Changelog Changelog
Version | Description |
---|---|
4.9.0 | The $default parameter was added. |
4.4.0 | The $option parameter was added. |
1.5.0 | Introduced. |