wppaste
WordPress

WP_REST_Post_Format_Search_Handler

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

Compatibility

WordPress
since 5.6.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_Format_Search_Handler, in the order it appears in the class, grouped by the method that fires it.

Methods · 4

Source code

class WP_REST_Post_Format_Search_Handler extends WP_REST_Search_Handler { 	/**	 * Constructor.	 *	 * @since 5.6.0	 */	public function __construct() {		$this->type = 'post-format';	} 	/**	 * Searches the post formats for a given search request.	 *	 * @since 5.6.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 string[] $ids   Array containing slugs for the matching post formats.	 *     @type int      $total Total count for the matching search results.	 * }	 */	public function search_items( WP_REST_Request $request ) {		$format_strings = get_post_format_strings();		$format_slugs   = array_keys( $format_strings ); 		$query_args = array(); 		if ( ! empty( $request['search'] ) ) {			$query_args['search'] = $request['search'];		} 		/**		 * Filters the query arguments for a REST API post format search request.		 *		 * Enables adding extra arguments or setting defaults for a post format search request.		 *		 * @since 5.6.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_format_search_query', $query_args, $request ); 		$found_ids = array();		foreach ( $format_slugs as $format_slug ) {			if ( ! empty( $query_args['search'] ) ) {				$format_string       = get_post_format_string( $format_slug );				$format_slug_match   = stripos( $format_slug, $query_args['search'] ) !== false;				$format_string_match = stripos( $format_string, $query_args['search'] ) !== false;				if ( ! $format_slug_match && ! $format_string_match ) {					continue;				}			} 			$format_link = get_post_format_link( $format_slug );			if ( $format_link ) {				$found_ids[] = $format_slug;			}		} 		$page     = (int) $request['page'];		$per_page = (int) $request['per_page']; 		return array(			self::RESULT_IDS   => array_slice( $found_ids, ( $page - 1 ) * $per_page, $per_page ),			self::RESULT_TOTAL => count( $found_ids ),		);	} 	/**	 * Prepares the search result for a given post format.	 *	 * @since 5.6.0	 *	 * @param string $id     Item ID, the post format slug.	 * @param array  $fields Fields to include for the item.	 * @return array {

Changelog

Introduced in 5.6.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 6.8.8 tag, from src/wp-includes/rest-api/search/class-wp-rest-post-format-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.