Changeset 37166 for trunk/src/wp-includes/class-wp-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/src/wp-includes/class-wp-customize-widgets.php (modified) (3 diffs)

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

@@ -100 +100 @@
 
         add_filter( 'customize_dynamic_setting_args',          array( $this, 'filter_customize_dynamic_setting_args' ), 10, 2 );
-        add_action( 'after_setup_theme',                       array( $this, 'register_settings' ) );
+        add_action( 'widgets_init',                            array( $this, 'register_settings' ), 95 );
         add_action( 'wp_loaded',                               array( $this, 'override_sidebars_widgets_for_theme_switch' ) );
         add_action( 'customize_controls_init',                 array( $this, 'customize_controls_init' ) );
@@ -376 +376 @@
     public function customize_register() {
         global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_sidebars;
+
+        add_filter( 'sidebars_widgets', array( $this, 'preview_sidebars_widgets' ), 1 );
 
         $sidebars_widgets = array_merge(
@@ -510 +512 @@
             }
         }
-
-        add_filter( 'sidebars_widgets', array( $this, 'preview_sidebars_widgets' ), 1 );
     }