Changeset 37040 for trunk/src/wp-includes/class-wp-customize-widgets.php

Timestamp:

03/21/2016 09:58:02 PM (10 years ago)

Author:

westonruter

Message:

Customize: Require opt-in for selective refresh of widgets.

• Introduces customize-selective-refresh-widgets theme support feature and adds to themes.
• Introduces customize_selective_refresh arg for WP_Widget::$widget_options and adds to all core widgets.
• Remove selective_refresh from being a component that can be removed via customize_loaded_components filter.
• Add WP_Customize_Widgets::get_selective_refreshable_widgets() and WP_Customize_Widgets::is_widget_selective_refreshable().
• Fix default selector for Partial instances.
• Implement and improve Masronry sidebar refresh logic in Twenty Thirteen and Twenty Fourteen, including preservation of initial widget position after refresh.
• Re-initialize ME.js when refreshing Twenty_Fourteen_Ephemera_Widget.

See #27355.
Fixes #35855.

File:

• trunk/src/wp-includes/class-wp-customize-widgets.php (modified) (13 diffs)

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

@@ -63 +63 @@
 
         /**
+         * Mapping of widget ID base to whether it supports selective refresh.
+         *
+         * @since 4.5.0
+         * @access protected
+         * @var array
+         */
+        protected $selective_refreshable_widgets;
+
+        /**
          * Mapping of setting type to setting ID pattern.
          *
@@ -70 +79 @@
          */
         protected $setting_id_patterns = array(
-                'widget_instance' => '/^(widget_.+?)(?:\[(\d+)\])?$/',
-                'sidebar_widgets' => '/^sidebars_widgets\[(.+?)\]$/',
+                'widget_instance' => '/^widget_(?P<id_base>.+?)(?:\[(?P<widget_number>\d+)\])?$/',
+                'sidebar_widgets' => '/^sidebars_widgets\[(?P<sidebar_id>.+?)\]$/',
         );
 
@@ -113 +122 @@
 
         /**
+         * List whether each registered widget can be use selective refresh.
+         *
+         * If the theme does not support the customize-selective-refresh-widgets feature,
+         * then this will always return an empty array.
+         *
+         * @since 4.5.0
+         * @access public
+         *
+         * @return array Mapping of id_base to support. If theme doesn't support
+         *               selective refresh, an empty array is returned.
+         */
+        public function get_selective_refreshable_widgets() {
+                global $wp_widget_factory;
+                if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) {
+                        return array();
+                }
+                if ( ! isset( $this->selective_refreshable_widgets ) ) {
+                        $this->selective_refreshable_widgets = array();
+                        foreach ( $wp_widget_factory->widgets as $wp_widget ) {
+                                $this->selective_refreshable_widgets[ $wp_widget->id_base ] = ! empty( $wp_widget->widget_options['customize_selective_refresh'] );
+                        }
+                }
+                return $this->selective_refreshable_widgets;
+        }
+
+        /**
+         * Determines if a widget supports selective refresh.
+         *
+         * @since 4.5.0
+         * @access public
+         *
+         * @param string $id_base Widget ID Base.
+         * @return bool Whether the widget can be selective refreshed.
+         */
+        public function is_widget_selective_refreshable( $id_base ) {
+                $selective_refreshable_widgets = $this->get_selective_refreshable_widgets();
+                return ! empty( $selective_refreshable_widgets[ $id_base ] );
+        }
+
+        /**
          * Retrieves the widget setting type given a setting ID.
          *
@@ -120 +169 @@
          * @staticvar array $cache
          *
-         * @param $setting_id Setting ID.
+         * @param string $setting_id Setting ID.
          * @return string|void Setting type.
          */
@@ -691 +740 @@
                                 'moveWidgetArea'   => $move_widget_area_tpl,
                         ),
-                        'selectiveRefresh'     => isset( $this->manager->selective_refresh ),
+                        'selectiveRefreshableWidgets' => $this->get_selective_refreshable_widgets(),
                 );
 
@@ -772 +821 @@
                         'type'       => 'option',
                         'capability' => 'edit_theme_options',
-                        'transport'  => isset( $this->manager->selective_refresh ) ? 'postMessage' : 'refresh',
                         'default'    => array(),
                 );
@@ -779 +827 @@
                         $args['sanitize_callback'] = array( $this, 'sanitize_sidebar_widgets' );
                         $args['sanitize_js_callback'] = array( $this, 'sanitize_sidebar_widgets_js_instance' );
+                        $args['transport'] = current_theme_supports( 'customize-selective-refresh-widgets' ) ? 'postMessage' : 'refresh';
                 } elseif ( preg_match( $this->setting_id_patterns['widget_instance'], $id, $matches ) ) {
                         $args['sanitize_callback'] = array( $this, 'sanitize_widget_instance' );
                         $args['sanitize_js_callback'] = array( $this, 'sanitize_widget_js_instance' );
+                        $args['transport'] = $this->is_widget_selective_refreshable( $matches['id_base'] ) ? 'postMessage' : 'refresh';
                 }
 
@@ -894 +944 @@
                                 'is_disabled'  => $is_disabled,
                                 'id_base'      => $id_base,
-                                'transport'    => isset( $this->manager->selective_refresh ) ? 'postMessage' : 'refresh',
+                                'transport'    => $this->is_widget_selective_refreshable( $id_base ) ? 'postMessage' : 'refresh',
                                 'width'        => $wp_registered_widget_controls[$widget['id']]['width'],
                                 'height'       => $wp_registered_widget_controls[$widget['id']]['height'],
@@ -1026 +1076 @@
         public function customize_preview_enqueue() {
                 wp_enqueue_script( 'customize-preview-widgets' );
+                wp_enqueue_style( 'customize-preview' );
         }
 
@@ -1061 +1112 @@
         public function export_preview_data() {
                 global $wp_registered_sidebars, $wp_registered_widgets;
+
                 // Prepare Customizer settings to pass to JavaScript.
                 $settings = array(
@@ -1070 +1122 @@
                                 'widgetTooltip'  => __( 'Shift-click to edit this widget.' ),
                         ),
-                        'selectiveRefresh'   => isset( $this->manager->selective_refresh ),
+                        'selectiveRefreshableWidgets' => $this->get_selective_refreshable_widgets(),
                 );
                 foreach ( $settings['registeredWidgets'] as &$registered_widget ) {
@@ -1480 +1532 @@
          */
         public function customize_dynamic_partial_args( $partial_args, $partial_id ) {
+                if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) {
+                        return $partial_args;
+                }
 
                 if ( preg_match( '/^widget\[(?P<widget_id>.+)\]$/', $partial_id, $matches ) ) {
@@ -1507 +1562 @@
          */
         public function selective_refresh_init() {
-                if ( ! isset( $this->manager->selective_refresh ) ) {
+                if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) {
                         return;
                 }
-
-                add_action( 'wp_enqueue_scripts', array( $this, 'customize_preview_enqueue_deps' ) );
                 add_filter( 'dynamic_sidebar_params', array( $this, 'filter_dynamic_sidebar_params' ) );
                 add_filter( 'wp_kses_allowed_html', array( $this, 'filter_wp_kses_allowed_data_attributes' ) );
                 add_action( 'dynamic_sidebar_before', array( $this, 'start_dynamic_sidebar' ) );
                 add_action( 'dynamic_sidebar_after', array( $this, 'end_dynamic_sidebar' ) );
-        }
-
-        /**
-         * Enqueues scripts for the Customizer preview.
-         *
-         * @since 4.5.0
-         * @access public
-         */
-        public function customize_preview_enqueue_deps() {
-                if ( isset( $this->manager->selective_refresh ) ) {
-                        $script = wp_scripts()->registered['customize-preview-widgets'];
-                        $script->deps[] = 'customize-selective-refresh';
-                }
-
-                wp_enqueue_script( 'customize-preview-widgets' );
-                wp_enqueue_style( 'customize-preview' );
         }