apply_filters( "pre_site_option_{$option}", mixed $pre_option , string $option , int $network_id , mixed $default_value )
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 value other than false from the filter will short-circuit retrieval and return that value instead.
Parameters
- $pre_option
-
The value to return instead of the option value. This differs from
$default_value
, which is used as the fallback value in the event the option doesn't exist elsewhere in get_network_option().<br> Default false (to skip past the short-circuit). - $option
-
Option name.
- $network_id
-
ID of the network.
- $default_value
-
The fallback value to return if the option does not exist.<br> Default false.
Source
File: wp-includes/option.php
Changelog
Version | Description |
---|---|
4.9.0 | The $default_value 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. As 'pre_site*option*' . $key |