WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Post_Format_Search_Handler::prepare_item()

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

In this article

Back to top

Prepares the search result for a given post format.

Parameters

$idstringrequired
Item ID, the post format slug.
$fieldsarrayrequired
Fields to include for the item.

Return

array Associative array containing fields for the post format based on the $fields parameter.
  • id string
    Optional. Post format slug.
  • title string
    Optional. Post format name.
  • url string
    Optional. Post format permalink URL.
  • type string
    Optional. String 'post-format'.

Source

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

View all references View on Trac View on GitHub

UsesDescription
get_post_format_string()wp-includes/post-formats.php

Returns a pretty, translated version of a post format slug

get_post_format_link()wp-includes/post-formats.php

Returns a link to a post format index.

Changelog

VersionDescription
5.6.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.