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.


git-svn-id: https://develop.svn.wordpress.org/trunk@33488 602fd350-edb4-49c9-b593-d223f7449a82

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

@@ -1625,11 +1625,101 @@ class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
 		$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.
 	 *
@@ -1751,6 +1841,17 @@ class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
 		return apply_filters( "customize_sanitize_{$this->id}", $value, $this );
 	}
 
+	/**
+	 * 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.
 	 *
@@ -1761,7 +1862,7 @@ class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
 	 * 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()
 	 *
@@ -1844,8 +1945,8 @@ class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
 			update_option( 'nav_menu_options', $nav_menu_options );
 		}
 
-		// 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 ) ) {
 					continue;
@@ -1857,6 +1958,26 @@ class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
 					$setting->save();
 				}
 			}
+
+			// 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;
+			}
 		}
 	}
 
@@ -1864,7 +1985,7 @@ class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
 	 * 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()
@@ -1905,6 +2026,9 @@ class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
 		if ( ! isset( $data['nav_menu_updates'] ) ) {
 			$data['nav_menu_updates'] = array();
 		}
+		if ( ! isset( $data['widget_nav_menu_updates'] ) ) {
+			$data['widget_nav_menu_updates'] = array();
+		}
 
 		$data['nav_menu_updates'][] = array(
 			'term_id'          => $this->term_id,
@@ -1914,6 +2038,12 @@ class WP_Customize_Nav_Menu_Setting extends WP_Customize_Setting {
 			'saved_value'      => 'deleted' === $this->update_status ? null : $this->value(),
 		);
 
+		$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;
 	}
 }

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

@@ -1241,6 +1241,20 @@ final class WP_Customize_Widgets {
 	public function call_widget_update( $widget_id ) {
 		global $wp_registered_widget_updates, $wp_registered_widget_controls;
 
+		$setting_id = $this->get_setting_id( $widget_id );
+
+		/*
+		 * Make sure that other setting changes have previewed since this widget
+		 * may depend on them (e.g. Menus being present for Custom Menu widget).
+		 */
+		if ( ! did_action( 'customize_preview_init' ) ) {
+			foreach ( $this->manager->settings() as $setting ) {
+				if ( $setting->id !== $setting_id ) {
+					$setting->preview();
+				}
+			}
+		}
+
 		$this->start_capturing_option_updates();
 		$parsed_id   = $this->parse_widget_id( $widget_id );
 		$option_name = 'widget_' . $parsed_id['id_base'];
@@ -1321,7 +1335,6 @@ final class WP_Customize_Widgets {
 		 * in place from WP_Customize_Setting::preview() will use this value
 		 * instead of the default widget instance value (an empty array).
 		 */
-		$setting_id = $this->get_setting_id( $widget_id );
 		$this->manager->set_post_value( $setting_id, $instance );
 
 		// Obtain the widget control with the updated instance in place.

src/wp-includes/default-widgets.php

@@ -1570,28 +1570,35 @@ class WP_Widget_Tag_Cloud extends WP_Widget {
 		$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 ( isset( $GLOBALS['wp_customize'] ) && $GLOBALS['wp_customize'] instanceof WP_Customize_Manager ) {
+				// @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 +12,17 @@
  *
  * @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 ) {