default_option_<option>

Filters the default value for an option.

Description

apply_filters( 'default_option_<option>', (mixed) $default, (string) $option, (bool) $passed_default ); 

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

Parameters (3)

0. $default (mixed)
The default value to return if the option does not exist in the database.
1. $option (string)
Option name.
2. $passed_default (bool)
Was get_option() passed a default value?

Usage

To run the hook, copy the example below.
  1. $default = apply_filters( 'default_option_{$option}', $default, $option, $passed_default ); 
  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_option_<option> callback 
  2. function filter_default_option_option( $default, $option, $passed_default ) { 
  3. // make filter magic happen here... 
  4. return $default
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( "default_option_{$option}", 'filter_default_option_option', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( "default_option_{$option}", 'filter_default_option_option', 10, 3 ); 

Defined (5)

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

/wp-includes/option.php  
  1. return apply_filters( "default_option_{$option}", $default, $option, $passed_default ); 
  1. return apply_filters( "default_option_{$option}", $default, $option, $passed_default ); 
  1. return apply_filters( "default_option_{$option}", $default, $option, $passed_default ); 
  1. if ( apply_filters( 'default_option_' . $option, false, $option, false ) === $old_value ) { 
  1. if ( apply_filters( 'default_option_' . $option, false, $option, false ) !== get_option( $option ) )