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_optionmixed
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() .
Default false (to skip past the short-circuit).
$optionstring
Option name.
$network_idint
ID of the network.
$default_valuemixed
The fallback value to return if the option does not exist.
Default false.

Source

$pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id, $default_value );

Changelog

VersionDescription
4.9.0The $default_value parameter was added.
4.7.0The $network_id parameter was added.
4.4.0The $option parameter was added.
3.0.0
2.9.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.