WP_REST_Search_Handler::prepare_item() WordPress Method

This method is used to prepare an individual item for search results. It is used to setup the title, excerpt, and permalink for each search result.

WP_REST_Search_Handler::prepare_item( int|string $id, array $fields ) #

Prepares the search result for a given ID.


Parameters

$id

(int|string)(Required)Item ID.

$fields

(array)(Required)Fields to include for the item.


Top ↑

Return

(array) Associative array containing all fields for the item.


Top ↑

Source

File: wp-includes/rest-api/search/class-wp-rest-search-handler.php

	abstract public function prepare_item( $id, array $fields );

Top ↑

Changelog

Changelog
VersionDescription
5.6.0The $id parameter can accept a string.
5.0.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.