WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Post_Search_Handler::prepare_item()

WP_REST_Post_Search_Handler::prepare_item( int $id, array $fields ): array

In this article

Back to top

Prepares the search result for a given post ID.

Parameters

$idintrequired
Post ID.
$fieldsarrayrequired
Fields to include for the post.

Return

array Associative array containing fields for the post based on the $fields parameter.
  • id int
    Optional. Post ID.
  • title string
    Optional. Post title.
  • url string
    Optional. Post permalink URL.
  • type string
    Optional. Post type.

Source

public function prepare_item( $id, array $fields ) {
	$post = get_post( $id );

	$data = array();

	if ( in_array( WP_REST_Search_Controller::PROP_ID, $fields, true ) ) {
		$data[ WP_REST_Search_Controller::PROP_ID ] = (int) $post->ID;
	}

	if ( in_array( WP_REST_Search_Controller::PROP_TITLE, $fields, true ) ) {
		if ( post_type_supports( $post->post_type, 'title' ) ) {
			add_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
			$data[ WP_REST_Search_Controller::PROP_TITLE ] = get_the_title( $post->ID );
			remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
		} else {
			$data[ WP_REST_Search_Controller::PROP_TITLE ] = '';
		}
	}

	if ( in_array( WP_REST_Search_Controller::PROP_URL, $fields, true ) ) {
		$data[ WP_REST_Search_Controller::PROP_URL ] = get_permalink( $post->ID );
	}

	if ( in_array( WP_REST_Search_Controller::PROP_TYPE, $fields, true ) ) {
		$data[ WP_REST_Search_Controller::PROP_TYPE ] = $this->type;
	}

	if ( in_array( WP_REST_Search_Controller::PROP_SUBTYPE, $fields, true ) ) {
		$data[ WP_REST_Search_Controller::PROP_SUBTYPE ] = $post->post_type;
	}

	return $data;
}

View all references View on Trac View on GitHub

UsesDescription
get_the_title()wp-includes/post-template.php

Retrieves the post title.

post_type_supports()wp-includes/post.php

Checks a post type’s support for a given feature.

get_permalink()wp-includes/link-template.php

Retrieves the full permalink for the current post or post ID.

add_filter()wp-includes/plugin.php

Adds a callback function to a filter hook.

remove_filter()wp-includes/plugin.php

Removes a callback function from a filter hook.

get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

Show 4 moreShow less

Changelog

VersionDescription
5.0.0Introduced.

User Contributed Notes

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