WP_REST_Menu_Locations_Controller::get_item() WordPress Method
The WP_REST_Menu_Locations_Controller::get_item() method is used to get a specific menu location from a WordPress site. This is done by providing the menu location ID in the request.
WP_REST_Menu_Locations_Controller::get_item( WP_REST_Request $request ) #
Retrieves a specific menu location.
Parameters
- $request
(WP_REST_Request)(Required)Full details about the request.
Return
(WP_Error|WP_REST_Response) Response object on success, or WP_Error object on failure.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php
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 ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.9.0 | Introduced. |