Changeset 33488 for trunk/src/wp-includes/class-wp-customize-setting.php

Timestamp:

07/29/2015 04:02:08 PM (9 years ago)

Author:

westonruter

Message:

Customizer: Ensure that all existing menus are shown in the Custom Menu widget's dropdown.

• Ensure that a Custom Menu widget selecting a newly-inserted menu gets updated to use the new menu ID upon Save & Publish.
• Dynamically update the visibility of the Custom Menu widget's "no menus" message when the number of menus changes between 0 and 1+.
• Send all dirty Customized settings in update-widget Ajax request and preview() them so that the widget update/form callbacks have access to any data dependencies in the current Customizer session (such as newly created unsaved menus).
• Update link in Custom Menu widget to point to Menus panel as opposed to Menus admin page, when in the Customizer.
• Fix an issue with extra space at top immediately after creating new menu.
• Fix doubled update-widget Ajax requests when changing select dropdown; prevent initial from being aborted.
• Add missing wp_get_nav_menus() hooks to preview Customizer updates/inserts for nav_menu settings; includes tests.
• Update wp_get_nav_menu_object() to allow a menu object to be passed in (and thus passed through).

Props westonruter, adamsilverstein.
Fixes #32814.

File:

• trunk/src/wp-includes/class-wp-customize-setting.php (modified) (8 diffs)

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

@@ -1626 +1626 @@
         $this->_previewed_blog_id = get_current_blog_id();
 
+        add_filter( 'wp_get_nav_menus', array( $this, 'filter_wp_get_nav_menus' ), 10, 2 );
         add_filter( 'wp_get_nav_menu_object', array( $this, 'filter_wp_get_nav_menu_object' ), 10, 2 );
         add_filter( 'default_option_nav_menu_options', array( $this, 'filter_nav_menu_options' ) );
         add_filter( 'option_nav_menu_options', array( $this, 'filter_nav_menu_options' ) );
+    }
+
+    /**
+     * Filter the wp_get_nav_menus() result to ensure the inserted menu object is included, and the deleted one is removed.
+     *
+     * @since 4.3.0
+     * @access public
+     *
+     * @see wp_get_nav_menus()
+     *
+     * @param array $menus An array of menu objects.
+     * @param array $args  An array of arguments used to retrieve menu objects.
+     * @return array
+     */
+    public function filter_wp_get_nav_menus( $menus, $args ) {
+        if ( get_current_blog_id() !== $this->_previewed_blog_id ) {
+            return $menus;
+        }
+
+        $setting_value = $this->value();
+        $is_delete = ( false === $setting_value );
+        $index = -1;
+
+        // Find the existing menu item's position in the list.
+        foreach ( $menus as $i => $menu ) {
+            if ( (int) $this->term_id === (int) $menu->term_id || (int) $this->previous_term_id === (int) $menu->term_id ) {
+                $index = $i;
+                break;
+            }
+        }
+
+        if ( $is_delete ) {
+            // Handle deleted menu by removing it from the list.
+            if ( -1 !== $index ) {
+                array_splice( $menus, $index, 1 );
+            }
+        } else {
+            // Handle menus being updated or inserted.
+            $menu_obj = (object) array_merge( array(
+                'term_id'          => $this->term_id,
+                'term_taxonomy_id' => $this->term_id,
+                'slug'             => sanitize_title( $setting_value['name'] ),
+                'count'            => 0,
+                'term_group'       => 0,
+                'taxonomy'         => self::TAXONOMY,
+                'filter'           => 'raw',
+            ), $setting_value );
+
+            array_splice( $menus, $index, ( -1 === $index ? 0 : 1 ), array( $menu_obj ) );
+        }
+
+        // Make sure the menu objects get re-sorted after an update/insert.
+        if ( ! $is_delete && ! empty( $args['orderby'] ) ) {
+            $this->_current_menus_sort_orderby = $args['orderby'];
+            usort( $menus, array( $this, '_sort_menus_by_orderby' ) );
+        }
+        // @todo add support for $args['hide_empty'] === true
+
+        return $menus;
+    }
+
+    /**
+     * Temporary non-closure passing of orderby value to function.
+     *
+     * @since 4.3.0
+     * @access protected
+     * @var string
+     *
+     * @see WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menus()
+     * @see WP_Customize_Nav_Menu_Setting::_sort_menus_by_orderby()
+     */
+    protected $_current_menus_sort_orderby;
+
+    /**
+     * Sort menu objects by the class-supplied orderby property.
+     *
+     * This is a workaround for a lack of closures.
+     *
+     * @since 4.3.0
+     * @access protected
+     * @param object $menu1
+     * @param object $menu2
+     * @return int
+     *
+     * @see WP_Customize_Nav_Menu_Setting::filter_wp_get_nav_menus()
+     */
+    protected function _sort_menus_by_orderby( $menu1, $menu2 ) {
+        $key = $this->_current_menus_sort_orderby;
+        return strcmp( $menu1->$key, $menu2->$key );
     }
 
@@ -1753 +1843 @@
 
     /**
+     * Storage for data to be sent back to client in customize_save_response filter.
+     *
+     * @access protected
+     * @since 4.3.0
+     * @var array
+     *
+     * @see WP_Customize_Nav_Menu_Setting::amend_customize_save_response()
+     */
+    protected $_widget_nav_menu_updates = array();
+
+    /**
      * Create/update the nav_menu term for this setting.
      *
@@ -1762 +1863 @@
      *
      * @since 4.3.0
-     * @access public
+     * @access protected
      *
      * @see wp_update_nav_menu_object()
@@ -1845 +1946 @@
         }
 
-        // Make sure that new menus assigned to nav menu locations use their new IDs.
         if ( 'inserted' === $this->update_status ) {
+            // Make sure that new menus assigned to nav menu locations use their new IDs.
             foreach ( $this->manager->settings() as $setting ) {
                 if ( ! preg_match( '/^nav_menu_locations\[/', $setting->id ) ) {
@@ -1858 +1959 @@
                 }
             }
+
+            // Make sure that any nav_menu widgets referencing the placeholder nav menu get updated and sent back to client.
+            foreach ( array_keys( $this->manager->unsanitized_post_values() ) as $setting_id ) {
+                $nav_menu_widget_setting = $this->manager->get_setting( $setting_id );
+                if ( ! $nav_menu_widget_setting || ! preg_match( '/^widget_nav_menu\[/', $nav_menu_widget_setting->id ) ) {
+                    continue;
+                }
+
+                $widget_instance = $nav_menu_widget_setting->post_value(); // Note that this calls WP_Customize_Widgets::sanitize_widget_instance().
+                if ( empty( $widget_instance['nav_menu'] ) || intval( $widget_instance['nav_menu'] ) !== $this->previous_term_id ) {
+                    continue;
+                }
+
+                $widget_instance['nav_menu'] = $this->term_id;
+                $updated_widget_instance = $this->manager->widgets->sanitize_widget_js_instance( $widget_instance );
+                $this->manager->set_post_value( $nav_menu_widget_setting->id, $updated_widget_instance );
+                $nav_menu_widget_setting->save();
+
+                $this->_widget_nav_menu_updates[ $nav_menu_widget_setting->id ] = $updated_widget_instance;
+            }
         }
     }
@@ -1865 +1986 @@
      *
      * @since 4.3.0
-     * @access public
+     * @access protected
      *
      * @see WP_Customize_Nav_Menu_Setting::filter_nav_menu_options()
@@ -1905 +2026 @@
         if ( ! isset( $data['nav_menu_updates'] ) ) {
             $data['nav_menu_updates'] = array();
+        }
+        if ( ! isset( $data['widget_nav_menu_updates'] ) ) {
+            $data['widget_nav_menu_updates'] = array();
         }
 
@@ -1915 +2039 @@
         );
 
+        $data['widget_nav_menu_updates'] = array_merge(
+            $data['widget_nav_menu_updates'],
+            $this->_widget_nav_menu_updates
+        );
+        $this->_widget_nav_menu_updates = array();
+
         return $data;
     }