default_site_option_<option>

Filters a specific default network option.

Description

apply_filters( 'default_site_option_<option>', (mixed) $default, (string) $option, (int) $network_id ); 

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

Parameters (3)

0. $default (mixed)
The value to return if the site option does not exist in the database.
1. $option (string)
Option name.
2. $network_id (int)
ID of the network.

Usage

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

Defined (3)

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

/wp-includes/option.php  
  1. return apply_filters( "default_site_option_{$option}", $default, $option, $network_id ); 
  1. $default = apply_filters( 'default_site_option_' . $option, $default, $option, $network_id ); 
  1. $value = apply_filters( 'default_site_option_' . $option, $default, $option, $network_id );