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

equal deleted inserted replaced

-:346c88efed21
+:5e2f62d02dcd
 /**
 * Returns a navigation menu object.
 *
 * @since 3.0.0
 *
-* @uses get_term
+* @param string $menu Menu ID, slug, or name.
-* @uses get_term_by
-*
-* @param string $menu Menu id, slug or name
 * @return mixed 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 )
 		return false;
 *
 * 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 $menu The menu to check (ID, slug, or name).
 * @return bool Whether the menu exists.
 */
 function is_nav_menu( $menu ) {
 	if ( ! $menu )
 		return false;
 }
 /**
 * Unregisters a navigation menu for a theme.
 *
-* @param array $location the menu location identifier
+* @param string $location The menu location identifier.
-*
 * @return bool True on success, false on failure.
 */
 function unregister_nav_menu( $location ) {
 	global $_wp_registered_nav_menus;
 	if ( is_array( $_wp_registered_nav_menus ) && isset( $_wp_registered_nav_menus[$location] ) ) {
 		unset( $_wp_registered_nav_menus[$location] );
+		if ( empty( $_wp_registered_nav_menus ) ) {
+			_remove_theme_support( 'menus' );
+		}
 		return true;
 	}
 	return false;
 }
 * @since 3.0.0
 * @param string $location Menu location identifier.
 * @return bool Whether location has a menu.
 */
 function has_nav_menu( $location ) {
+	$registered_nav_menus = get_registered_nav_menus();
+	if ( ! isset( $registered_nav_menus[ $location ] ) ) {
+		return false;
+	}
 	$locations = get_nav_menu_locations();
 	return ( ! empty( $locations[ $location ] ) );
 }
 /**
 /**
 * Create a Navigation Menu.
 *
 * @since 3.0.0
 *
-* @param string $menu_name Menu Name
+* @param string $menu_name Menu name.
-* @return mixed Menu object on success|WP_Error on failure
+* @return int|WP_Error Menu ID on success, WP_Error object on failure.
 */
 function wp_create_nav_menu( $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 name|id|slug
+* @param string $menu Menu ID, slug, or name.
-* @return mixed Menu object on success|WP_Error on failure
+* @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 )
 		return false;
 			$locations[ $location ] = 0;
 	}
 	set_theme_mod( 'nav_menu_locations', $locations );
 	if ( $result && !is_wp_error($result) )
+		/**
+		 * Fires after a navigation menu has been successfully deleted.
+		 *
+		 * @since 3.0.0
+		 *
+		 * @param int $term_id ID of the deleted menu.
+		 */
 		do_action( 'wp_delete_nav_menu', $menu->term_id );
 	return $result;
 }
 *
 * @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|error object The menu's ID or WP_Error object.
+* @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() ) {
 	$menu_id = (int) $menu_id;
 	$_menu = wp_get_nav_menu_object( $menu_id );
 		$_menu = wp_insert_term( $menu_data['menu-name'], 'nav_menu', $args );
 		if ( is_wp_error( $_menu ) )
 			return $_menu;
+		/**
+		 * Fires after a navigation menu is successfully created.
+		 *
+		 * @since 3.0.0
+		 *
+		 * @param int   $term_id   ID of the new menu.
+		 * @param array $menu_data An array of menu data.
+		 */
 		do_action( 'wp_create_nav_menu', $_menu['term_id'], $menu_data );
 		return (int) $_menu['term_id'];
 	}
 	$update_response = wp_update_term( $menu_id, 'nav_menu', $args );
 	if ( is_wp_error( $update_response ) )
 		return $update_response;
+	/**
+	 * Fires after a navigation menu has been successfully updated.
+	 *
+	 * @since 3.0.0
+	 *
+	 * @param int   $menu_id   ID of the updated menu.
+	 * @param array $menu_data An array of menu data.
+	 */
 	do_action( 'wp_update_nav_menu', $menu_id, $menu_data );
 	return $menu_id;
 }
 /**
 * @since 3.0.0
 *
 * @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 The menu item's database ID or WP_Error object on failure.
+* @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;
 	// make sure that we don't convert non-nav_menu_item objects into nav_menu_item objects
 	if ( ! empty( $menu_item_db_id ) && ! is_nav_menu_item( $menu_item_db_id ) )
-		return new WP_Error('update_nav_menu_item_failed', __('The given object ID is not that of a menu item.'));
+		return new WP_Error( 'update_nav_menu_item_failed', __( 'The given object ID is not that of a menu item.' ) );
 	$menu = wp_get_nav_menu_object( $menu_id );
-	if ( ( ! $menu && 0 !== $menu_id ) || is_wp_error( $menu ) )
+	if ( ! $menu && 0 !== $menu_id ) {
+		return new WP_Error( 'invalid_menu_id', __( 'Invalid menu ID.' ) );
+	}
+	if ( is_wp_error( $menu ) ) {
 		return $menu;
+	}
 	$defaults = array(
 		'menu-item-db-id' => $menu_item_db_id,
 		'menu-item-object-id' => 0,
 		'menu-item-object' => '',
 		'post_type' => 'nav_menu_item',
 	);
 	$update = 0 != $menu_item_db_id;
-	// 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 ) ) )
-		$post['tax_input'] = array( 'nav_menu' => array( intval( $menu->term_id ) ) );
 	// New menu item. Default is draft status
 	if ( ! $update ) {
 		$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;
 	}
+	// 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 ) ) ) {
+		wp_set_object_terms( $menu_item_db_id, array( $menu->term_id ), 'nav_menu' );
+	}
 	if ( 'custom' == $args['menu-item-type'] ) {
 		$args['menu-item-object-id'] = $menu_item_db_id;
 		$args['menu-item-object'] = 'custom';
 	}
 		$post['ID'] = $menu_item_db_id;
 		$post['post_status'] = 'draft' == $args['menu-item-status'] ? 'draft' : 'publish';
 		wp_update_post( $post );
 	}
-	do_action('wp_update_nav_menu_item', $menu_id, $menu_item_db_id, $args );
+	/**
+	 * Fires after a navigation menu item has been updated.
+	 *
+	 * @since 3.0.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 updated menu item.
+	 * @param array $args            An array of arguments used to update a menu item.
+	 */
+	do_action( 'wp_update_nav_menu_item', $menu_id, $menu_item_db_id, $args );
 	return $menu_item_db_id;
 }
 /**
 * Returns all navigation menu objects.
 *
 * @since 3.0.0
-*
+* @since 4.1.0 Default value of the 'orderby' argument was changed from 'none'
-* @param array $args Array of arguments passed on to get_terms().
+*              to 'name'.
-* @return array menu objects
+*
+* @param array $args Optional. Array of arguments passed on to {@see get_terms()}.
+*                    Default empty array.
+* @return array Menu objects.
 */
 function wp_get_nav_menus( $args = array() ) {
-	$defaults = array( 'hide_empty' => false, 'orderby' => 'none' );
+	$defaults = array( 'hide_empty' => false, 'orderby' => 'name' );
 	$args = wp_parse_args( $args, $defaults );
+	/**
+	 * Filter the navigation menu objects being returned.
+	 *
+	 * @since 3.0.0
+	 *
+	 * @see get_terms()
+	 *
+	 * @param array $menus An array of menu objects.
+	 * @param array $args  An array of arguments used to retrieve menu objects.
+	 */
 	return apply_filters( 'wp_get_nav_menus', get_terms( 'nav_menu',  $args), $args );
 }
 /**
 * Sort menu items by the desired key.
 	else
 		return strcmp( $a->$_menu_item_sort_prop, $b->$_menu_item_sort_prop );
 }
 /**
-* Returns if a menu item is valid. Bug #13958
+* Return if a menu item is valid.
+*
+* @link https://core.trac.wordpress.org/ticket/13958
 *
 * @since 3.2.0
 * @access private
 *
-* @param object $menu_item The menu item to check
+* @param object $item The menu item to check.
-* @return bool false if invalid, else true.
+* @return bool False if invalid, otherwise true.
 */
 function _is_valid_nav_menu_item( $item ) {
 	if ( ! empty( $item->_invalid ) )
 		return false;
 	return true;
 }
 /**
-* Returns all menu items of a navigation menu.
+* Return all menu items of a navigation menu.
 *
 * @since 3.0.0
 *
-* @param string $menu menu name, id, or slug
+* @param string $menu Menu name, ID, or slug.
-* @param string $args
+* @param array  $args Optional. Arguments to pass to {@see get_posts()}.
-* @return mixed $items array of menu items, else false.
+* @return mixed $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 )
 		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 );
-	if ( count( $items ) > 1 )
+	$args['include'] = $items;
-		$args['include'] = implode( ',', $items );
-	else
-		$args['include'] = $items[0];
 	$items = get_posts( $args );
 	if ( is_wp_error( $items ) || ! is_array( $items ) )
 		return false;
 		foreach( $items as $k => $item ) {
 			$items[$k]->$args['output_key'] = $i++;
 		}
 	}
+	/**
+	 * Filter 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 );
 }
 /**
 * Decorates a menu item object with the shared navigation menu item properties.
 				$menu_item->url = get_permalink( $menu_item->object_id );
 				$original_object = get_post( $menu_item->object_id );
 				$original_title = $original_object->post_title;
+				if ( '' === $original_title ) {
+					$original_title = sprintf( __( '#%d (no title)' ), $original_object->ID );
+				}
 				$menu_item->title = '' == $menu_item->post_title ? $original_title : $menu_item->post_title;
 			} elseif ( 'taxonomy' == $menu_item->type ) {
 				$object = get_taxonomy( $menu_item->object );
 				if ( $object ) {
 				if ( is_wp_error( $original_title ) )
 					$original_title = false;
 				$menu_item->title = '' == $menu_item->post_title ? $original_title : $menu_item->post_title;
 			} else {
-				$menu_item->type_label = __('Custom');
+				$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->target = empty( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target;
+			/**
+			 * Filter 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;
-			if ( empty( $menu_item->description ) )
+			if ( empty( $menu_item->description ) ) {
-				$menu_item->description = apply_filters( 'nav_menu_description',  wp_trim_words( $menu_item->post_content, 200 ) );
+				/**
+				 * Filter 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->xfn = empty( $menu_item->xfn ) ? get_post_meta( $menu_item->ID, '_menu_item_xfn', true ) : $menu_item->xfn;
 		} else {
 			$menu_item->db_id = 0;
 			$menu_item->title = $menu_item->post_title;
 			$menu_item->url = get_permalink( $menu_item->ID );
 			$menu_item->target = '';
+			/** This filter is documented in wp-includes/nav-menu.php */
 			$menu_item->attr_title = apply_filters( 'nav_menu_attr_title', '' );
+			/** This filter is documented in wp-includes/nav-menu.php */
 			$menu_item->description = apply_filters( 'nav_menu_description', '' );
 			$menu_item->classes = array();
 			$menu_item->xfn = '';
 		}
 	} elseif ( isset( $menu_item->taxonomy ) ) {
 		$menu_item->classes = array();
 		$menu_item->xfn = '';
 	}
+	/**
+	 * Filter a navigation menu item object.
+	 *
+	 * @since 3.0.0
+	 *
+	 * @param object $menu_item The menu item object.
+	 */
 	return apply_filters( 'wp_setup_nav_menu_item', $menu_item );
 }
 /**
 * Get the menu items associated with a particular object.
 			'posts_per_page' => -1,
 		)
 	);
 	foreach( (array) $menu_items as $menu_item ) {
 		if ( isset( $menu_item->ID ) && is_nav_menu_item( $menu_item->ID ) ) {
-			if ( get_post_meta( $menu_item->ID, '_menu_item_type', true ) !== $object_type ||
+			$menu_item_type = get_post_meta( $menu_item->ID, '_menu_item_type', true );
-				get_post_meta( $menu_item->ID, '_menu_item_object', true ) !== $taxonomy )
+			if (
-				continue;
+				'post_type' == $object_type &&
+				'post_type' == $menu_item_type
-			$menu_item_ids[] = (int) $menu_item->ID;
+			) {
+				$menu_item_ids[] = (int) $menu_item->ID;
+			} elseif (
+				'taxonomy' == $object_type &&
+				'taxonomy' == $menu_item_type &&
+				get_post_meta( $menu_item->ID, '_menu_item_object', true ) == $taxonomy
+			) {
+				$menu_item_ids[] = (int) $menu_item->ID;
+			}
 		}
 	}
 	return array_unique( $menu_item_ids );
 }

changeset 5	5e2f62d02dcd
parent 0	d970ebf37754
child 7	cf61fcea0001