WP_REST_Post_Format_Search_Handler::search_items() WordPress Method
The search_items() method is used to search for post formats. It accepts two arguments: the search term and the number of results to return. The method returns an array of post format objects, each of which contains the following information: -The post format ID -The post format slug -The post format label The search_items() method is used to search for post formats. It accepts two arguments: the search term and the number of results to return. The method returns an array of post format objects, each of which contains the following information: -The post format ID -The post format slug -The post format label
WP_REST_Post_Format_Search_Handler::search_items( WP_REST_Request $request ) #
Searches the object type content for a given search request.
Parameters
- $request
(WP_REST_Request)(Required)Full REST request.
Return
(array) Associative array containing an WP_REST_Search_Handler::RESULT_IDS
containing an array of found IDs and WP_REST_Search_Handler::RESULT_TOTAL
containing the total count for the matching search results.
Source
File: wp-includes/rest-api/search/class-wp-rest-post-format-search-handler.php
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 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 ), ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
5.6.0 | Introduced. |