Files
| Filename | Hook Type | Line Number | PHP Doc |
|---|---|---|---|
| wp-includes/option.php | apply_filters | 1436 | /** * Filters the value of an existing network option before it is retrieved. * * 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. * * @since 2.9.0 As 'pre_site_option_' . $key * @since 3.0.0 * @since 4.4.0 The `$option` parameter was added. * @since 4.7.0 The `$network_id` parameter was added. * @since 4.9.0 The `$default` parameter was added. * * @param mixed $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_network_option(). * Default false (to skip past the short-circuit). * @param string $option Option name. * @param int $network_id ID of the network. * @param mixed $default The fallback value to return if the option does not exist. * Default false. */ |
Hook Parameters
| Parameter Type | Name | Description |
|---|---|---|
| mixed | $pre_option | The value to return instead of the option value. This differs |
| string | $option | Option name. |
| int | $network_id | ID of the network. |
| mixed | $default | The fallback value to return if the option does not exist. |