Retrieves a specific menu location.

$request WP_REST_Request Required

Full details about the request.

WP_Error|WP_REST_Response Response object on success, or WP_Error object on failure.

File: wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php. View all references

public function get_item( $request ) {
	$registered_menus = get_registered_nav_menus();
	if ( ! array_key_exists( $request['location'], $registered_menus ) ) {
		return new WP_Error( 'rest_menu_location_invalid', __( 'Invalid menu location.' ), array( 'status' => 404 ) );
	}

	$location              = new stdClass();
	$location->name        = $request['location'];
	$location->description = $registered_menus[ $location->name ];

	$data = $this->prepare_item_for_response( $location, $request );

	return rest_ensure_response( $data );
}