pre_site_option_<option>

Filters an existing network option before it is retrieved.

Description

apply_filters( 'pre_site_option_<option>', (bool) $false, (string) $option, (int) $network_id ); 

The dynamic portion(s) of the hook name refer to the option name.

Passing a truthy value to the filter will effectively short-circuit retrieval, returning the passed value instead.

Parameters (3)

0. $false (bool) => false
The default value to return if the option does not exist.
1. $option (string)
Option name.
2. $network_id (int)
ID of the network.

Usage

To run the hook, copy the example below.
  1. $false = apply_filters( 'pre_site_option_{$option}', $false, $option, $network_id ); 
  2.  
  3. if ( !empty( $false ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the pre_site_option_<option> callback 
  2. function filter_pre_site_option_option( $false, $option, $network_id ) { 
  3. // make filter magic happen here... 
  4. return $false
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( "pre_site_option_{$option}", 'filter_pre_site_option_option', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( "pre_site_option_{$option}", 'filter_pre_site_option_option', 10, 3 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/option.php  
  1. $pre = apply_filters( "pre_site_option_{$option}", false, $option, $network_id );