customize_validate_<id>

Validates a Customize setting value.

Description

apply_filters( 'customize_validate_<id>', (WP_Error) $validity, (mixed) $value, (WP_Customize_Setting) $instance ); 

Plugins should amend the $validity object via its WP_Error::add() method.

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

Parameters (3)

0. $validity (WP_Error)
Filtered from true to WP_Error when invalid.
1. $value (mixed)
Value of the setting.
2. $instance (WP_Customize_Setting)
WP_Customize_Setting instance.

Usage

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

Defined (1)

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

/wp-includes/class-wp-customize-setting.php  
  1. $validity = apply_filters( "customize_validate_{$this->id}", $validity, $value, $this );