site_option_(option) │ filter-hook │ WP 3.0.0

Filters the value of an existing network option.

The dynamic portion of the hook name, $option, refers to the option name.

Usage

add_filter( 'site_option_(option)', 'wp_kama_site_option_filter', 10, 3 );

/**
 * Function for `site_option_(option)` filter-hook.
 * 
 * @param mixed  $value      Value of network option.
 * @param string $option     Option name.
 * @param int    $network_id ID of the network.
 *
 * @return mixed
 */
function wp_kama_site_option_filter( $value, $option, $network_id ){

	// filter...
	return $value;
}

$value(mixed)

Value of network option.

$option(string)

Option name.

$network_id(int)

ID of the network.

Changelog

Where the hook is called

return apply_filters( "site_option_{$option}", $value, $option, $network_id );

Where the hook is used in WordPress

add_filter( 'site_option_welcome_user_email', 'welcome_user_msg_filter' );

remove_filter( 'site_option_welcome_user_email', 'welcome_user_msg_filter' );