Ticket #32814: 32814.10.diff

src/wp-admin/js/customize-nav-menus.js

@@ -957 +957 @@
                         var control = this;
                         api.Control.prototype.initialize.call( control, id, options );
                         control.active.validate = function() {
-                                return api.section( control.section() ).active();
+                                var value, section = api.section( control.section() );
+                                if ( section ) {
+                                        value = section.active();
+                                } else {
+                                        value = false;
+                                }
+                                return value;
                         };
                 },
 
@@ -1602 +1608 @@
                          * being deactivated.
                          */
                         control.active.validate = function() {
-                                return api.section( control.section() ).active();
+                                var value, section = api.section( control.section() );
+                                if ( section ) {
+                                        value = section.active();
+                                } else {
+                                        value = false;
+                                }
+                                return value;
                         };
 
                         control.nameElement = new api.Element( control.container.find( '.menu-name-field' ) );
@@ -1648 +1660 @@
                          * being deactivated.
                          */
                         control.active.validate = function() {
-                                return api.section( control.section() ).active();
+                                var value, section = api.section( control.section() );
+                                if ( section ) {
+                                        value = section.active();
+                                } else {
+                                        value = false;
+                                }
+                                return value;
                         };
 
                         control.autoAddElement = new api.Element( control.container.find( 'input[type=checkbox].auto_add' ) );
@@ -1691 +1709 @@
                         var control = this,
                                 menuId = control.params.menu_id,
                                 menu = control.setting(),
-                                name;
+                                name,
+                                widgetTemplate,
+                                select;
 
                         if ( 'undefined' === typeof this.params.menu_id ) {
                                 throw new Error( 'params.menu_id was not defined' );
@@ -1703 +1723 @@
                          * being deactivated.
                          */
                         control.active.validate = function() {
-                                return api.section( control.section() ).active();
+                                var value, section = api.section( control.section() );
+                                if ( section ) {
+                                        value = section.active();
+                                } else {
+                                        value = false;
+                                }
+                                return value;
                         };
 
                         control.$controlSection = control.container.closest( '.control-section' );
@@ -1725 +1751 @@
                         if ( menu ) {
                                 name = displayNavMenuName( menu.name );
 
+                                // Add the menu to the existing controls.
                                 api.control.each( function( widgetControl ) {
                                         if ( ! widgetControl.extended( api.controlConstructor.widget_form ) || 'nav_menu' !== widgetControl.params.widget_id_base ) {
                                                 return;
                                         }
-                                        var select = widgetControl.container.find( 'select' );
-                                        if ( select.find( 'option[value=' + String( menuId ) + ']' ).length === 0 ) {
+                                        widgetControl.container.find( '.nav-menu-widget-form-controls:first' ).show();
+                                        widgetControl.container.find( '.nav-menu-widget-no-menus-message:first' ).hide();
+
+                                        select = widgetControl.container.find( 'select' );
+                                        if ( 0 === select.find( 'option[value=' + String( menuId ) + ']' ).length ) {
                                                 select.append( new Option( name, menuId ) );
                                         }
                                 } );
-                                $( '#available-widgets-list .widget-inside:has(input.id_base[value=nav_menu]) select:first' ).append( new Option( name, menuId ) );
+
+                                // Add the menu to the widget template.
+                                widgetTemplate = $( '#available-widgets-list .widget-tpl:has( input.id_base[ value=nav_menu ] )' );
+                                widgetTemplate.find( '.nav-menu-widget-form-controls:first' ).show();
+                                widgetTemplate.find( '.nav-menu-widget-no-menus-message:first' ).hide();
+                                select = widgetTemplate.find( '.widget-inside select:first' );
+                                if ( 0 === select.find( 'option[value=' + String( menuId ) + ']' ).length ) {
+                                        select.append( new Option( name, menuId ) );
+                                }
                         }
                 },
 
@@ -1759 +1797 @@
                                                 var select = widgetControl.container.find( 'select' );
                                                 select.find( 'option[value=' + String( menuId ) + ']' ).text( name );
                                         });
-                                        $( '#available-widgets-list .widget-inside:has(input.id_base[value=nav_menu]) select:first option[value=' + String( menuId ) + ']' ).text( name );
                                 }
                         } );
 
@@ -1831 +1868 @@
                                                 menuItemControl.setting.set( setting );
                                         });
                                 });
-                        });
 
+                        });
                         control.isReordering = false;
 
                         /**
@@ -1869 +1906 @@
                         var control = this,
                                 section,
                                 menuId = control.params.menu_id,
-                                removeSection;
+                                removeSection,
+                                widgetTemplate,
+                                navMenuCount = 0;
                         section = api.section( control.section() );
                         removeSection = function() {
                                 section.container.remove();
@@ -1888 +1927 @@
                                 removeSection();
                         }
 
+                        api.each(function( setting ) {
+                                if ( /^nav_menu\[/.test( setting.id ) && false !== setting() ) {
+                                        navMenuCount += 1;
+                                }
+                        });
+
                         // Remove the menu from any Custom Menu widgets.
                         api.control.each(function( widgetControl ) {
                                 if ( ! widgetControl.extended( api.controlConstructor.widget_form ) || 'nav_menu' !== widgetControl.params.widget_id_base ) {
@@ -1897 +1942 @@
                                 if ( select.val() === String( menuId ) ) {
                                         select.prop( 'selectedIndex', 0 ).trigger( 'change' );
                                 }
-                                select.find( 'option[value=' + String( menuId ) + ']' ).remove();
+
+                                widgetControl.container.find( '.nav-menu-widget-form-controls:first' ).toggle( 0 !== navMenuCount );
+                                widgetControl.container.find( '.nav-menu-widget-no-menus-message:first' ).toggle( 0 === navMenuCount );
+                                widgetControl.container.find( 'option[value=' + String( menuId ) + ']' ).remove();
                         });
-                        $( '#available-widgets-list .widget-inside:has(input.id_base[value=nav_menu]) select:first option[value=' + String( menuId ) + ']' ).remove();
+
+                        // Remove the menu to the nav menu widget template.
+                        widgetTemplate = $( '#available-widgets-list .widget-tpl:has( input.id_base[ value=nav_menu ] )' );
+                        widgetTemplate.find( '.nav-menu-widget-form-controls:first' ).toggle( 0 !== navMenuCount );
+                        widgetTemplate.find( '.nav-menu-widget-no-menus-message:first' ).toggle( 0 === navMenuCount );
+                        widgetTemplate.find( 'option[value=' + String( menuId ) + ']' ).remove();
                 },
 
                 // Setup theme location checkboxes.
@@ -2292 +2345 @@
 
                         // Focus on the new menu section.
                         api.section( customizeId ).focus(); // @todo should we focus on the new menu's control and open the add-items panel? Thinking user flow...
+
+                        // Fix an issue with extra space at top immediately after creating new menu.
+                        $( '#menu-to-edit' ).css( 'margin-top', 0 );
                 }
         });
 
@@ -2431 +2487 @@
                                         }
                                 } );
 
+                                /**
+                                 * Update the saved menu in any custom menu widgets.
+                                 * If the previous_term_id item is selected, reselect the
+                                 * item with the updated term_id.
+                                 */
+                                api.control.each( function( setting ) {
+                                        // Only act on nav_menu widgets.
+                                        if ( ! setting.extended( api.controlConstructor.widget_form ) ||
+                                                'nav_menu' !== setting.params.widget_id_base ) {
+                                                return;
+                                        }
+                                        var select, oldMenuOption, oldMenuSelected, newMenuOption;
+                                        select          = setting.container.find( 'select' );
+                                        oldMenuOption   = select.find( 'option[value=' + String( update.previous_term_id ) + ']' );
+                                        oldMenuSelected = select.find( 'option[value=' + String( update.previous_term_id ) + ']:selected' );
+                                        newMenuOption   = select.find( 'option[value=' + String( update.term_id ) + ']' );
+
+                                        // Adjust menu options matching the old ID, setting them to the new ID.
+                                        if ( oldMenuSelected.length !== 0 && newMenuOption !== 0 ) {
+                                                // Remove the old option.
+                                                oldMenuOption.remove();
+                                                // Select the new option.
+                                                newMenuOption.attr( 'selected', true ).trigger( 'change' );
+                                        }
+
+
+                                } );
+
                                 if ( oldSection.expanded.get() ) {
                                         // @todo This doesn't seem to be working.
                                         newSection.expand();

src/wp-admin/js/customize-widgets.js

@@ -1041 +1041 @@
                         params.wp_customize = 'on';
                         params.nonce = api.Widgets.data.nonce;
                         params.theme = api.settings.theme.stylesheet;
+                        params.customized = wp.customize.previewer.query().customized;
 
                         data = $.param( params );
                         $inputs = this._getInputs( $widgetContent );

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

@@ -1625 +1625 @@
                 $this->_original_value    = $this->value();
                 $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 );
+        }
+
+        /**
          * Filter the wp_get_nav_menu_object() result to supply the previewed menu object.
          *
          * Requesting a nav_menu object by anything but ID is not supported.
@@ -1761 +1851 @@
          * To delete a menu, the client can send false as the value.
          *
          * @since 4.3.0
-         * @access public
+         * @access protected
          *
          * @see wp_update_nav_menu_object()
          *
@@ -1864 +1954 @@
          * Updates a nav_menu_options array.
          *
          * @since 4.3.0
-         * @access public
+         * @access protected
          *
          * @see WP_Customize_Nav_Menu_Setting::filter_nav_menu_options()
          * @see WP_Customize_Nav_Menu_Setting::update()

src/wp-includes/default-widgets.php

@@ -1570 +1570 @@
                 $menus = wp_get_nav_menus();
 
                 // If no menus exists, direct the user to go and create some.
-                if ( !$menus ) {
-                        echo '<p>'. sprintf( __('No menus have been created yet. <a href="%s">Create some</a>.'), admin_url('nav-menus.php') ) .'</p>';
-                        return;
-                }
                 ?>
-                <p>
-                        <label for="<?php echo $this->get_field_id('title'); ?>"><?php _e('Title:') ?></label>
-                        <input type="text" class="widefat" id="<?php echo $this->get_field_id('title'); ?>" name="<?php echo $this->get_field_name('title'); ?>" value="<?php echo $title; ?>" />
-                </p>
-                <p>
-                        <label for="<?php echo $this->get_field_id('nav_menu'); ?>"><?php _e('Select Menu:'); ?></label>
-                        <select id="<?php echo $this->get_field_id('nav_menu'); ?>" name="<?php echo $this->get_field_name('nav_menu'); ?>">
-                                <option value="0"><?php _e( '&mdash; Select &mdash;' ) ?></option>
-                <?php
-                        foreach ( $menus as $menu ) {
-                                echo '<option value="' . $menu->term_id . '"'
-                                        . selected( $nav_menu, $menu->term_id, false )
-                                        . '>'. esc_html( $menu->name ) . '</option>';
+                <p class="nav-menu-widget-no-menus-message" <?php if ( ! empty( $menus ) ) { echo ' style="display:none" '; } ?>>
+                        <?php
+                        if ( 'customize' === get_current_screen()->id ) {
+                                // @todo When expanding a panel, the JS should be smart enough to collapse any existing panels and sections.
+                                $url = 'javascript: wp.customize.section.each(function( section ){ section.collapse(); }); wp.customize.panel( "nav_menus" ).focus();';
+                        } else {
+                                $url = admin_url( 'nav-menus.php' );
                         }
-                ?>
-                        </select>
+                        ?>
+                        <?php echo sprintf( __( 'No menus have been created yet. <a href="%s">Create some</a>.' ), esc_attr( $url ) ); ?>
                 </p>
+                <div class="nav-menu-widget-form-controls" <?php if ( empty( $menus ) ) { echo ' style="display:none" '; } ?>>
+                        <p>
+                                <label for="<?php echo $this->get_field_id( 'title' ); ?>"><?php _e( 'Title:' ) ?></label>
+                                <input type="text" class="widefat" id="<?php echo $this->get_field_id( 'title' ); ?>" name="<?php echo $this->get_field_name( 'title' ); ?>" value="<?php echo esc_attr( $title ); ?>"/>
+                        </p>
+                        <p>
+                                <label for="<?php echo $this->get_field_id( 'nav_menu' ); ?>"><?php _e( 'Select Menu:' ); ?></label>
+                                <select id="<?php echo $this->get_field_id( 'nav_menu' ); ?>" name="<?php echo $this->get_field_name( 'nav_menu' ); ?>">
+                                        <option value="0"><?php _e( '&mdash; Select &mdash;' ); ?></option>
+                                        <?php foreach ( $menus as $menu ) : ?>
+                                                <option value="<?php echo esc_attr( $menu->term_id ); ?>" <?php selected( $nav_menu, $menu->term_id ); ?>>
+                                                        <?php echo esc_html( $menu->name ); ?>
+                                                </option>
+                                        <?php endforeach; ?>
+                                </select>
+                        </p>
+                </div>
                 <?php
         }
 }

src/wp-includes/nav-menu.php

@@ -12 +12 @@
  *
  * @since 3.0.0
  *
- * @param string $menu Menu ID, slug, or name.
+ * @param string $menu Menu ID, slug, or name - or the menu object.
  * @return object|false False if $menu param isn't supplied or term does not exist, menu object if successful.
  */
 function wp_get_nav_menu_object( $menu ) {
         $menu_obj = false;
-        if ( $menu ) {
+
+        if ( is_object( $menu ) ) {
+                $menu_obj = $menu;
+        }
+
+        if ( $menu && ! $menu_obj ) {
                 $menu_obj = get_term( $menu, 'nav_menu' );
 
                 if ( ! $menu_obj ) {

tests/phpunit/tests/customize/nav-menu-setting.php

@@ -211 +211 @@
 
                 $nav_menu_options = get_option( 'nav_menu_options', array( 'auto_add' => array() ) );
                 $this->assertContains( $menu_id, $nav_menu_options['auto_add'] );
+
+                $menus = wp_get_nav_menus();
+                $menus_ids = wp_list_pluck( $menus, 'term_id' );
+                $i = array_search( $menu_id, $menus_ids );
+                $this->assertNotFalse( $i, 'Update-previewed menu does not appear in wp_get_nav_menus()' );
+                $filtered_menu = $menus[ $i ];
+                $this->assertEquals( 'Name 2', $filtered_menu->name );
         }
 
         /**
@@ -249 +256 @@
 
                 $nav_menu_options = $this->get_nav_menu_items_option();
                 $this->assertNotContains( $menu_id, $nav_menu_options['auto_add'] );
+
+                $menus = wp_get_nav_menus();
+                $menus_ids = wp_list_pluck( $menus, 'term_id' );
+                $i = array_search( $menu_id, $menus_ids );
+                $this->assertNotFalse( $i, 'Insert-previewed menu was not injected into wp_get_nav_menus()' );
+                $filtered_menu = $menus[ $i ];
+                $this->assertEquals( 'New Menu Name 1', $filtered_menu->name );
         }
 
         /**