Retrieves all menu items of a navigation menu.

Note: Most arguments passed to the $args parameter – save for ‘output_key’ – are 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 items that get returned from this function.

$menu int|string|WP_Term Required

Menu ID, slug, name, or object.

$args array Optional

Arguments to pass to get_posts() .

• orderstring
  How to order nav menu items as queried with get_posts() . Will be ignored if 'output' is ARRAY_A. Default 'ASC'.
• orderbystring
  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'.
• post_typestring
  Menu items post type. Default 'nav_menu_item'.
• post_statusstring
  Menu items post status. Default 'publish'.
• outputstring
  How to order outputted menu items. Default ARRAY_A.
• output_keystring
  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'.
• nopagingbool
  Whether to retrieve all menu items (true) or paginate (false). Default true.

More Arguments from get_posts( ... $args )

Array or string of Query parameters.

• attachment_idint
  Attachment post ID. Used for 'attachment' post_type.
• authorint|string
  Author ID, or comma-separated list of IDs.
• author_namestring
  User 'user_nicename'.
• author__inint[]
  An array of author IDs to query from.
• author__not_inint[]
  An array of author IDs not to query from.
• cache_resultsbool
  Whether to cache post information. Default true.
• catint|string
  Category ID or comma-separated list of IDs (this or any children).
• category__andint[]
  An array of category IDs (AND in).
• category__inint[]
  An array of category IDs (OR in, no children).
• category__not_inint[]
  An array of category IDs (NOT in).
• category_namestring
  Use category slug (not name, this or any children).
• comment_countarray|int
  Filter results by comment count. Provide an integer to match comment count exactly. Provide an array with integer 'value' and 'compare' operator ('=', '!=', '>', '>=', '<', '<=' ) to compare against comment_count in a specific way.
• comment_statusstring
  Comment status.
• comments_per_pageint
  The number of comments to return per page.
  Default 'comments_per_page' option.
• date_queryarray
  An associative array of WP_Date_Query arguments.
  See WP_Date_Query::__construct().
• dayint
  Day of the month. Accepts numbers 1-31.
• exactbool
  Whether to search by exact keyword. Default false.
• fieldsstring
  Post fields to query for. Accepts:
  

  • '' Returns an array of complete post objects (WP_Post[]).
  • 'ids' Returns an array of post IDs (int[]).
  • 'id=>parent' Returns an associative array of parent post IDs, keyed by post ID (int[]).

  Default ''.
• hourint
  Hour of the day. Accepts numbers 0-23.
• ignore_sticky_postsint|bool
  Whether to ignore sticky posts or not. Setting this to false excludes stickies from 'post__in'. Accepts 1|true, 0|false.
  Default false.
• mint
  Combination YearMonth. Accepts any four-digit year and month numbers 01-12.
• meta_keystring|string[]
  Meta key or keys to filter by.
• meta_valuestring|string[]
  Meta value or values to filter by.
• meta_comparestring
  MySQL operator used for comparing the meta value.
  See WP_Meta_Query::__construct() for accepted values and default value.
• meta_compare_keystring
  MySQL operator used for comparing the meta key.
  See WP_Meta_Query::__construct() for accepted values and default value.
• meta_typestring
  MySQL data type that the meta_value column will be CAST to for comparisons.
  See WP_Meta_Query::__construct() for accepted values and default value.
• meta_type_keystring
  MySQL data type that the meta_key column will be CAST to for comparisons.
  See WP_Meta_Query::__construct() for accepted values and default value.
• meta_queryarray
  An associative array of WP_Meta_Query arguments.
  See WP_Meta_Query::__construct() for accepted values.
• menu_orderint
  The menu order of the posts.
• minuteint
  Minute of the hour. Accepts numbers 0-59.
• monthnumint
  The two-digit month. Accepts numbers 1-12.
• namestring
  Post slug.
• nopagingbool
  Show all posts (true) or paginate (false). Default false.
• no_found_rowsbool
  Whether to skip counting the total rows found. Enabling can improve performance. Default false.
• offsetint
  The number of posts to offset before retrieval.
• orderstring
  Designates ascending or descending order of posts. Default 'DESC'.
  Accepts 'ASC', 'DESC'.
• orderbystring|array
  Sort retrieved posts by parameter. One or more options may be passed.
  To use 'meta_value', or 'meta_value_num', 'meta_key=keyname' must be also be defined. To sort by a specific $meta_query clause, use that clause's array key. Accepts:
  

  • 'none'
  • 'name'
  • 'author'
  • 'date'
  • 'title'
  • 'modified'
  • 'menu_order'
  • 'parent'
  • 'ID'
  • 'rand'
  • 'relevance'
  • 'RAND(x)' (where 'x' is an integer seed value)
  • 'comment_count'
  • 'meta_value'
  • 'meta_value_num'
  • 'post__in'
  • 'post_name__in'
  • 'post_parent__in'
  • The array keys of $meta_query.

  Default is 'date', except when a search is being performed, when the default is 'relevance'.
• pint
  Post ID.
• pageint
  Show the number of posts that would show up on page X of a static front page.
• pagedint
  The number of the current page.
• page_idint
  Page ID.
• pagenamestring
  Page slug.
• permstring
  Show posts if user has the appropriate capability.
• ping_statusstring
  Ping status.
• post__inint[]
  An array of post IDs to retrieve, sticky posts will be included.
• post__not_inint[]
  An array of post IDs not to retrieve. Note: a string of comma- separated IDs will NOT work.
• post_mime_typestring
  The mime type of the post. Used for 'attachment' post_type.
• post_name__instring[]
  An array of post slugs that results must match.
• post_parentint
  Page ID to retrieve child pages for. Use 0 to only retrieve top-level pages.
• post_parent__inint[]
  An array containing parent page IDs to query child pages from.
• post_parent__not_inint[]
  An array containing parent page IDs not to query child pages from.
• post_typestring|string[]
  A post type slug (string) or array of post type slugs.
  Default 'any' if using 'tax_query'.
• post_statusstring|string[]
  A post status (string) or array of post statuses.
• posts_per_pageint
  The number of posts to query for. Use -1 to request all posts.
• posts_per_archive_pageint
  The number of posts to query for by archive page. Overrides 'posts_per_page' when is_archive() , or is_search() are true.
• sstring
  Search keyword(s). Prepending a term with a hyphen will exclude posts matching that term. Eg, 'pillow -sofa' will return posts containing 'pillow' but not 'sofa'. The character used for exclusion can be modified using the the 'wp_query_search_exclusion_prefix' filter.
• secondint
  Second of the minute. Accepts numbers 0-59.
• sentencebool
  Whether to search by phrase. Default false.
• suppress_filtersbool
  Whether to suppress filters. Default false.
• tagstring
  Tag slug. Comma-separated (either), Plus-separated (all).
• tag__andint[]
  An array of tag IDs (AND in).
• tag__inint[]
  An array of tag IDs (OR in).
• tag__not_inint[]
  An array of tag IDs (NOT in).
• tag_idint
  Tag id or comma-separated list of IDs.
• tag_slug__andstring[]
  An array of tag slugs (AND in).
• tag_slug__instring[]
  An array of tag slugs (OR in). unless 'ignore_sticky_posts' is true. Note: a string of comma-separated IDs will NOT work.
• tax_queryarray
  An associative array of WP_Tax_Query arguments.
  See WP_Tax_Query::__construct().
• titlestring
  Post title.
• update_post_meta_cachebool
  Whether to update the post meta cache. Default true.
• update_post_term_cachebool
  Whether to update the post term cache. Default true.
• update_menu_item_cachebool
  Whether to update the menu item cache. Default false.
• lazy_load_term_metabool
  Whether to lazy-load term meta. Setting to false will disable cache priming for term meta, so that each get_term_meta() call will hit the database.
  Defaults to the value of $update_post_term_cache.
• wint
  The week number of the year. Accepts numbers 0-53.
• yearint
  The four-digit year. Accepts any four-digit year.

Default: array()

array|false Array of menu items, otherwise false.

File: wp-includes/nav-menu.php. View all references

function wp_get_nav_menu_items( $menu, $args = array() ) {
	$menu = wp_get_nav_menu_object( $menu );

	if ( ! $menu ) {
		return false;
	}

	if ( ! taxonomy_exists( 'nav_menu' ) ) {
		return false;
	}

	$defaults = array(
		'order'                  => 'ASC',
		'orderby'                => 'menu_order',
		'post_type'              => 'nav_menu_item',
		'post_status'            => 'publish',
		'output'                 => ARRAY_A,
		'output_key'             => 'menu_order',
		'nopaging'               => true,
		'update_menu_item_cache' => true,
		'tax_query'              => array(
			array(
				'taxonomy' => 'nav_menu',
				'field'    => 'term_taxonomy_id',
				'terms'    => $menu->term_taxonomy_id,
			),
		),
	);
	$args     = wp_parse_args( $args, $defaults );
	if ( $menu->count > 0 ) {
		$items = get_posts( $args );
	} else {
		$items = array();
	}

	$items = array_map( 'wp_setup_nav_menu_item', $items );

	if ( ! is_admin() ) { // Remove invalid items only on front end.
		$items = array_filter( $items, '_is_valid_nav_menu_item' );
	}

	if ( ARRAY_A === $args['output'] ) {
		$items = wp_list_sort(
			$items,
			array(
				$args['output_key'] => 'ASC',
			)
		);

		$i = 1;

		foreach ( $items as $k => $item ) {
			$items[ $k ]->{$args['output_key']} = $i++;
		}
	}

	/**
	 * 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 );
}