WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Search_Controller::get_search_handler()

WP_REST_Search_Controller::get_search_handler( WP_REST_Request $request ): WP_REST_Search_Handler|WP_Error

In this article

Back to top

Gets the search handler to handle the current request.

Parameters

$requestWP_REST_Requestrequired
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

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

	if ( ! $type || ! is_string( $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 ];
}

View all references View on Trac View on GitHub

UsesDescription
__()wp-includes/l10n.php

Retrieves the translation of $text.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

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

Retrieves a collection of search results.

WP_REST_Search_Controller::prepare_item_for_response()wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php

Prepares a single search result for response.

WP_REST_Search_Controller::sanitize_subtypes()wp-includes/rest-api/endpoints/class-wp-rest-search-controller.php

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

Changelog

VersionDescription
5.0.0Introduced.

User Contributed Notes

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