wppaste
WordPress

WP_REST_Post_Search_Handler

Since
5.0.0
Source
wp-includes/rest-api/search/class-wp-rest-post-search-handler.php:17
Core class representing a search handler for posts in the REST API.

Compatibility

WordPress
since 5.0.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 1

Every hook that fires from inside WP_REST_Post_Search_Handler, in the order it appears in the class, grouped by the method that fires it.

Methods · 6

Source code

class WP_REST_Post_Search_Handler extends WP_REST_Search_Handler { 	/**	 * Constructor.	 *	 * @since 5.0.0	 */	public function __construct() {		$this->type = 'post'; 		// Support all public post types except attachments.		$this->subtypes = array_diff(			array_values(				get_post_types(					array(						'public'       => true,						'show_in_rest' => true,					),					'names'				)			),			array( 'attachment' )		);	} 	/**	 * Searches posts for a given search request.	 *	 * @since 5.0.0	 *	 * @param WP_REST_Request $request Full REST request.	 * @return array {	 *     Associative array containing found IDs and total count for the matching search results.	 *	 *     @type int[] $ids   Array containing the matching post IDs.	 *     @type int   $total Total count for the matching search results.	 * }	 */	public function search_items( WP_REST_Request $request ) { 		// Get the post types to search for the current request.		$post_types = $request[ WP_REST_Search_Controller::PROP_SUBTYPE ];		if ( in_array( WP_REST_Search_Controller::TYPE_ANY, $post_types, true ) ) {			$post_types = $this->subtypes;		} 		$query_args = array(			'post_type'           => $post_types,			'post_status'         => 'publish',			'paged'               => (int) $request['page'],			'posts_per_page'      => (int) $request['per_page'],			'ignore_sticky_posts' => true,		); 		if ( ! empty( $request['search'] ) ) {			$query_args['s'] = $request['search'];		} 		if ( ! empty( $request['exclude'] ) ) {			$query_args['post__not_in'] = $request['exclude'];		} 		if ( ! empty( $request['include'] ) ) {			$query_args['post__in'] = $request['include'];		} 		/**		 * Filters the query arguments for a REST API post search request.		 *		 * Enables adding extra arguments or setting defaults for a post search request.		 *		 * @since 5.1.0		 *		 * @param array           $query_args Key value array of query var to query value.		 * @param WP_REST_Request $request    The request used.		 */		$query_args = apply_filters( 'rest_post_search_query', $query_args, $request ); 		$query = new WP_Query();		$posts = $query->query( $query_args );

Changelog

Introduced in 5.0.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.