[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/rest-api/search/ -> class-wp-rest-post-format-search-handler.php (summary)

REST API: WP_REST_Post_Format_Search_Handler class

File Size: 128 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

WP_REST_Post_Format_Search_Handler:: (4 methods):
  __construct()
  search_items()
  prepare_item()
  prepare_item_links()


Class: WP_REST_Post_Format_Search_Handler  - X-Ref

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

__construct()   X-Ref
Constructor.

since: 5.6.0

search_items( WP_REST_Request $request )   X-Ref
Searches the object type content for a given search request.

param: WP_REST_Request $request Full REST request.
since: 5.6.0
return: array Associative array containing an `WP_REST_Search_Handler::RESULT_IDS` containing

prepare_item( $id, array $fields )   X-Ref
Prepares the search result for a given ID.

param: string $id     Item ID, the post format slug.
param: array  $fields Fields to include for the item.
since: 5.6.0
return: array Associative array containing all fields for the item.

prepare_item_links( $id )   X-Ref
Prepares links for the search result.

param: string $id Item ID, the post format slug.
since: 5.6.0
return: array Links for the given item.



Generated: Wed Jun 23 01:00:04 2021 Cross-referenced by PHPXref 0.7.1