customize_sanitize_js_<id>

Filters a Customize setting value for use in JavaScript.

Description

apply_filters( 'customize_sanitize_js_<id>', (mixed) $this_value, (WP_Customize_Setting) $instance ); 

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

Parameters (2)

0. $this_value (mixed)
The setting value.
1. $instance (WP_Customize_Setting)
WP_Customize_Setting instance.

Usage

To run the hook, copy the example below.
  1. $this_value = apply_filters( 'customize_sanitize_js_{$id}', $this_value, $instance ); 
  2.  
  3. if ( !empty( $this_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_sanitize_js_<id> callback 
  2. function filter_customize_sanitize_js_id( $this_value, $instance ) { 
  3. // make filter magic happen here... 
  4. return $this_value
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( "customize_sanitize_js_{$id}", 'filter_customize_sanitize_js_id', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( "customize_sanitize_js_{$id}", 'filter_customize_sanitize_js_id', 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_sanitize_js_{$this->id}", $this->value(), $this );