WP_REST_Post_Format_Search_Handler::search_items() │ public │ WP 5.6.0

Searches the post formats for a given search request.

Method of the class: WP_REST_Post_Format_Search_Handler{}

Return

Array. Associative array containing found IDs and total count for the matching search results.

Usage

$WP_REST_Post_Format_Search_Handler = new WP_REST_Post_Format_Search_Handler();
$WP_REST_Post_Format_Search_Handler->search_items( $request );

$request(WP_REST_Request) (required)

Full REST request.

Changelog

WP_REST_Post_Format_Search_Handler::search_items() WP REST Post Format Search Handler::search items code ^{WP 6.6.2}

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 $index => $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 ),
	);
}