get_nav_menu_locations(): int[]

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

Contents

Return

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

Top ↑

Source

File: wp-includes/nav-menu.php. View all references 

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

View on Trac View on GitHub

Top ↑

Top ↑

Uses

Uses
Uses Description
get_theme_mod() wp-includes/theme.php

Retrieves theme modification value for the active theme.

Top ↑

Used By

Used By
Used By Description
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 5 more used by Hide more used by

Top ↑

Changelog

Changelog
Version Description
3.0.0 Introduced.

Top ↑

User Contributed Notes

  1. Skip to note 1 content
    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
    Contributed by madastro —

    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);
  2. Skip to note 2 content
    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
    Contributed by khangaitan — 
    $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'      => ''
) );
  3. Skip to note 3 content
    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
    Contributed by Deepesh Dhakal —

    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’.

You must log in before being able to contribute a note or feedback.