WP_REST_Menus_Controller::prepare_item_for_response( WP_Term $term, WP_REST_Request $request ): WP_REST_Response

In this article

Prepares a single term output for response.

Parameters

$termWP_Termrequired
Term object.
$requestWP_REST_Requestrequired
Request object.

Return

WP_REST_Response Response object.

Source

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 );

	if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {
		$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 );
}

Hooks

apply_filters( “rest_prepare_{$this->taxonomy}”, WP_REST_Response $response, WP_Term $item, WP_REST_Request $request )

Filters the term data for a REST API response.

Changelog

VersionDescription
5.9.0Introduced.

User Contributed Notes

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