customize_value_<id_base>

Filters a Customize setting value not handled as a theme_mod or option.

Description

apply_filters( 'customize_value_<id_base>', (mixed) $value, (WP_Customize_Setting) $instance ); 

The dynamic portion(s) of the hook name refer to the base slug of the setting name, initialized from $this->id_data[base']'.

For settings handled as theme_mods or options, see those corresponding functions for available hooks.

Parameters (2)

0. $value (mixed)
The setting default value. Default empty.
1. $instance (WP_Customize_Setting)
The setting instance.

Usage

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

Defined (1)

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

/wp-includes/class-wp-customize-setting.php  
  1. $value = apply_filters( "customize_value_{$id_base}", $value, $this );