Changeset 37166 for trunk/tests/phpunit/tests/customize/widgets.php

Timestamp:

04/07/2016 08:58:56 PM (10 years ago)

Author:

ocean90

Message:

Customize: Harden assignment of Customizer settings transports for selective refreshable widgets

Theme support for customize-selective-refresh-widgets can be added _after_ the logic for registering the settings for incoming widgets that have been changed. This is due to themes adding the theme support in after_setup_theme which is also the action where WP_Customize_Widgets::register_settings() is called. If these both happen at priority 10, which one is called first depends on which one was added first. The other issue is that at the time that WP_Customize_Widgets::register_settings() is called at after_setup_theme, it is called before widgets_init and thus no widgets are yet registered. This means that any settings registered at this point will always have a refresh transport even if the theme supports customize-selective-refresh-widgets, since the WP_Widget instance is not visible yet to see if it supports selective refresh.

The fix: Defer WP_Customize_Widgets::register_settings() from after_setup_theme to widgets_init at priority 95 when the widget objects have all been registered. Also, ensure that the preview filter for sidebars_widgets is added before the sidebars are iterated for adding the controls.

Props westonruter.
Fixes #36389.

File:

• trunk/tests/phpunit/tests/customize/widgets.php (modified) (4 diffs)

trunk/tests/phpunit/tests/customize/widgets.php

@@ -47 +47 @@
 
         $this->backup_registered_sidebars = $GLOBALS['wp_registered_sidebars'];
+
+        // Reset protected static var on class.
+        WP_Customize_Setting::reset_aggregated_multidimensionals();
     }
 
@@ -71 +74 @@
     function set_customized_post_data( $customized ) {
         $_POST['customized'] = wp_slash( wp_json_encode( $customized ) );
+        if ( $this->manager ) {
+            foreach ( $customized as $id => $value ) {
+                $this->manager->set_post_value( $id, $value );
+            }
+        }
     }
 
@@ -151 +159 @@
 
     /**
-     * Test WP_Customize_Widgets::register_settings()
+     * Test WP_Customize_Widgets::register_settings() with selective refresh enabled.
      *
      * @ticket 30988
+     * @ticket 36389
      */
     function test_register_settings() {
+        add_theme_support( 'customize-selective-refresh-widgets' );
 
         $raw_widget_customized = array(
@@ -177 +187 @@
         $this->assertTrue( is_customize_preview() );
 
-        $this->assertNotEmpty( $this->manager->get_setting( 'widget_categories[2]' ), 'Expected setting for pre-existing widget category-2, being customized.' );
-        $this->assertNotEmpty( $this->manager->get_setting( 'widget_search[2]' ), 'Expected setting for pre-existing widget search-2, not being customized.' );
-        $this->assertNotEmpty( $this->manager->get_setting( 'widget_search[3]' ), 'Expected dynamic setting for non-existing widget search-3, being customized.' );
+        if ( current_theme_supports( 'customize-selective-refresh-widgets' ) ) {
+            $expected_transport = 'postMessage';
+            $this->assertNotEmpty( $this->manager->widgets->get_selective_refreshable_widgets() );
+        } else {
+            $expected_transport = 'refresh';
+            $this->assertEmpty( $this->manager->widgets->get_selective_refreshable_widgets() );
+        }
+
+        $setting = $this->manager->get_setting( 'widget_categories[2]' );
+        $this->assertNotEmpty( $setting, 'Expected setting for pre-existing widget category-2, being customized.' );
+        $this->assertEquals( $expected_transport, $setting->transport );
+
+        $setting = $this->manager->get_setting( 'widget_search[2]' );
+        $this->assertNotEmpty( $setting, 'Expected setting for pre-existing widget search-2, not being customized.' );
+        $this->assertEquals( $expected_transport, $setting->transport );
+
+        $setting = $this->manager->get_setting( 'widget_search[3]' );
+        $this->assertNotEmpty( $setting, 'Expected dynamic setting for non-existing widget search-3, being customized.' );
+        $this->assertEquals( $expected_transport, $setting->transport );
 
         $widget_categories = get_option( 'widget_categories' );
         $this->assertEquals( $raw_widget_customized['widget_categories[2]'], $widget_categories[2], 'Expected $wp_customize->get_setting(widget_categories[2])->preview() to have been called.' );
+    }
+
+    /**
+     * Test registering settings without selective refresh enabled.
+     *
+     * @ticket 36389
+     */
+    function test_register_settings_without_selective_refresh() {
+        remove_theme_support( 'customize-selective-refresh-widgets' );
+        $this->test_register_settings();
+    }
+
+    /**
+     * Test registering settings with selective refresh enabled at a late after_setup_theme action.
+     *
+     * @ticket 36389
+     */
+    function test_register_settings_with_late_theme_support_added() {
+        remove_theme_support( 'customize-selective-refresh-widgets' );
+        add_action( 'after_setup_theme', array( $this, 'add_customize_selective_refresh_theme_support' ), 100 );
+        $this->test_register_settings();
+    }
+
+    /**
+     * Add customize-selective-refresh-widgets theme support.
+     */
+    function add_customize_selective_refresh_theme_support() {
+        add_theme_support( 'customize-selective-refresh-widgets' );
     }