Changeset 37350

Timestamp:

05/02/2016 10:41:36 PM (4 years ago)

Author:

westonruter

Message:

Customize: Pass WP_Customize_Setting instance as second argument to customize_value_{$id_base} filter.

Adds parity with setting instance being passed as second argument to customize_sanitize_{$id} and customize_sanitize_js_{$id}. Allows the actual ID of the (multidimensional) setting value being filtered to be inspected.

Props celloexpressions, westonruter.
Fixes #36452.

Location:

trunk

Files:

• src/wp-includes/class-wp-customize-setting.php (modified) (1 diff)
• tests/phpunit/tests/customize/setting.php (modified) (5 diffs)

trunk/src/wp-includes/class-wp-customize-setting.php

@@ -658 +658 @@
              *
              * @since 3.4.0
+             * @since 4.6.0 Added the `$this` setting instance as the second param.
              *
-             * @param mixed $default The setting default value. Default empty.
+             * @param mixed                $default The setting default value. Default empty.
+             * @param WP_Customize_Setting $this    The setting instance.
              */
-            $value = apply_filters( "customize_value_{$id_base}", $value );
-        } else if ( $this->is_multidimensional_aggregated ) {
+            $value = apply_filters( "customize_value_{$id_base}", $value, $this );
+        } elseif ( $this->is_multidimensional_aggregated ) {
             $root_value = self::$aggregated_multidimensionals[ $this->type ][ $id_base ]['root_value'];
             $value = $this->multidimensional_get( $root_value, $this->id_data['keys'], $this->default );

trunk/tests/phpunit/tests/customize/setting.php

@@ -278 +278 @@
     }
 
-    function custom_type_value_filter( $default ) {
+    /**
+     * Filter for `customize_value_{$id_base}`.
+     *
+     * @param mixed $default
+     * @param WP_Customize_Setting $setting
+     *
+     * @return mixed|null
+     */
+    function custom_type_value_filter( $default, $setting = null ) {
         $name = preg_replace( '/^customize_value_/', '', current_filter() );
+        $this->assertInstanceOf( 'WP_Customize_Setting', $setting );
+        $id_data = $setting->id_data();
+        $this->assertEquals( $name, $id_data['base'] );
         return $this->custom_type_getter( $name, $default );
     }
@@ -315 +326 @@
         $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
         // Note: #29316 will allow us to have one filter for all settings of a given type, which is what we need.
-        add_filter( "customize_value_{$name}", array( $this, 'custom_type_value_filter' ) );
+        add_filter( "customize_value_{$name}", array( $this, 'custom_type_value_filter' ), 10, 2 );
         $this->assertEquals( $this->undefined, $this->custom_type_getter( $name, $this->undefined ) );
         $this->assertEquals( $default, $setting->value() );
@@ -331 +342 @@
         $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
         // Note: #29316 will allow us to have one filter for all settings of a given type, which is what we need.
-        add_filter( "customize_value_{$name}", array( $this, 'custom_type_value_filter' ) );
+        add_filter( "customize_value_{$name}", array( $this, 'custom_type_value_filter' ), 10, 2 );
         $this->assertEquals( $initial_value, $this->custom_type_getter( $name, $this->undefined ) );
         $this->assertEquals( $initial_value, $setting->value() );
@@ -351 +362 @@
         $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
         // Note: #29316 will allow us to have one filter for all settings of a given type, which is what we need.
-        add_filter( "customize_value_{$name}", array( $this, 'custom_type_value_filter' ) );
+        add_filter( "customize_value_{$name}", array( $this, 'custom_type_value_filter' ), 10, 2 );
         $this->assertEquals( $this->undefined, $this->custom_type_getter( $name, $this->undefined ) );
         $this->assertEquals( $default, $setting->value() );
@@ -367 +378 @@
         $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type', 'default' ) );
         // Note: #29316 will allow us to have one filter for all settings of a given type, which is what we need.
-        add_filter( "customize_value_{$name}", array( $this, 'custom_type_value_filter' ) );
+        add_filter( "customize_value_{$name}", array( $this, 'custom_type_value_filter' ), 10, 2 );
         $this->assertEquals( $initial_value, $this->custom_type_getter( $name, $this->undefined ) );
         $this->assertEquals( $initial_value, $setting->value() );