WP_REST_Terms_Controller::prepare_item_for_response() │ public │ WP 4.7.0

Prepares a single term output for response.

Method of the class: WP_REST_Terms_Controller{}

Return

WP_REST_Response. Response object.

Usage

$WP_REST_Terms_Controller = new WP_REST_Terms_Controller();
$WP_REST_Terms_Controller->prepare_item_for_response( $item, $request );

$item(WP_Term) (required)

Term object.

$request(WP_REST_Request) (required)

Request object.

Changelog

WP_REST_Terms_Controller::prepare_item_for_response() WP REST Terms Controller::prepare item for response code ^{WP 6.6.1}

public function prepare_item_for_response( $item, $request ) {

	$fields = $this->get_fields_for_response( $request );
	$data   = array();

	if ( in_array( 'id', $fields, true ) ) {
		$data['id'] = (int) $item->term_id;
	}

	if ( in_array( 'count', $fields, true ) ) {
		$data['count'] = (int) $item->count;
	}

	if ( in_array( 'description', $fields, true ) ) {
		$data['description'] = $item->description;
	}

	if ( in_array( 'link', $fields, true ) ) {
		$data['link'] = get_term_link( $item );
	}

	if ( in_array( 'name', $fields, true ) ) {
		$data['name'] = $item->name;
	}

	if ( in_array( 'slug', $fields, true ) ) {
		$data['slug'] = $item->slug;
	}

	if ( in_array( 'taxonomy', $fields, true ) ) {
		$data['taxonomy'] = $item->taxonomy;
	}

	if ( in_array( 'parent', $fields, true ) ) {
		$data['parent'] = (int) $item->parent;
	}

	if ( in_array( 'meta', $fields, true ) ) {
		$data['meta'] = $this->meta->get_value( $item->term_id, $request );
	}

	$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
	$data    = $this->add_additional_fields_to_object( $data, $request );
	$data    = $this->filter_response_by_context( $data, $context );

	$response = rest_ensure_response( $data );

	if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {
		$response->add_links( $this->prepare_links( $item ) );
	}

	/**
	 * Filters the term data for a REST API response.
	 *
	 * The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
	 *
	 * Possible hook names include:
	 *
	 *  - `rest_prepare_category`
	 *  - `rest_prepare_post_tag`
	 *
	 * Allows modification of the term data right before it is returned.
	 *
	 * @since 4.7.0
	 *
	 * @param WP_REST_Response  $response  The response object.
	 * @param WP_Term           $item      The original term object.
	 * @param WP_REST_Request   $request   Request used to generate the response.
	 */
	return apply_filters( "rest_prepare_{$this->taxonomy}", $response, $item, $request );
}