Title: WP_REST_Post_Format_Search_Handler
Published: December 9, 2020
Last modified: February 24, 2026

---

# class WP_REST_Post_Format_Search_Handler {}

## In this article

 * [Description](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#description)
    - [See also](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#see-also)
 * [Methods](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#methods)
 * [Source](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#source)
 * [Related](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#related)
 * [Changelog](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#changelog)

[ Back to top](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#wp--skip-link--target)

Core class representing a search handler for post formats in the REST API.

## 󠀁[Description](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#description)󠁿

### 󠀁[See also](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#see-also)󠁿

 * [WP_REST_Search_Handler](https://developer.wordpress.org/reference/classes/wp_rest_search_handler/)

## 󠀁[Methods](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#methods)󠁿

| Name | Description | 
| [WP_REST_Post_Format_Search_Handler::__construct](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/__construct/) | Constructor. | 
| [WP_REST_Post_Format_Search_Handler::prepare_item](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/prepare_item/) | Prepares the search result for a given post format. | 
| [WP_REST_Post_Format_Search_Handler::prepare_item_links](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/prepare_item_links/) | Prepares links for the search result. | 
| [WP_REST_Post_Format_Search_Handler::search_items](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/search_items/) | Searches the post formats for a given search request. |

## 󠀁[Source](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#source)󠁿

    ```php
    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 {
    	 *     Associative array containing fields for the post format based on the `$fields` parameter.
    	 *
    	 *     @type string $id    Optional. Post format slug.
    	 *     @type string $title Optional. Post format name.
    	 *     @type string $url   Optional. Post format permalink URL.
    	 *     @type string $type  Optional. String 'post-format'.
    	 * }
    	 */
    	public function prepare_item( $id, array $fields ) {
    		$data = array();

    		if ( in_array( WP_REST_Search_Controller::PROP_ID, $fields, true ) ) {
    			$data[ WP_REST_Search_Controller::PROP_ID ] = $id;
    		}

    		if ( in_array( WP_REST_Search_Controller::PROP_TITLE, $fields, true ) ) {
    			$data[ WP_REST_Search_Controller::PROP_TITLE ] = get_post_format_string( $id );
    		}

    		if ( in_array( WP_REST_Search_Controller::PROP_URL, $fields, true ) ) {
    			$data[ WP_REST_Search_Controller::PROP_URL ] = get_post_format_link( $id );
    		}

    		if ( in_array( WP_REST_Search_Controller::PROP_TYPE, $fields, true ) ) {
    			$data[ WP_REST_Search_Controller::PROP_TYPE ] = $this->type;
    		}

    		return $data;
    	}

    	/**
    	 * Prepares links for the search result.
    	 *
    	 * @since 5.6.0
    	 *
    	 * @param string $id Item ID, the post format slug.
    	 * @return array Links for the given item.
    	 */
    	public function prepare_item_links( $id ) {
    		return array();
    	}
    }
    ```

[View all references](https://developer.wordpress.org/reference/files/wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php/)
[View on Trac](https://core.trac.wordpress.org/browser/tags/6.9.4/src/wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php#L17)
[View on GitHub](https://github.com/WordPress/wordpress-develop/blob/6.9.4/src/wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php#L17-L138)

## 󠀁[Related](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#related)󠁿

| Uses | Description | 
| [WP_REST_Search_Handler](https://developer.wordpress.org/reference/classes/wp_rest_search_handler/)`wp-includes/rest-api/search/class-wp-rest-search-handler.php` |

Core base class representing a search handler for an object type in the REST API.

  |

## 󠀁[Changelog](https://developer.wordpress.org/reference/classes/wp_rest_post_format_search_handler/?output_format=md#changelog)󠁿

| Version | Description | 
| [5.6.0](https://developer.wordpress.org/reference/since/5.6.0/) | Introduced. |

## User Contributed Notes

You must [log in](https://login.wordpress.org/?redirect_to=https%3A%2F%2Fdeveloper.wordpress.org%2Freference%2Fclasses%2Fwp_rest_post_format_search_handler%2F)
before being able to contribute a note or feedback.