WP_REST_Menus_Controller::prepare_item_for_response() WordPress Method
The WP_REST_Menus_Controller::prepare_item_for_response() method is used to prepare a menu item for serialization in the WordPress REST API. This is a method of the WP_REST_Menus_Controller class.
WP_REST_Menus_Controller::prepare_item_for_response( WP_Term $term, WP_REST_Request $request ) #
Prepares a single term output for response.
Parameters
- $term
(WP_Term)(Required)Term object.
- $request
(WP_REST_Request)(Required)Request object.
Return
(WP_REST_Response) Response object.
Source
File: wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php
public function prepare_item_for_response( $term, $request ) { $nav_menu = wp_get_nav_menu_object( $term ); $response = parent::prepare_item_for_response( $nav_menu, $request ); $fields = $this->get_fields_for_response( $request ); $data = $response->get_data(); if ( rest_is_field_included( 'locations', $fields ) ) { $data['locations'] = $this->get_menu_locations( $nav_menu->term_id ); } if ( rest_is_field_included( 'auto_add', $fields ) ) { $data['auto_add'] = $this->get_menu_auto_add( $nav_menu->term_id ); } $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 ); $response->add_links( $this->prepare_links( $term ) ); /** This action is documented in wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php */ return apply_filters( "rest_prepare_{$this->taxonomy}", $response, $term, $request ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.9.0 | Introduced. |