WP_REST_Search_Controller::prepare_item_for_response

Advertisement

Summery Summery

Prepares a single search result for response.

Syntax Syntax

WP_REST_Search_Controller::prepare_item_for_response( int $id, WP_REST_Request $request )

Parameters Parameters

$id

(Required) ID of the item to prepare.

$request

(Required) Request object.

Return Return

(WP_REST_Response) Response object.

Source Source

File: wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php

	public function prepare_item_for_response( $id, $request ) {
		$handler = $this->get_search_handler( $request );
		if ( is_wp_error( $handler ) ) {
			return new WP_REST_Response();
		}

		$fields = $this->get_fields_for_response( $request );

		$data = $handler->prepare_item( $id, $fields );
		$data = $this->add_additional_fields_to_object( $data, $request );

		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
		$data    = $this->filter_response_by_context( $data, $context );

		$response = rest_ensure_response( $data );

		$links               = $handler->prepare_item_links( $id );
		$links['collection'] = array(
			'href' => rest_url( sprintf( '%s/%s', $this->namespace, $this->rest_base ) ),
		);
		$response->add_links( $links );

		return $response;
	}

Advertisement

Changelog Changelog

Changelog
Version Description
5.0.0 Introduced.

Advertisement

Leave a Reply