WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_REST_Term_Search_Handler::prepare_item()

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

In this article

Back to top

Prepares the search result for a given term ID.

Parameters

$idintrequired
Term ID.
$fieldsarrayrequired
Fields to include for the term.

Return

array Associative array containing fields for the term based on the $fields parameter.
  • id int
    Optional. Term ID.
  • title string
    Optional. Term name.
  • url string
    Optional. Term permalink URL.
  • type string
    Optional. Term taxonomy name.

Source

public function prepare_item( $id, array $fields ) {
	$term = get_term( $id );

	$data = array();

	if ( in_array( WP_REST_Search_Controller::PROP_ID, $fields, true ) ) {
		$data[ WP_REST_Search_Controller::PROP_ID ] = (int) $id;
	}
	if ( in_array( WP_REST_Search_Controller::PROP_TITLE, $fields, true ) ) {
		$data[ WP_REST_Search_Controller::PROP_TITLE ] = $term->name;
	}
	if ( in_array( WP_REST_Search_Controller::PROP_URL, $fields, true ) ) {
		$data[ WP_REST_Search_Controller::PROP_URL ] = get_term_link( $id );
	}
	if ( in_array( WP_REST_Search_Controller::PROP_TYPE, $fields, true ) ) {
		$data[ WP_REST_Search_Controller::PROP_TYPE ] = $term->taxonomy;
	}

	return $data;
}

View all references View on Trac View on GitHub

UsesDescription
get_term_link()wp-includes/taxonomy.php

Generates a permalink for a taxonomy term archive.

get_term()wp-includes/taxonomy.php

Gets all term data from database by term ID.

Changelog

VersionDescription
5.6.0Introduced.

User Contributed Notes

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