WP_REST_Search_Controller::get_search_handler( WP_REST_Request $request )

Gets the search handler to handle the current request.

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Search_Handler|WP_Error) Search handler for the request type, or WP_Error object on failure.

Source

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

	protected function get_search_handler( $request ) {
		$type = $request->get_param( self::PROP_TYPE );

		if ( ! $type || ! isset( $this->search_handlers[ $type ] ) ) {
			return new WP_Error(
				'rest_search_invalid_type',
				__( 'Invalid type parameter.' ),
				array( 'status' => 400 )
			);
		}

		return $this->search_handlers[ $type ];
	}

Expand Source Code View on GitHub

Related

Used By

Used By
Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php: WP_REST_Search_Controller::get_items()

Retrieves a collection of search results.
wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php: WP_REST_Search_Controller::prepare_item_for_response()

Prepares a single search result for response.
wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php: WP_REST_Search_Controller::sanitize_subtypes()

Sanitizes the list of subtypes, to ensure only subtypes of the passed type are included.

Changelog

Changelog
Version Description
5.0.0 Introduced.