WP_REST_Menus_Controller::get_menu_locations() – Method

WP_REST_Menus_Controller::get_menu_locations( int $menu_id ): string[]

Returns the names of the locations assigned to the menu.

Parameters

$menu_idintrequired: The menu id.

Return

string[] The locations assigned to the menu.

Source

protected function get_menu_locations( $menu_id ) {
	$locations      = get_nav_menu_locations();
	$menu_locations = array();

	foreach ( $locations as $location => $assigned_menu_id ) {
		if ( $menu_id === $assigned_menu_id ) {
			$menu_locations[] = $location;
		}
	}

	return $menu_locations;
}

View all references View on Trac View on GitHub

Uses	Description
get_nav_menu_locations()`wp-includes/nav-menu.php`	Retrieves all registered navigation menu locations and the menus assigned to them.

Used by	Description
WP_REST_Menus_Controller::prepare_item_for_response()`wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php`	Prepares a single term output for response.
WP_REST_Menus_Controller::prepare_links()`wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php`	Prepares links for the request.

Changelog

Version	Description
5.9.0	Introduced.

User Contributed Notes

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