Changeset 35810

Timestamp:

12/06/2015 11:21:46 PM (9 years ago)

Author:

westonruter

Message:

Customizer: Apply customize_dynamic_setting_class and customize_dynamic_setting_args filters in calls to WP_Customize_Manager::add_setting( $id, $args ).

Ensure that plugin filters apply as expected for any settings registered statically without passing in an explicit class instance to WP_Customize_Manager::add_setting().

Fixes #34597.

Location:

trunk

Files:

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

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

@@ -1050 +1050 @@
             $setting = $id;
         } else {
-            $setting = new WP_Customize_Setting( $this, $id, $args );
+            $class = 'WP_Customize_Setting';
+
+            /** This filter is documented in wp-includes/class-wp-customize-manager.php */
+            $args = apply_filters( 'customize_dynamic_setting_args', $args, $id );
+
+            /** This filter is documented in wp-includes/class-wp-customize-manager.php */
+            $class = apply_filters( 'customize_dynamic_setting_class', $class, $id, $args );
+
+            $setting = new $class( $this, $id, $args );
         }
 

trunk/tests/phpunit/tests/customize/manager.php

@@ -246 +246 @@
      */
     function filter_customize_dynamic_setting_args_for_test_dynamic_settings( $setting_args, $setting_id ) {
-        $this->assertEquals( false, $setting_args, 'Expected $setting_args to be false by default.' );
         $this->assertInternalType( 'string', $setting_id );
         if ( in_array( $setting_id, array( 'foo', 'bar' ) ) ) {
@@ -543 +542 @@
 
     /**
+     * @ticket 34597
+     */
+    function test_add_setting_honoring_dynamic() {
+        $manager = new WP_Customize_Manager();
+
+        $setting_id = 'dynamic';
+        $setting = $manager->add_setting( $setting_id );
+        $this->assertEquals( 'WP_Customize_Setting', get_class( $setting ) );
+        $this->assertObjectNotHasAttribute( 'custom', $setting );
+        $manager->remove_setting( $setting_id );
+
+        add_filter( 'customize_dynamic_setting_class', array( $this, 'return_dynamic_customize_setting_class' ), 10, 3 );
+        add_filter( 'customize_dynamic_setting_args', array( $this, 'return_dynamic_customize_setting_args' ), 10, 2 );
+        $setting = $manager->add_setting( $setting_id );
+        $this->assertEquals( 'Test_Dynamic_Customize_Setting', get_class( $setting ) );
+        $this->assertObjectHasAttribute( 'custom', $setting );
+        $this->assertEquals( 'foo', $setting->custom );
+    }
+
+    /**
+     * Return 'Test_Dynamic_Customize_Setting' in 'customize_dynamic_setting_class.
+     *
+     * @param string $class Setting class.
+     * @param array  $args  Setting args.
+     * @param string $id    Setting ID.
+     * @return string       Setting class.
+     */
+    function return_dynamic_customize_setting_class( $class, $id, $args ) {
+        unset( $args );
+        if ( 0 === strpos( $id, 'dynamic' ) ) {
+            $class = 'Test_Dynamic_Customize_Setting';
+        }
+        return $class;
+    }
+
+    /**
+     * Return 'Test_Dynamic_Customize_Setting' in 'customize_dynamic_setting_class.
+     *
+     * @param array  $args Setting args.
+     * @param string $id   Setting ID.
+     * @return string      Setting args.
+     */
+    function return_dynamic_customize_setting_args( $args, $id ) {
+        if ( 0 === strpos( $id, 'dynamic' ) ) {
+            $args['custom'] = 'foo';
+        }
+        return $args;
+    }
+
+    /**
      * @ticket 34596
      */
@@ -603 +652 @@
     }
 }
+
+require_once ABSPATH . WPINC . '/class-wp-customize-setting.php';
+
+/**
+ * Class Test_Dynamic_Customize_Setting
+ *
+ * @see Tests_WP_Customize_Manager::test_add_setting_honoring_dynamic()
+ */
+class Test_Dynamic_Customize_Setting extends WP_Customize_Setting {
+    public $type = 'dynamic';
+    public $custom;
+}