云策 WordPress 开发者社区

函数文档

get_registered_nav_menus()

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

概述

get_registered_nav_menus() 函数用于检索主题中所有已注册的导航菜单位置。它返回一个关联数组，键为菜单位置，值为描述；若无注册位置，则返回空数组。

关键要点

  • 函数返回 string[] 类型的关联数组，键是菜单位置，值是描述
  • 如果未注册任何菜单位置，返回空数组
  • 函数内部使用全局变量 $_wp_registered_nav_menus 来获取数据
  • 该函数自 WordPress 3.0.0 版本引入

代码示例

$menus = get_registered_nav_menus();
if ( ! empty( $menus ) ) {
    foreach ( $menus as $location => $description ) {
        echo $location . ': ' . $description . '<br>';
    }
}

注意事项

  • 函数仅检索当前活动主题中注册的菜单位置，不适用于其他主题
  • 返回的数组示例可能包含如 ['primary-menu' => 'Primary Menu', 'secondary-menu' => 'Secondary Menu', 'footer-menu' => 'Footer Menu'] 的键值对
📄 原文内容

Retrieves all registered navigation menu locations in a theme.

Return

string[] Associative array of registered navigation menu descriptions keyed by their location. If none are registered, an empty array.

Source

function get_registered_nav_menus() {
	global $_wp_registered_nav_menus;
	if ( isset( $_wp_registered_nav_menus ) ) {
		return $_wp_registered_nav_menus;
	}
	return array();
}

View all references View on Trac View on GitHub

Used by Description
WP_REST_Menus_Controller::handle_locations()wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php

Updates the menu’s locations from a REST request.
WP_REST_Menus_Controller::get_item_schema()wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php

Retrieves the term’s schema, conforming to JSON Schema.
WP_REST_Menu_Locations_Controller::get_items()wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php

Retrieves all menu locations, depending on user context.
WP_REST_Menu_Locations_Controller::get_item()wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php

Retrieves a specific menu location.
wp_map_nav_menu_locations()wp-includes/nav-menu.php

Maps nav menu locations according to assignments in previously active theme.
WP_Customize_Nav_Menu_Locations_Control::content_template()wp-includes/customize/class-wp-customize-nav-menu-locations-control.php

JS/Underscore template for the control UI.
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.
has_nav_menu()wp-includes/nav-menu.php

Determines whether a registered nav menu location has a menu assigned to it.

Show 4 moreShow less

Changelog

Version Description
3.0.0 Introduced.

User Contributed Notes