云策 WordPress 开发者社区

函数文档

wp_get_nav_menus()

查看官方原文 ↗
💡 云策文档标注

概述

wp_get_nav_menus() 函数用于检索所有导航菜单对象，基于 get_terms() 实现，并支持参数过滤和钩子应用。

关键要点

  • 返回所有导航菜单对象的数组，类型为 WP_Term[]
  • 可选参数 $args 传递给 get_terms()，默认包含 taxonomy 为 'nav_menu'、hide_empty 为 false、orderby 为 'name'
  • 使用 wp_parse_args() 合并参数，并通过 apply_filters('wp_get_nav_menus') 钩子过滤结果
  • 与 get_registered_nav_menus() 和 get_nav_menu_locations() 等函数有区别，后者分别返回注册菜单和菜单位置分配
  • 自版本 3.0.0 引入，4.1.0 中 orderby 默认值从 'none' 改为 'name'

代码示例

var_dump( wp_get_nav_menus() ); // 返回所有导航菜单对象
var_dump( get_registered_nav_menus() ); // 返回注册的菜单
var_dump( get_nav_menu_locations() ); // 返回主题中分配的菜单位置
📄 原文内容

Returns all navigation menu objects.

Parameters

$argsarrayoptional
Array of arguments passed on to get_terms() .

More Arguments from get_terms( … $args )

Array or string of arguments. See WP_Term_Query::__construct() for information on accepted arguments.

Default:array()

Return

WP_Term[] An array of menu objects.

Source

function wp_get_nav_menus( $args = array() ) {
	$defaults = array(
		'taxonomy'   => 'nav_menu',
		'hide_empty' => false,
		'orderby'    => 'name',
	);
	$args     = wp_parse_args( $args, $defaults );

	/**
	 * Filters the navigation menu objects being returned.
	 *
	 * @since 3.0.0
	 *
	 * @see get_terms()
	 *
	 * @param WP_Term[] $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( $args ), $args );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘wp_get_nav_menus’, WP_Term[] $menus, array $args )

Filters the navigation menu objects being returned.

Uses Description
get_terms()wp-includes/taxonomy.php

Retrieves the terms in a given taxonomy or list of taxonomies.
wp_parse_args()wp-includes/functions.php

Merges user defined arguments into defaults array.
apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Show 1 moreShow less

Used by Description
WP_Navigation_Fallback::get_fallback_classic_menu()wp-includes/class-wp-navigation-fallback.php

Determines the most appropriate classic navigation menu to use as a fallback.
WP_Customize_Nav_Menus::enqueue_scripts()wp-includes/class-wp-customize-nav-menus.php

Enqueues scripts and styles for Customizer pane.
WP_Customize_Nav_Menus::customize_register()wp-includes/class-wp-customize-nav-menus.php

Adds the customizer settings and controls.
wxr_nav_menu_terms()wp-admin/includes/export.php

Outputs all navigation menu terms.
wp_nav_menu_update_menu_items()wp-admin/includes/nav-menu.php

Saves nav menu items.
WP_Nav_Menu_Widget::form()wp-includes/widgets/class-wp-nav-menu-widget.php

Outputs the settings form for the Navigation Menu widget.
wp_nav_menu()wp-includes/nav-menu-template.php

Displays a navigation menu.

Show 2 moreShow less

Changelog

Version Description
4.1.0 Default value of the 'orderby' argument was changed from 'none' to 'name'.
3.0.0 Introduced.

User Contributed Notes

  1. Skip to note 2 content


    capbussat


    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    After some work, I have summarized differences between some menu functions:
    var_dump( wp_get_nav_menus()); // returns all navigation objects<br />
    var_dump( get_registered_nav_menus()); // returns registered menus<br />
    var_dump( get_nav_menu_locations());     // returns allocated menus to theme

    Menu Objects are like this:
    Menu object has: public ‘term_id’ => int 17
    Menu object has: public ‘term_id’ => int 18

    Registered menus in theme:
    array (size=2)
    ‘primary’ => string ‘Primary menu’ (length=12)
    ‘footer’ => string ‘Secondary menu’ (length=14)

    Locations point to used menus:
    array (size=2)
    ‘primary’ => int 17
    ‘footer’ => int 18

    So in this theme: only ‘primary’ and ‘footer’ exist in the theme and are used 17 for ‘primary’and 18 menu object for ‘footer’