WP_REST_Menu_Locations_Controller::prepare_item_for_response( stdClass $item, WP_REST_Request $request ): WP_REST_Response
Prepares a menu location object for serialization.
Parameters
-
$item
stdClass Required -
Post status data.
-
$request
WP_REST_Request Required -
Full details about the request.
Return
WP_REST_Response Menu location data.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-menu-locations-controller.php
.
View all references
public function prepare_item_for_response( $item, $request ) {
// Restores the more descriptive, specific name for use within this method.
$location = $item;
$locations = get_nav_menu_locations();
$menu = isset( $locations[ $location->name ] ) ? $locations[ $location->name ] : 0;
$fields = $this->get_fields_for_response( $request );
$data = array();
if ( rest_is_field_included( 'name', $fields ) ) {
$data['name'] = $location->name;
}
if ( rest_is_field_included( 'description', $fields ) ) {
$data['description'] = $location->description;
}
if ( rest_is_field_included( 'menu', $fields ) ) {
$data['menu'] = (int) $menu;
}
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
$data = $this->add_additional_fields_to_object( $data, $request );
$data = $this->filter_response_by_context( $data, $context );
$response = rest_ensure_response( $data );
if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {
$response->add_links( $this->prepare_links( $location ) );
}
/**
* Filters menu location data returned from the REST API.
*
* @since 5.9.0
*
* @param WP_REST_Response $response The response object.
* @param object $location The original location object.
* @param WP_REST_Request $request Request used to generate the response.
*/
return apply_filters( 'rest_prepare_menu_location', $response, $location, $request );
}
Hooks
-
apply_filters( 'rest_prepare_menu_location',
WP_REST_Response $response ,object $location ,WP_REST_Request $request ) -
Filters menu location data returned from the REST API.
Changelog
Version | Description |
---|---|
5.9.0 | Introduced. |