Changeset 34563 for trunk/src/wp-includes/class-wp-customize-control.php

Timestamp:

09/25/2015 09:01:46 PM (6 years ago)

Author:

westonruter

Message:

Customizer: Defer embedding widget controls to improve DOM performance and initial load time.

The Menu Customizer feature includes a performance technique whereby the controls for nav menu items are only embedded into the DOM once the containing menu section is expanded. This commit implements the same DOM deferral for widgets but goes a step further than just embedding the controls once the widget area's Customizer section is expanded: it also defers the embedding of the widget control's form until the widget is expanded, at which point the widget-added event also fires to allow any additional widget initialization to be done. The deferred DOM embedding can speed up initial load time by 10x or more. This DOM deferral also yields a reduction in overall memory usage in the browser process.

Includes changes to wp_widget_control() to facilitate separating out the widget form from the surrounding accordion container; also includes unit tests for this previously-untested function. Also included are initial QUnit tests (finally) for widgets in the Customizer.

Fixes #33901.

File:

• trunk/src/wp-includes/class-wp-customize-control.php (modified) (3 diffs)

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

@@ -1488 +1488 @@
     public $is_wide = false;
 
+    /**
+     * Gather control params for exporting to JavaScript.
+     *
+     * @global array $wp_registered_widgets
+     */
     public function to_json() {
+        global $wp_registered_widgets;
+
         parent::to_json();
         $exported_properties = array( 'widget_id', 'widget_id_base', 'sidebar_id', 'width', 'height', 'is_wide' );
@@ -1494 +1501 @@
             $this->json[ $key ] = $this->$key;
         }
-    }
-
-    /**
-     *
-     * @global array $wp_registered_widgets
-     */
-    public function render_content() {
-        global $wp_registered_widgets;
+
+        // Get the widget_control and widget_content.
         require_once ABSPATH . '/wp-admin/includes/widgets.php';
 
@@ -1515 +1516 @@
 
         $args = wp_list_widget_controls_dynamic_sidebar( array( 0 => $args, 1 => $widget['params'][0] ) );
-        echo $this->manager->widgets->get_widget_control( $args );
-    }
+        $widget_control_parts = $this->manager->widgets->get_widget_control_parts( $args );
+
+        $this->json['widget_control'] = $widget_control_parts['control'];
+        $this->json['widget_content'] = $widget_control_parts['content'];
+    }
+
+    /**
+     * Override render_content to be no-op since content is exported via to_json for deferred embedding.
+     */
+    public function render_content() {}
 
     /**