pre_site_option_(option) │ filter-hook │ WP 3.0.0

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.

Usage

add_filter( 'pre_site_option_(option)', 'wp_kama_pre_site_option_filter', 10, 4 );

/**
 * Function for `pre_site_option_(option)` filter-hook.
 * 
 * @param mixed  $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().
 * @param string $option        Option name.
 * @param int    $network_id    ID of the network.
 * @param mixed  $default_value The fallback value to return if the option does not exist.
 *
 * @return mixed
 */
function wp_kama_pre_site_option_filter( $pre_option, $option, $network_id, $default_value ){

	// filter...
	return $pre_option;
}

$pre_option(mixed)

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)

$option(string)

Option name.

$network_id(int)

ID of the network.

$default_value(mixed)

The fallback value to return if the option does not exist.
Default: false

Changelog

Where the hook is called

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

Where the hook is used in WordPress