get_registered_nav_menus() – Function

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 more Show less

Changelog

Version	Description
3.0.0	Introduced.

User Contributed Notes

Skip to note 4 content

Codex 9 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note
Display a simple list of the menus
```
<?php

$menus = get_registered_nav_menus();

foreach ( $menus as $location => $description ) {

	echo $location . ': ' . $description . '<br />';
}
```
Log in to add feedback
Skip to note 5 content

trex005 9 years ago

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

I think this should say “Returns an array of all registered navigation menus in active theme”, as current wording sounds like you can use this function on other themes (which is what I’m currently looking for)

Log in to add feedback
Skip to note 6 content

Philipp Stracker 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: -1You must log in to vote on the helpfulness of this note
Sample return value:
```
<?php
print_r( get_registered_nav_menus() );

/*
Output:

Array
( 
    [primary-menu] => Primary Menu
    [secondary-menu] => Secondary Menu
    [footer-menu] => Footer Menu
)
*/
```
Log in to add feedback

get_registered_nav_menus(): string[]

In this article

Return

Source

Changelog

User Contributed Notes

get_registered_nav_menus(): string[]

In this article

Return

Source

Related

Changelog

User Contributed Notes