WP_REST_Post_Format_Search_Handler::prepare_item() WordPress Method

The WP_REST_Post_Format_Search_Handler::prepare_item() method is used to prepare a search result for a post format. This is used to search through the post formats for a specific term.

WP_REST_Post_Format_Search_Handler::prepare_item( string $id, array $fields ) #

Prepares the search result for a given ID.


Parameters

$id

(string)(Required)Item ID, the post format slug.

$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-post-format-search-handler.php

	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;
	}


Top ↑

Changelog

Changelog
VersionDescription
5.6.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.