option_<option>

Filters the value of an existing option.

Description

apply_filters( 'option_<option>', (mixed) $maybe_unserialize, (string) $option ); 

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

Parameters (2)

0. $maybe_unserialize (mixed) => maybe_unserialize( $value )
Value of the option. If stored serialized, it will be unserialized prior to being returned.
1. $option (string)
Option name.

Usage

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

Defined (1)

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

/wp-includes/option.php  
  1. return apply_filters( "option_{$option}", maybe_unserialize( $value ), $option );