Retrieves all menu items of a navigation menu.

Description

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.

Parameters

$menuint|string|WP_Termrequired

Menu ID, slug, name, or object.

$argsarrayoptional

Arguments to pass to get_posts() .

• order string
  How to order nav menu items as queried with get_posts() .
  Will be ignored if 'output' is ARRAY_A. Default 'ASC'.
• orderby string
  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_type string
  Menu items post type. Default 'nav_menu_item'.
• post_status string
  Menu items post status. Default 'publish'.
• output string
  How to order outputted menu items. Default ARRAY_A.
• output_key string
  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'.
• nopaging bool
  Whether to retrieve all menu items (true) or paginate (false). Default true.
• update_menu_item_cache bool
  Whether to update the menu item cache. Default true.

More Arguments from get_posts( … $args )

Arguments to retrieve posts. See WP_Query::parse_query() for all available arguments.

• numberposts int
  Total number of posts to retrieve. Is an alias of $posts_per_page in WP_Query. Accepts -1 for all. Default 5.
• category int|string
  Category ID or comma-separated list of IDs (this or any children).
  Is an alias of $cat in WP_Query. Default 0.
• include int[]
  An array of post IDs to retrieve, sticky posts will be included.
  Is an alias of $post__in in WP_Query. Default empty array.
• exclude int[]
  An array of post IDs not to retrieve. Default empty array.
• suppress_filters bool
  Whether to suppress filters. Default true.

Default:array()

Return

Source

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

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘wp_get_nav_menu_items’, array $items, object $menu, array $args )

Filters the navigation menu items being returned.

Changelog