Changeset 36889 for trunk/src/wp-includes/class-wp-customize-nav-menus.php

Timestamp:

03/09/2016 12:08:51 AM (9 years ago)

Author:

westonruter

Message:

Customize: Fix regressions and harden implementation of selective refresh for nav menus.

• Request full refresh if there are nav menu instances that lack partials for a changed setting.
• Restore WP_Customize_Nav_Menus::$preview_nav_menu_instance_args and WP_Customize_Nav_Menus::export_preview_data() from 4.3, and keeping a tally of all wp_nav_menu() calls regardless of whether they can use selective refresh.
• Ensure that all instances of wp_nav_menu() are tallied, regardless of whether they are made during the initial preview call or during subsequent partial renderings. Export nav_menu_instance_args with each partial rendering response just as they are returned when rendering the preview as a whole.
• Fix issues with Custom Menu widget where nav menu items would fail to render when switching between menus when a menu lacked items to begin with.
• Make sure the fallback behavior is invoked when the partial is no longer associated with a menu.
• Do fallback behavior to refresh preview when all menu items are removed from a menu.

Follows [36586].
See #27355.
Fixes #35362.

File:

• trunk/src/wp-includes/class-wp-customize-nav-menus.php (modified) (7 diffs)

trunk/src/wp-includes/class-wp-customize-nav-menus.php

@@ -823 +823 @@
 
     /**
+     * Nav menu args used for each instance, keyed by the args HMAC.
+     *
+     * @since 4.3.0
+     * @access public
+     * @var array
+     */
+    public $preview_nav_menu_instance_args = array();
+
+    /**
      * Filter arguments for dynamic nav_menu selective refresh partials.
      *
@@ -863 +872 @@
         add_filter( 'wp_nav_menu_args', array( $this, 'filter_wp_nav_menu_args' ), 1000 );
         add_filter( 'wp_nav_menu', array( $this, 'filter_wp_nav_menu' ), 10, 2 );
+        add_filter( 'wp_footer', array( $this, 'export_preview_data' ), 1 );
+        add_filter( 'customize_render_partials_response', array( $this, 'export_partial_rendered_nav_menu_instances' ) );
     }
 
@@ -882 +893 @@
          * selective refreshed if...
          */
-        $can_selective_refresh = (
+        $can_partial_refresh = (
             // ...if wp_nav_menu() is directly echoing out the menu (and thus isn't manipulating the string after generated),
             ! empty( $args['echo'] )
@@ -905 +916 @@
             )
         );
-
-        if ( ! $can_selective_refresh ) {
-            return $args;
-        }
+        $args['can_partial_refresh'] = $can_partial_refresh;
 
         $exported_args = $args;
+
+        // Empty out args which may not be JSON-serializable.
+        if ( ! $can_partial_refresh ) {
+            $exported_args['fallback_cb'] = '';
+            $exported_args['walker'] = '';
+        }
 
         /*
@@ -924 +938 @@
 
         $args['customize_preview_nav_menus_args'] = $exported_args;
-
+        $this->preview_nav_menu_instance_args[ $exported_args['args_hmac'] ] = $exported_args;
         return $args;
     }
@@ -943 +957 @@
      */
     public function filter_wp_nav_menu( $nav_menu_content, $args ) {
-        if ( ! empty( $args->customize_preview_nav_menus_args ) ) {
+        if ( isset( $args->customize_preview_nav_menus_args['can_partial_refresh'] ) && $args->customize_preview_nav_menus_args['can_partial_refresh'] ) {
             $attributes = sprintf( ' data-customize-partial-id="%s"', esc_attr( 'nav_menu_instance[' . $args->customize_preview_nav_menus_args['args_hmac'] . ']' ) );
             $attributes .= ' data-customize-partial-type="nav_menu_instance"';
@@ -988 +1002 @@
      *
      * @since 4.3.0
-     * @deprecated 4.5.0 Obsolete
      * @access public
      */
     public function export_preview_data() {
-        _deprecated_function( __METHOD__, '4.5.0' );
+
+        // Why not wp_localize_script? Because we're not localizing, and it forces values into strings.
+        $exports = array(
+            'navMenuInstanceArgs' => $this->preview_nav_menu_instance_args,
+        );
+        printf( '<script>var _wpCustomizePreviewNavMenusExports = %s;</script>', wp_json_encode( $exports ) );
+    }
+
+    /**
+     * Export any wp_nav_menu() calls during the rendering of any partials.
+     *
+     * @since 4.5.0
+     * @access public
+     *
+     * @param array $response Response.
+     * @return array Response.
+     */
+    public function export_partial_rendered_nav_menu_instances( $response ) {
+        $response['nav_menu_instance_args'] = $this->preview_nav_menu_instance_args;
+        return $response;
     }