sanitize_option_<option>

Filters an option value following sanitization.

Description

apply_filters( 'sanitize_option_<option>', (string) $value, (string) $option, (string) $original_value ); 

Parameters (3)

0. $value (string)
The sanitized option value.
1. $option (string)
The option name.
2. $original_value (string)
The original value passed to the function.

Usage

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

Defined (1)

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

/wp-includes/formatting.php  
  1. return apply_filters( "sanitize_option_{$option}", $value, $option, $original_value );