get_nav_menu_locations() – Function | Developer.WordPress.org

Retrieves all registered navigation menu locations and the menus assigned to them.

Return

int[] Associative array of registered navigation menu IDs keyed by their location name. If none are registered, an empty array.

Source

function get_nav_menu_locations() {
	$locations = get_theme_mod( 'nav_menu_locations' );
	return ( is_array( $locations ) ) ? $locations : array();
}

View all references View on Trac View on GitHub

Uses	Description
get_theme_mod()`wp-includes/theme.php`	Retrieves theme modification value for the active theme.

Used by	Description
WP_Navigation_Fallback::get_nav_menu_at_primary_location()`wp-includes/class-wp-navigation-fallback.php`	Gets the classic menu assigned to the `primary` navigation menu location if it exists.
WP_REST_Menus_Controller::get_menu_locations()`wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php`	Returns the names of the locations assigned to the menu.
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_Menu_Locations_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php`	Prepares a menu location object for serialization.
WP_REST_Menu_Locations_Controller::prepare_links()`wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php`	Prepares links for the request.
_wp_menus_changed()`wp-includes/nav-menu.php`	Handles menu config after theme change.
wp_get_nav_menu_name()`wp-includes/nav-menu.php`	Returns the name of a navigation menu.
WP_Customize_Nav_Menus::__construct()`wp-includes/class-wp-customize-nav-menus.php`	Constructor.
wp_nav_menu()`wp-includes/nav-menu-template.php`	Displays a navigation menu.
has_nav_menu()`wp-includes/nav-menu.php`	Determines whether a registered nav menu location has a menu assigned to it.
wp_delete_nav_menu()`wp-includes/nav-menu.php`	Deletes a navigation menu.

Show 6 more Show less

Changelog

Version	Description
3.0.0	Introduced.

User Contributed Notes

madastro 9 years ago

Allows the editor role to modify menus

function allow_menu_editor() {
	$arr_menu = array_filter(get_nav_menu_locations());
	if ( ! empty($arr_menu) ) {
		$obj_role = get_role('editor');
		$obj_role->add_cap('edit_theme_options');
	}
}
add_action( 'admin_menu', 'allow_menu_editor', 999);

khangaitan 9 years ago

$menu_name = 'menu1';
$menu_item = wp_get_nav_menu_object( get_nav_menu_locations( $menu_name )[ $menu_name ] )->name;

echo $menu_item ? $menu_item : __( 'Insert menus', 'textdomain' );
wp_nav_menu( array(
	'theme_location' => $menu_name,
	'container'      => ''
) );

$menu_name = '';

$menu_name = 'menu2';
$menu_item = wp_get_nav_menu_object( get_nav_menu_locations( $menu_name )[ $menu_name ] )->name;

echo $menu_item ? $menu_item : __( 'Insert menus', 'textdomain' );
wp_nav_menu( array(
	'theme_location' => $menu_name,
	'container'      => ''
) );

$menu_name = '';

$menu_name = 'menu3';
$menu_item = wp_get_nav_menu_object( get_nav_menu_locations( $menu_name )[ $menu_name ] )->name;

echo $menu_item ? $menu_item : __( 'Insert menus', 'textdomain' );
wp_nav_menu( array(
	'theme_location' => $menu_name,
	'container'      => ''
) );

Skip to note 6 content

Deepesh Dhakal 2 years ago

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
Just to Update on the ‘return’ statement, it returns ‘integer’ for individual ‘menu-location’ if no menu is assigned. To be precise, it returns an Array like so:
```
print_r(get_nav_menu_locations());
```
Returns an array like so
Array ( [main-menu] => 757 [mobile-menu] => 1506 [footer-menu] => 0 )
main-menu and mobile-menu are assigned so they return Menu ID whereas footer-menu is unassigned and thus returns ‘0’.
Log in to add feedback

get_nav_menu_locations(): int[]

In this article

Return

Source

Changelog

User Contributed Notes

get_nav_menu_locations(): int[]

In this article

Return

Source

Related

Changelog

User Contributed Notes