enmi-conf.org: comparison wp/wp-includes/nav-menu.php

equal deleted inserted replaced

-:490d5cc509ed
+:cf61fcea0001
 /**
 * Returns a navigation menu object.
 *
 * @since 3.0.0
 *
-* @param string $menu Menu ID, slug, or name.
+* @param int|string|WP_Term $menu Menu ID, slug, name, or object.
-* @return mixed false if $menu param isn't supplied or term does not exist, menu object if successful.
+* @return WP_Term|false False if $menu param isn't supplied or term does not exist, menu object if successful.
 */
 function wp_get_nav_menu_object( $menu ) {
-	if ( ! $menu )
+	$menu_obj = false;
-		return false;
+	if ( is_object( $menu ) ) {
-	$menu_obj = get_term( $menu, 'nav_menu' );
+		$menu_obj = $menu;
+	}
-	if ( ! $menu_obj )
-		$menu_obj = get_term_by( 'slug', $menu, 'nav_menu' );
+	if ( $menu && ! $menu_obj ) {
+		$menu_obj = get_term( $menu, 'nav_menu' );
-	if ( ! $menu_obj )
-		$menu_obj = get_term_by( 'name', $menu, 'nav_menu' );
+		if ( ! $menu_obj ) {
+			$menu_obj = get_term_by( 'slug', $menu, 'nav_menu' );
-	if ( ! $menu_obj )
+		}
+		if ( ! $menu_obj ) {
+			$menu_obj = get_term_by( 'name', $menu, 'nav_menu' );
+		}
+	}
+	if ( ! $menu_obj || is_wp_error( $menu_obj ) ) {
 		$menu_obj = false;
+	}
-	return $menu_obj;
+	/**
+	 * Filters the nav_menu term retrieved for wp_get_nav_menu_object().
+	 *
+	 * @since 4.3.0
+	 *
+	 * @param WP_Term|false      $menu_obj Term from nav_menu taxonomy, or false if nothing had been found.
+	 * @param int|string|WP_Term $menu     The menu ID, slug, name, or object passed to wp_get_nav_menu_object().
+	 */
+	return apply_filters( 'wp_get_nav_menu_object', $menu_obj, $menu );
 }
 /**
 * Check if the given ID is a navigation menu.
 *
 * Returns true if it is; false otherwise.
 *
 * @since 3.0.0
 *
-* @param int|string $menu The menu to check (ID, slug, or name).
+* @param int|string|WP_Term $menu Menu ID, slug, name, or object of menu to check.
 * @return bool Whether the menu exists.
 */
 function is_nav_menu( $menu ) {
 	if ( ! $menu )
 		return false;
 	return false;
 }
 /**
-* Register navigation menus for a theme.
+* Registers navigation menu locations for a theme.
 *
 * @since 3.0.0
+*
+* @global array $_wp_registered_nav_menus
 *
 * @param array $locations Associative array of menu location identifiers (like a slug) and descriptive text.
 */
 function register_nav_menus( $locations = array() ) {
 	global $_wp_registered_nav_menus;
 	$_wp_registered_nav_menus = array_merge( (array) $_wp_registered_nav_menus, $locations );
 }
 /**
-* Unregisters a navigation menu for a theme.
+* Unregisters a navigation menu location for a theme.
+*
+* @since 3.1.0
+* @global array $_wp_registered_nav_menus
 *
 * @param string $location The menu location identifier.
 * @return bool True on success, false on failure.
 */
 function unregister_nav_menu( $location ) {
 	}
 	return false;
 }
 /**
-* Register a navigation menu for a theme.
+* Registers a navigation menu location for a theme.
 *
 * @since 3.0.0
 *
-* @param string $location Menu location identifier, like a slug.
+* @param string $location    Menu location identifier, like a slug.
 * @param string $description Menu location descriptive text.
 */
 function register_nav_menu( $location, $description ) {
 	register_nav_menus( array( $location => $description ) );
 }
 /**
-* Returns an array of all registered navigation menus in a theme
+* Retrieves all registered navigation menu locations in a theme.
 *
 * @since 3.0.0
-* @return array
+*
+* @global array $_wp_registered_nav_menus
+*
+* @return array Registered navigation menu locations. If none are registered, an empty array.
 */
 function get_registered_nav_menus() {
 	global $_wp_registered_nav_menus;
 	if ( isset( $_wp_registered_nav_menus ) )
 		return $_wp_registered_nav_menus;
 	return array();
 }
 /**
-* Returns an array with the registered navigation menu locations and the menu assigned to it
+* Retrieves all registered navigation menu locations and the menus assigned to them.
 *
 * @since 3.0.0
-* @return array
+*
+* @return array Registered navigation menu locations and the menus assigned them.
+*               If none are registered, an empty array.
 */
 function get_nav_menu_locations() {
 	$locations = get_theme_mod( 'nav_menu_locations' );
 	return ( is_array( $locations ) ) ? $locations : array();
 }
 /**
-* Whether a registered nav menu location has a menu assigned to it.
+* Determines whether a registered nav menu location has a menu assigned to it.
 *
 * @since 3.0.0
+*
 * @param string $location Menu location identifier.
 * @return bool Whether location has a menu.
 */
 function has_nav_menu( $location ) {
+	$has_nav_menu = false;
 	$registered_nav_menus = get_registered_nav_menus();
-	if ( ! isset( $registered_nav_menus[ $location ] ) ) {
+	if ( isset( $registered_nav_menus[ $location ] ) ) {
-		return false;
+		$locations = get_nav_menu_locations();
-	}
+		$has_nav_menu = ! empty( $locations[ $location ] );
+	}
+	/**
+	 * Filters whether a nav menu is assigned to the specified location.
+	 *
+	 * @since 4.3.0
+	 *
+	 * @param bool   $has_nav_menu Whether there is a menu assigned to a location.
+	 * @param string $location     Menu location.
+	 */
+	return apply_filters( 'has_nav_menu', $has_nav_menu, $location );
+}
+/**
+* Returns the name of a navigation menu.
+*
+* @since 4.9.0
+*
+* @param string $location Menu location identifier.
+* @return string Menu name.
+*/
+function wp_get_nav_menu_name( $location ) {
+	$menu_name = '';
 	$locations = get_nav_menu_locations();
-	return ( ! empty( $locations[ $location ] ) );
-}
+	if ( isset( $locations[ $location ] ) ) {
+		$menu = wp_get_nav_menu_object( $locations[ $location ] );
-/**
-* Determine whether the given ID is a nav menu item.
+		if ( $menu && $menu->name ) {
+			$menu_name = $menu->name;
+		}
+	}
+	/**
+	 * Filters the navigation menu name being returned.
+	 *
+	 * @since 4.9.0
+	 *
+	 * @param string $menu_name Menu name.
+	 * @param string $location  Menu location identifier.
+	 */
+	return apply_filters( 'wp_get_nav_menu_name', $menu_name, $location );
+}
+/**
+* Determines whether the given ID is a nav menu item.
 *
 * @since 3.0.0
 *
 * @param int $menu_item_id The ID of the potential nav menu item.
 * @return bool Whether the given ID is that of a nav menu item.
 function is_nav_menu_item( $menu_item_id = 0 ) {
 	return ( ! is_wp_error( $menu_item_id ) && ( 'nav_menu_item' == get_post_type( $menu_item_id ) ) );
 }
 /**
-* Create a Navigation Menu.
+* Creates a navigation menu.
+*
+* Note that `$menu_name` is expected to be pre-slashed.
 *
 * @since 3.0.0
 *
 * @param string $menu_name Menu name.
 * @return int|WP_Error Menu ID on success, WP_Error object on failure.
 */
 function wp_create_nav_menu( $menu_name ) {
+	// expected_slashed ($menu_name)
 	return wp_update_nav_menu_object( 0, array( 'menu-name' => $menu_name ) );
 }
 /**
 * Delete a Navigation Menu.
 *
 * @since 3.0.0
 *
-* @param string $menu Menu ID, slug, or name.
+* @param int|string|WP_Term $menu Menu ID, slug, name, or object.
 * @return bool|WP_Error True on success, false or WP_Error object on failure.
 */
 function wp_delete_nav_menu( $menu ) {
 	$menu = wp_get_nav_menu_object( $menu );
 	if ( ! $menu )
 }
 /**
 * Save the properties of a menu or create a new menu with those properties.
 *
-* @since 3.0.0
+* Note that `$menu_data` is expected to be pre-slashed.
 *
-* @param int $menu_id The ID of the menu or "0" to create a new menu.
+* @since 3.0.0
+*
+* @param int   $menu_id   The ID of the menu or "0" to create a new menu.
 * @param array $menu_data The array of menu data.
 * @return int|WP_Error Menu ID on success, WP_Error object on failure.
 */
 function wp_update_nav_menu_object( $menu_id = 0, $menu_data = array() ) {
+	// expected_slashed ($menu_data)
 	$menu_id = (int) $menu_id;
 	$_menu = wp_get_nav_menu_object( $menu_id );
 	$args = array(
 	if (
 		$_possible_existing &&
 		! is_wp_error( $_possible_existing ) &&
 		isset( $_possible_existing->term_id ) &&
 		$_possible_existing->term_id != $menu_id
-	)
+	) {
-		return new WP_Error( 'menu_exists', sprintf( __('The menu name <strong>%s</strong> conflicts with another menu name. Please try another.'), esc_html( $menu_data['menu-name'] ) ) );
+		return new WP_Error( 'menu_exists',
+			/* translators: %s: menu name */
+			sprintf( __( 'The menu name %s conflicts with another menu name. Please try another.' ),
+				'<strong>' . esc_html( $menu_data['menu-name'] ) . '</strong>'
+			)
+		);
+	}
 	// menu doesn't already exist, so create a new menu
 	if ( ! $_menu || is_wp_error( $_menu ) ) {
 		$menu_exists = get_term_by( 'name', $menu_data['menu-name'], 'nav_menu' );
-		if ( $menu_exists )
+		if ( $menu_exists ) {
-			return new WP_Error( 'menu_exists', sprintf( __('The menu name <strong>%s</strong> conflicts with another menu name. Please try another.'), esc_html( $menu_data['menu-name'] ) ) );
+			return new WP_Error( 'menu_exists',
+				/* translators: %s: menu name */
+				sprintf( __( 'The menu name %s conflicts with another menu name. Please try another.' ),
+					'<strong>' . esc_html( $menu_data['menu-name'] ) . '</strong>'
+				)
+			);
+		}
 		$_menu = wp_insert_term( $menu_data['menu-name'], 'nav_menu', $args );
 		if ( is_wp_error( $_menu ) )
 			return $_menu;
 	$update_response = wp_update_term( $menu_id, 'nav_menu', $args );
 	if ( is_wp_error( $update_response ) )
 		return $update_response;
+	$menu_id = (int) $update_response['term_id'];
 	/**
 	 * Fires after a navigation menu has been successfully updated.
 	 *
 	 * @since 3.0.0
 	 *
 }
 /**
 * Save the properties of a menu item or create a new one.
 *
-* @since 3.0.0
+* The menu-item-title, menu-item-description, and menu-item-attr-title are expected
-*
+* to be pre-slashed since they are passed directly into `wp_insert_post()`.
-* @param int $menu_id The ID of the menu. Required. If "0", makes the menu item a draft orphan.
+*
-* @param int $menu_item_db_id The ID of the menu item. If "0", creates a new menu item.
+* @since 3.0.0
-* @param array $menu_item_data The menu item's data.
+*
+* @param int   $menu_id         The ID of the menu. Required. If "0", makes the menu item a draft orphan.
+* @param int   $menu_item_db_id The ID of the menu item. If "0", creates a new menu item.
+* @param array $menu_item_data  The menu item's data.
 * @return int|WP_Error The menu item's database ID or WP_Error object on failure.
 */
 function wp_update_nav_menu_item( $menu_id = 0, $menu_item_db_id = 0, $menu_item_data = array() ) {
 	$menu_id = (int) $menu_id;
 	$menu_item_db_id = (int) $menu_item_db_id;
 		} elseif ( 'post_type' == $args['menu-item-type'] ) {
 			$original_object = get_post( $args['menu-item-object-id'] );
 			$original_parent = (int) $original_object->post_parent;
 			$original_title = $original_object->post_title;
+		} elseif ( 'post_type_archive' == $args['menu-item-type'] ) {
+			$original_object = get_post_type_object( $args['menu-item-object'] );
+			if ( $original_object ) {
+				$original_title = $original_object->labels->archives;
+			}
 		}
 		if ( $args['menu-item-title'] == $original_title )
 			$args['menu-item-title'] = '';
 		$post['ID'] = 0;
 		$post['post_status'] = 'publish' == $args['menu-item-status'] ? 'publish' : 'draft';
 		$menu_item_db_id = wp_insert_post( $post );
 		if ( ! $menu_item_db_id	|| is_wp_error( $menu_item_db_id ) )
 			return $menu_item_db_id;
+		/**
+		 * Fires immediately after a new navigation menu item has been added.
+		 *
+		 * @since 4.4.0
+		 *
+		 * @see wp_update_nav_menu_item()
+		 *
+		 * @param int   $menu_id         ID of the updated menu.
+		 * @param int   $menu_item_db_id ID of the new menu item.
+		 * @param array $args            An array of arguments used to update/add the menu item.
+		 */
+		do_action( 'wp_add_nav_menu_item', $menu_id, $menu_item_db_id, $args );
 	}
 	// Associate the menu item with the menu term
 	// Only set the menu term if it isn't set to avoid unnecessary wp_get_object_terms()
 	 if ( $menu_id && ( ! $update || ! is_object_in_term( $menu_item_db_id, 'nav_menu', (int) $menu->term_id ) ) ) {
 *
 * @since 3.0.0
 * @since 4.1.0 Default value of the 'orderby' argument was changed from 'none'
 *              to 'name'.
 *
-* @param array $args Optional. Array of arguments passed on to {@see get_terms()}.
+* @param array $args Optional. Array of arguments passed on to get_terms().
 *                    Default empty array.
 * @return array Menu objects.
 */
 function wp_get_nav_menus( $args = array() ) {
 	$defaults = array( 'hide_empty' => false, 'orderby' => 'name' );
 	$args = wp_parse_args( $args, $defaults );
 	/**
-	 * Filter the navigation menu objects being returned.
+	 * Filters the navigation menu objects being returned.
 	 *
 	 * @since 3.0.0
 	 *
 	 * @see get_terms()
 	 *
 	 */
 	return apply_filters( 'wp_get_nav_menus', get_terms( 'nav_menu',  $args), $args );
 }
 /**
-* Sort menu items by the desired key.
-*
-* @since 3.0.0
-* @access private
-*
-* @param object $a The first object to compare
-* @param object $b The second object to compare
-* @return int -1, 0, or 1 if $a is considered to be respectively less than, equal to, or greater than $b.
-*/
-function _sort_nav_menu_items( $a, $b ) {
-	global $_menu_item_sort_prop;
-	if ( empty( $_menu_item_sort_prop ) )
-		return 0;
-	if ( ! isset( $a->$_menu_item_sort_prop ) || ! isset( $b->$_menu_item_sort_prop ) )
-		return 0;
-	$_a = (int) $a->$_menu_item_sort_prop;
-	$_b = (int) $b->$_menu_item_sort_prop;
-	if ( $a->$_menu_item_sort_prop == $b->$_menu_item_sort_prop )
-		return 0;
-	elseif ( $_a == $a->$_menu_item_sort_prop && $_b == $b->$_menu_item_sort_prop )
-		return $_a < $_b ? -1 : 1;
-	else
-		return strcmp( $a->$_menu_item_sort_prop, $b->$_menu_item_sort_prop );
-}
-/**
 * Return if a menu item is valid.
 *
 * @link https://core.trac.wordpress.org/ticket/13958
 *
 * @since 3.2.0
 *
 * @param object $item The menu item to check.
 * @return bool False if invalid, otherwise true.
 */
 function _is_valid_nav_menu_item( $item ) {
-	if ( ! empty( $item->_invalid ) )
+	return empty( $item->_invalid );
-		return false;
+}
-	return true;
+/**
-}
+* Retrieves all menu items of a navigation menu.
+*
-/**
+* Note: Most arguments passed to the `$args` parameter – save for 'output_key' – are
-* Return all menu items of a navigation menu.
+* specifically for retrieving nav_menu_item posts from get_posts() and may only
-*
+* indirectly affect the ultimate ordering and content of the resulting nav menu
-* @since 3.0.0
+* items that get returned from this function.
 *
-* @param string $menu Menu name, ID, or slug.
+* @since 3.0.0
-* @param array  $args Optional. Arguments to pass to {@see get_posts()}.
+*
-* @return mixed $items Array of menu items, otherwise false.
+* @global string $_menu_item_sort_prop
+* @staticvar array $fetched
+*
+* @param int|string|WP_Term $menu Menu ID, slug, name, or object.
+* @param array              $args {
+*     Optional. Arguments to pass to get_posts().
+*
+*     @type string $order       How to order nav menu items as queried with get_posts(). Will be ignored
+*                               if 'output' is ARRAY_A. Default 'ASC'.
+*     @type string $orderby     Field to order menu items by as retrieved from get_posts(). Supply an orderby
+*                               field via 'output_key' to affect the output order of nav menu items.
+*                               Default 'menu_order'.
+*     @type string $post_type   Menu items post type. Default 'nav_menu_item'.
+*     @type string $post_status Menu items post status. Default 'publish'.
+*     @type string $output      How to order outputted menu items. Default ARRAY_A.
+*     @type string $output_key  Key to use for ordering the actual menu items that get returned. Note that
+*                               that is not a get_posts() argument and will only affect output of menu items
+*                               processed in this function. Default 'menu_order'.
+*     @type bool   $nopaging    Whether to retrieve all menu items (true) or paginate (false). Default true.
+* }
+* @return false|array $items Array of menu items, otherwise false.
 */
 function wp_get_nav_menu_items( $menu, $args = array() ) {
 	$menu = wp_get_nav_menu_object( $menu );
-	if ( ! $menu )
+	if ( ! $menu ) {
 		return false;
+	}
 	static $fetched = array();
 	$items = get_objects_in_term( $menu->term_id, 'nav_menu' );
+	if ( is_wp_error( $items ) ) {
-	if ( empty( $items ) )
+		return false;
-		return $items;
+	}
 	$defaults = array( 'order' => 'ASC', 'orderby' => 'menu_order', 'post_type' => 'nav_menu_item',
 		'post_status' => 'publish', 'output' => ARRAY_A, 'output_key' => 'menu_order', 'nopaging' => true );
 	$args = wp_parse_args( $args, $defaults );
 	$args['include'] = $items;
-	$items = get_posts( $args );
+	if ( ! empty( $items ) ) {
+		$items = get_posts( $args );
-	if ( is_wp_error( $items ) || ! is_array( $items ) )
+	} else {
-		return false;
+		$items = array();
+	}
 	// Get all posts and terms at once to prime the caches
-	if ( empty( $fetched[$menu->term_id] ) || wp_using_ext_object_cache() ) {
+	if ( empty( $fetched[ $menu->term_id ] ) && ! wp_using_ext_object_cache() ) {
 		$fetched[$menu->term_id] = true;
 		$posts = array();
 		$terms = array();
 		foreach ( $items as $item ) {
 			$object_id = get_post_meta( $item->ID, '_menu_item_object_id', true );
 		}
 		unset($posts);
 		if ( ! empty( $terms ) ) {
 			foreach ( array_keys($terms) as $taxonomy ) {
-				get_terms($taxonomy, array('include' => $terms[$taxonomy]) );
+				get_terms( $taxonomy, array(
+					'include' => $terms[ $taxonomy ],
+					'hierarchical' => false,
+				) );
 			}
 		}
 		unset($terms);
 	}
 	$items = array_map( 'wp_setup_nav_menu_item', $items );
-	if ( ! is_admin() ) // Remove invalid items only in frontend
+	if ( ! is_admin() ) { // Remove invalid items only in front end
 		$items = array_filter( $items, '_is_valid_nav_menu_item' );
+	}
 	if ( ARRAY_A == $args['output'] ) {
-		$GLOBALS['_menu_item_sort_prop'] = $args['output_key'];
+		$items = wp_list_sort( $items, array(
-		usort($items, '_sort_nav_menu_items');
+			$args['output_key'] => 'ASC',
+		) );
 		$i = 1;
-		foreach( $items as $k => $item ) {
+		foreach ( $items as $k => $item ) {
-			$items[$k]->$args['output_key'] = $i++;
+			$items[$k]->{$args['output_key']} = $i++;
 		}
 	}
 	/**
-	 * Filter the navigation menu items being returned.
+	 * Filters the navigation menu items being returned.
 	 *
 	 * @since 3.0.0
 	 *
 	 * @param array  $items An array of menu item post objects.
 	 * @param object $menu  The menu object.
 	 * @param array  $args  An array of arguments used to retrieve menu item objects.
 	 */
-	return apply_filters( 'wp_get_nav_menu_items',  $items, $menu, $args );
+	return apply_filters( 'wp_get_nav_menu_items', $items, $menu, $args );
 }
 /**
 * Decorates a menu item object with the shared navigation menu item properties.
 *
 * Properties:
-* - db_id: 		The DB ID of this item as a nav_menu_item object, if it exists (0 if it doesn't exist).
+* - ID:               The term_id if the menu item represents a taxonomy term.
-* - object_id:		The DB ID of the original object this menu item represents, e.g. ID for posts and term_id for categories.
+* - attr_title:       The title attribute of the link element for this menu item.
-* - type:		The family of objects originally represented, such as "post_type" or "taxonomy."
+* - classes:          The array of class attribute values for the link element of this menu item.
-* - object:		The type of object originally represented, such as "category," "post", or "attachment."
+* - db_id:            The DB ID of this item as a nav_menu_item object, if it exists (0 if it doesn't exist).
-* - type_label:	The singular label used to describe this type of menu item.
+* - description:      The description of this menu item.
-* - post_parent:	The DB ID of the original object's parent object, if any (0 otherwise).
+* - menu_item_parent: The DB ID of the nav_menu_item that is this item's menu parent, if any. 0 otherwise.
-* - menu_item_parent: 	The DB ID of the nav_menu_item that is this item's menu parent, if any. 0 otherwise.
+* - object:           The type of object originally represented, such as "category," "post", or "attachment."
-* - url:		The URL to which this menu item points.
+* - object_id:        The DB ID of the original object this menu item represents, e.g. ID for posts and term_id for categories.
-* - title:		The title of this menu item.
+* - post_parent:      The DB ID of the original object's parent object, if any (0 otherwise).
-* - target: 		The target attribute of the link element for this menu item.
+* - post_title:       A "no title" label if menu item represents a post that lacks a title.
-* - attr_title:	The title attribute of the link element for this menu item.
+* - target:           The target attribute of the link element for this menu item.
-* - classes:		The array of class attribute values for the link element of this menu item.
+* - title:            The title of this menu item.
-* - xfn:		The XFN relationship expressed in the link of this menu item.
+* - type:             The family of objects originally represented, such as "post_type" or "taxonomy."
-* - description:	The description of this menu item.
+* - type_label:       The singular label used to describe this type of menu item.
+* - url:              The URL to which this menu item points.
+* - xfn:              The XFN relationship expressed in the link of this menu item.
+* - _invalid:         Whether the menu item represents an object that no longer exists.
 *
 * @since 3.0.0
 *
 * @param object $menu_item The menu item to modify.
 * @return object $menu_item The menu item with standard menu item properties.
 */
 function wp_setup_nav_menu_item( $menu_item ) {
 	if ( isset( $menu_item->post_type ) ) {
 		if ( 'nav_menu_item' == $menu_item->post_type ) {
 			$menu_item->db_id = (int) $menu_item->ID;
-			$menu_item->menu_item_parent = empty( $menu_item->menu_item_parent ) ? get_post_meta( $menu_item->ID, '_menu_item_menu_item_parent', true ) : $menu_item->menu_item_parent;
+			$menu_item->menu_item_parent = ! isset( $menu_item->menu_item_parent ) ? get_post_meta( $menu_item->ID, '_menu_item_menu_item_parent', true ) : $menu_item->menu_item_parent;
-			$menu_item->object_id = empty( $menu_item->object_id ) ? get_post_meta( $menu_item->ID, '_menu_item_object_id', true ) : $menu_item->object_id;
+			$menu_item->object_id = ! isset( $menu_item->object_id ) ? get_post_meta( $menu_item->ID, '_menu_item_object_id', true ) : $menu_item->object_id;
-			$menu_item->object = empty( $menu_item->object ) ? get_post_meta( $menu_item->ID, '_menu_item_object', true ) : $menu_item->object;
+			$menu_item->object = ! isset( $menu_item->object ) ? get_post_meta( $menu_item->ID, '_menu_item_object', true ) : $menu_item->object;
-			$menu_item->type = empty( $menu_item->type ) ? get_post_meta( $menu_item->ID, '_menu_item_type', true ) : $menu_item->type;
+			$menu_item->type = ! isset( $menu_item->type ) ? get_post_meta( $menu_item->ID, '_menu_item_type', true ) : $menu_item->type;
 			if ( 'post_type' == $menu_item->type ) {
 				$object = get_post_type_object( $menu_item->object );
 				if ( $object ) {
 					$menu_item->type_label = $object->labels->singular_name;
 				} else {
 					$menu_item->type_label = $menu_item->object;
 					$menu_item->_invalid = true;
 				}
+				if ( 'trash' === get_post_status( $menu_item->object_id ) ) {
+					$menu_item->_invalid = true;
+				}
 				$menu_item->url = get_permalink( $menu_item->object_id );
 				$original_object = get_post( $menu_item->object_id );
-				$original_title = $original_object->post_title;
+				/** This filter is documented in wp-includes/post-template.php */
+				$original_title = apply_filters( 'the_title', $original_object->post_title, $original_object->ID );
 				if ( '' === $original_title ) {
+					/* translators: %d: ID of a post */
 					$original_title = sprintf( __( '#%d (no title)' ), $original_object->ID );
 				}
 				$menu_item->title = '' == $menu_item->post_title ? $original_title : $menu_item->post_title;
+			} elseif ( 'post_type_archive' == $menu_item->type ) {
+				$object =  get_post_type_object( $menu_item->object );
+				if ( $object ) {
+					$menu_item->title = '' == $menu_item->post_title ? $object->labels->archives : $menu_item->post_title;
+					$post_type_description = $object->description;
+				} else {
+					$menu_item->_invalid = true;
+					$post_type_description = '';
+				}
+				$menu_item->type_label = __( 'Post Type Archive' );
+				$post_content = wp_trim_words( $menu_item->post_content, 200 );
+				$post_type_description = '' == $post_content ? $post_type_description : $post_content;
+				$menu_item->url = get_post_type_archive_link( $menu_item->object );
 			} elseif ( 'taxonomy' == $menu_item->type ) {
 				$object = get_taxonomy( $menu_item->object );
 				if ( $object ) {
 					$menu_item->type_label = $object->labels->singular_name;
 				} else {
 				$menu_item->title = '' == $menu_item->post_title ? $original_title : $menu_item->post_title;
 			} else {
 				$menu_item->type_label = __('Custom Link');
 				$menu_item->title = $menu_item->post_title;
-				$menu_item->url = empty( $menu_item->url ) ? get_post_meta( $menu_item->ID, '_menu_item_url', true ) : $menu_item->url;
+				$menu_item->url = ! isset( $menu_item->url ) ? get_post_meta( $menu_item->ID, '_menu_item_url', true ) : $menu_item->url;
 			}
-			$menu_item->target = empty( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target;
+			$menu_item->target = ! isset( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target;
 			/**
-			 * Filter a navigation menu item's title attribute.
+			 * Filters a navigation menu item's title attribute.
 			 *
 			 * @since 3.0.0
 			 *
 			 * @param string $item_title The menu item title attribute.
 			 */
-			$menu_item->attr_title = empty( $menu_item->attr_title ) ? apply_filters( 'nav_menu_attr_title', $menu_item->post_excerpt ) : $menu_item->attr_title;
+			$menu_item->attr_title = ! isset( $menu_item->attr_title ) ? apply_filters( 'nav_menu_attr_title', $menu_item->post_excerpt ) : $menu_item->attr_title;
-			if ( empty( $menu_item->description ) ) {
+			if ( ! isset( $menu_item->description ) ) {
 				/**
-				 * Filter a navigation menu item's description.
+				 * Filters a navigation menu item's description.
 				 *
 				 * @since 3.0.0
 				 *
 				 * @param string $description The menu item description.
 				 */
 				$menu_item->description = apply_filters( 'nav_menu_description', wp_trim_words( $menu_item->post_content, 200 ) );
 			}
-			$menu_item->classes = empty( $menu_item->classes ) ? (array) get_post_meta( $menu_item->ID, '_menu_item_classes', true ) : $menu_item->classes;
+			$menu_item->classes = ! isset( $menu_item->classes ) ? (array) get_post_meta( $menu_item->ID, '_menu_item_classes', true ) : $menu_item->classes;
-			$menu_item->xfn = empty( $menu_item->xfn ) ? get_post_meta( $menu_item->ID, '_menu_item_xfn', true ) : $menu_item->xfn;
+			$menu_item->xfn = ! isset( $menu_item->xfn ) ? get_post_meta( $menu_item->ID, '_menu_item_xfn', true ) : $menu_item->xfn;
 		} else {
 			$menu_item->db_id = 0;
 			$menu_item->menu_item_parent = 0;
 			$menu_item->object_id = (int) $menu_item->ID;
 			$menu_item->type = 'post_type';
 			$object = get_post_type_object( $menu_item->post_type );
 			$menu_item->object = $object->name;
 			$menu_item->type_label = $object->labels->singular_name;
-			if ( '' === $menu_item->post_title )
+			if ( '' === $menu_item->post_title ) {
+				/* translators: %d: ID of a post */
 				$menu_item->post_title = sprintf( __( '#%d (no title)' ), $menu_item->ID );
+			}
 			$menu_item->title = $menu_item->post_title;
 			$menu_item->url = get_permalink( $menu_item->ID );
 			$menu_item->target = '';
 		$menu_item->xfn = '';
 	}
 	/**
-	 * Filter a navigation menu item object.
+	 * Filters a navigation menu item object.
 	 *
 	 * @since 3.0.0
 	 *
 	 * @param object $menu_item The menu item object.
 	 */
 /**
 * Get the menu items associated with a particular object.
 *
 * @since 3.0.0
 *
-* @param int $object_id The ID of the original object.
+* @param int    $object_id   The ID of the original object.
 * @param string $object_type The type of object, such as "taxonomy" or "post_type."
-* @param string $taxonomy If $object_type is "taxonomy", $taxonomy is the name of the tax that $object_id belongs to
+* @param string $taxonomy    If $object_type is "taxonomy", $taxonomy is the name of the tax that $object_id belongs to
 * @return array The array of menu item IDs; empty array if none;
 */
 function wp_get_associated_nav_menu_items( $object_id = 0, $object_type = 'post_type', $taxonomy = '' ) {
 	$object_id = (int) $object_id;
 	$menu_item_ids = array();
 			'post_status' => 'any',
 			'post_type' => 'nav_menu_item',
 			'posts_per_page' => -1,
 		)
 	);
-	foreach( (array) $menu_items as $menu_item ) {
+	foreach ( (array) $menu_items as $menu_item ) {
 		if ( isset( $menu_item->ID ) && is_nav_menu_item( $menu_item->ID ) ) {
 			$menu_item_type = get_post_meta( $menu_item->ID, '_menu_item_type', true );
 			if (
 				'post_type' == $object_type &&
 				'post_type' == $menu_item_type
 function _wp_delete_post_menu_item( $object_id = 0 ) {
 	$object_id = (int) $object_id;
 	$menu_item_ids = wp_get_associated_nav_menu_items( $object_id, 'post_type' );
-	foreach( (array) $menu_item_ids as $menu_item_id ) {
+	foreach ( (array) $menu_item_ids as $menu_item_id ) {
 		wp_delete_post( $menu_item_id, true );
 	}
 }
 /**
-* Callback for handling a menu item when its original object is deleted.
+* Serves as a callback for handling a menu item when its original object is deleted.
 *
 * @since 3.0.0
 * @access private
 *
-* @param int $object_id The ID of the original object being trashed.
+* @param int    $object_id Optional. The ID of the original object being trashed. Default 0.
-*
+* @param int    $tt_id     Term taxonomy ID. Unused.
+* @param string $taxonomy  Taxonomy slug.
 */
 function _wp_delete_tax_menu_item( $object_id = 0, $tt_id, $taxonomy ) {
 	$object_id = (int) $object_id;
 	$menu_item_ids = wp_get_associated_nav_menu_items( $object_id, 'taxonomy', $taxonomy );
-	foreach( (array) $menu_item_ids as $menu_item_id ) {
+	foreach ( (array) $menu_item_ids as $menu_item_id ) {
 		wp_delete_post( $menu_item_id, true );
 	}
 }
 /**
 * @since 3.0.0
 * @access private
 *
 * @param string $new_status The new status of the post object.
 * @param string $old_status The old status of the post object.
-* @param object $post The post object being transitioned from one status to another.
+* @param object $post       The post object being transitioned from one status to another.
-* @return void
 */
 function _wp_auto_add_pages_to_menu( $new_status, $old_status, $post ) {
 	if ( 'publish' != $new_status || 'publish' == $old_status || 'page' != $post->post_type )
 		return;
 	if ( ! empty( $post->post_parent ) )
 				continue 2;
 		}
 		wp_update_nav_menu_item( $menu_id, 0, $args );
 	}
 }
+/**
+* Delete auto-draft posts associated with the supplied changeset.
+*
+* @since 4.8.0
+* @access private
+*
+* @param int $post_id Post ID for the customize_changeset.
+*/
+function _wp_delete_customize_changeset_dependent_auto_drafts( $post_id ) {
+	$post = get_post( $post_id );
+	if ( ! $post || 'customize_changeset' !== $post->post_type ) {
+		return;
+	}
+	$data = json_decode( $post->post_content, true );
+	if ( empty( $data['nav_menus_created_posts']['value'] ) ) {
+		return;
+	}
+	remove_action( 'delete_post', '_wp_delete_customize_changeset_dependent_auto_drafts' );
+	foreach ( $data['nav_menus_created_posts']['value'] as $stub_post_id ) {
+		if ( empty( $stub_post_id ) ) {
+			continue;
+		}
+		if ( 'auto-draft' === get_post_status( $stub_post_id ) ) {
+			wp_delete_post( $stub_post_id, true );
+		} elseif ( 'draft' === get_post_status( $stub_post_id ) ) {
+			wp_trash_post( $stub_post_id );
+			delete_post_meta( $stub_post_id, '_customize_changeset_uuid' );
+		}
+	}
+	add_action( 'delete_post', '_wp_delete_customize_changeset_dependent_auto_drafts' );
+}
+/**
+* Handle menu config after theme change.
+*
+* @access private
+* @since 4.9.0
+*/
+function _wp_menus_changed() {
+	$old_nav_menu_locations    = get_option( 'theme_switch_menu_locations', array() );
+	$new_nav_menu_locations    = get_nav_menu_locations();
+	$mapped_nav_menu_locations = wp_map_nav_menu_locations( $new_nav_menu_locations, $old_nav_menu_locations );
+	set_theme_mod( 'nav_menu_locations', $mapped_nav_menu_locations );
+	delete_option( 'theme_switch_menu_locations' );
+}
+/**
+* Maps nav menu locations according to assignments in previously active theme.
+*
+* @since 4.9.0
+*
+* @param array $new_nav_menu_locations New nav menu locations assignments.
+* @param array $old_nav_menu_locations Old nav menu locations assignments.
+* @return array Nav menus mapped to new nav menu locations.
+*/
+function wp_map_nav_menu_locations( $new_nav_menu_locations, $old_nav_menu_locations ) {
+	$registered_nav_menus   = get_registered_nav_menus();
+	$new_nav_menu_locations = array_intersect_key( $new_nav_menu_locations, $registered_nav_menus );
+	// Short-circuit if there are no old nav menu location assignments to map.
+	if ( empty( $old_nav_menu_locations ) ) {
+		return $new_nav_menu_locations;
+	}
+	// If old and new theme have just one location, map it and we're done.
+	if ( 1 === count( $old_nav_menu_locations ) && 1 === count( $registered_nav_menus ) ) {
+		$new_nav_menu_locations[ key( $registered_nav_menus ) ] = array_pop( $old_nav_menu_locations );
+		return $new_nav_menu_locations;
+	}
+	$old_locations = array_keys( $old_nav_menu_locations );
+	// Map locations with the same slug.
+	foreach ( $registered_nav_menus as $location => $name ) {
+		if ( in_array( $location, $old_locations, true ) ) {
+			$new_nav_menu_locations[ $location ] = $old_nav_menu_locations[ $location ];
+			unset( $old_nav_menu_locations[ $location ] );
+		}
+	}
+	// If there are no old nav menu locations left, then we're done.
+	if ( empty( $old_nav_menu_locations ) ) {
+		return $new_nav_menu_locations;
+	}
+	/*
+	 * If old and new theme both have locations that contain phrases
+	 * from within the same group, make an educated guess and map it.
+	 */
+	$common_slug_groups = array(
+		array( 'primary', 'menu-1', 'main', 'header', 'navigation', 'top' ),
+		array( 'secondary', 'menu-2', 'footer', 'subsidiary', 'bottom' ),
+		array( 'social' ),
+	);
+	// Go through each group...
+	foreach ( $common_slug_groups as $slug_group ) {
+		// ...and see if any of these slugs...
+		foreach ( $slug_group as $slug ) {
+			// ...and any of the new menu locations...
+			foreach ( $registered_nav_menus as $new_location => $name ) {
+				// ...actually match!
+				if ( false === stripos( $new_location, $slug ) && false === stripos( $slug, $new_location ) ) {
+					continue;
+				}
+				// Then see if any of the old locations...
+				foreach ( $old_nav_menu_locations as $location => $menu_id ) {
+					// ...and any slug in the same group...
+					foreach ( $slug_group as $slug ) {
+						// ... have a match as well.
+						if ( false === stripos( $location, $slug ) && false === stripos( $slug, $location ) ) {
+							continue;
+						}
+						// Make sure this location wasn't mapped and removed previously.
+						if ( ! empty( $old_nav_menu_locations[ $location ] ) ) {
+							// We have a match that can be mapped!
+							$new_nav_menu_locations[ $new_location ] = $old_nav_menu_locations[ $location ];
+							// Remove the mapped location so it can't be mapped again.
+							unset( $old_nav_menu_locations[ $location ] );
+							// Go back and check the next new menu location.
+							continue 3;
+						}
+					} // endforeach ( $slug_group as $slug )
+				} // endforeach ( $old_nav_menu_locations as $location => $menu_id )
+			} // endforeach foreach ( $registered_nav_menus as $new_location => $name )
+		} // endforeach ( $slug_group as $slug )
+	} // endforeach ( $common_slug_groups as $slug_group )
+	return $new_nav_menu_locations;
+}

changeset 7	cf61fcea0001
parent 5	5e2f62d02dcd
child 9	177826044cd9