apply_filters( "pre_site_option_{$option}", mixed $pre_option, string $option, int $network_id, mixed $default )
Filters the value of an existing network option before it is retrieved.
Description
The dynamic portion of the hook name, $option
, refers to the option name.
Returning a truthy value from the filter will effectively short-circuit retrieval and return the passed value instead.
Parameters
- $pre_option
-
(mixed) 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_network_option(). Default false (to skip past the short-circuit). - $option
-
(string) Option name.
- $network_id
-
(int) ID of the network.
- $default
-
(mixed) The fallback value to return if the option does not exist. Default false.
Source
File: wp-includes/option.php
Changelog
Version | Description |
---|---|
4.9.0 | The $default parameter was added. |
4.7.0 | The $network_id parameter was added. |
4.4.0 | The $option parameter was added. |
3.0.0 | |
2.9.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/pre_site_option_option