WP_REST_Revisions_Controller::prepare_item_for_response( WP_Post $item, WP_REST_Request $request ): WP_REST_Response

Parameters

$itemWP_Post

Post revision object.

$requestWP_REST_Request

Request object.

Return

WP_REST_Response

Response object.

Hooks fired · 4

4 hooks fire while WP_REST_Revisions_Controller::prepare_item_for_response() runs, in this order:

1. 1
   apply_filters( rest_prepare_revision )filterline 616 (+11 into the body)

   Filters a revision returned from the REST API.

2. 2
   apply_filters( get_the_guid )filterline 659 (+54 into the body)

   Filters the Global Unique Identifier (guid) of the post.

3. 3
   apply_filters( the_content )filterline 683 (+78 into the body)

   Filters the post content.

4. 4
   apply_filters( rest_prepare_revision )filterline 720 (+115 into the body)

   Filters a revision returned from the REST API.

Uses · 13

• setup_postdata()Set up global post data.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• rest_is_field_included()Given an array of fields to include in a response, some of which may be `nested.fields`, determine whether the provided field should be included in the response body.
• get_the_title()Retrieves the post title.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• rest_url()Retrieves the URL to a REST endpoint.
• rest_get_route_for_post()Gets the REST API route for a post.
• WP_REST_Response::__construct()
• WP_REST_Revisions_Controller::get_fields_for_response()
• WP_REST_Revisions_Controller::prepare_date_response()Checks the post_date_gmt or modified_gmt and prepare any post or modified date for single post output.
• WP_REST_Revisions_Controller::prepare_excerpt_response()Checks the post excerpt and prepare it for single post output.
• WP_REST_Revisions_Controller::add_additional_fields_to_object()

Used by · 3

• WP_REST_Revisions_Controller::delete_item()Deletes a single revision.
• WP_REST_Revisions_Controller::get_item()Retrieves one revision from the collection.
• WP_REST_Revisions_Controller::get_items()Gets a collection of revisions.

Source

View on Trac ↗View on GitHub ↗

605	public function prepare_item_for_response( $item, $request ) {606		// Restores the more descriptive, specific name for use within this method.607		$post = $item;608 609		$GLOBALS['post'] = $post;610 611		setup_postdata( $post );612 613		// Don't prepare the response body for HEAD requests.614		if ( $request->is_method( 'HEAD' ) ) {615			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php */616			return apply_filters( 'rest_prepare_revision', new WP_REST_Response( array() ), $post, $request );617		}618 619		$fields = $this->get_fields_for_response( $request );620		$data   = array();621 622		if ( in_array( 'author', $fields, true ) ) {623			$data['author'] = (int) $post->post_author;624		}625 626		if ( in_array( 'date', $fields, true ) ) {627			$data['date'] = $this->prepare_date_response( $post->post_date_gmt, $post->post_date );628		}629 630		if ( in_array( 'date_gmt', $fields, true ) ) {631			$data['date_gmt'] = $this->prepare_date_response( $post->post_date_gmt );632		}633 634		if ( in_array( 'id', $fields, true ) ) {635			$data['id'] = $post->ID;636		}637 638		if ( in_array( 'modified', $fields, true ) ) {639			$data['modified'] = $this->prepare_date_response( $post->post_modified_gmt, $post->post_modified );640		}641 642		if ( in_array( 'modified_gmt', $fields, true ) ) {643			$data['modified_gmt'] = $this->prepare_date_response( $post->post_modified_gmt );644		}645 646		if ( in_array( 'parent', $fields, true ) ) {647			$data['parent'] = (int) $post->post_parent;648		}649 650		if ( in_array( 'slug', $fields, true ) ) {651			$data['slug'] = $post->post_name;652		}653 654		if ( rest_is_field_included( 'guid', $fields ) ) {655			$data['guid'] = array();656		}657		if ( rest_is_field_included( 'guid.rendered', $fields ) ) {658			/** This filter is documented in wp-includes/post-template.php */659			$data['guid']['rendered'] = apply_filters( 'get_the_guid', $post->guid, $post->ID );660		}661		if ( rest_is_field_included( 'guid.raw', $fields ) ) {662			$data['guid']['raw'] = $post->guid;663		}664 665		if ( rest_is_field_included( 'title', $fields ) ) {666			$data['title'] = array();667		}668		if ( rest_is_field_included( 'title.raw', $fields ) ) {669			$data['title']['raw'] = $post->post_title;670		}671		if ( rest_is_field_included( 'title.rendered', $fields ) ) {672			$data['title']['rendered'] = get_the_title( $post->ID );673		}674 675		if ( rest_is_field_included( 'content', $fields ) ) {676			$data['content'] = array();677		}678		if ( rest_is_field_included( 'content.raw', $fields ) ) {679			$data['content']['raw'] = $post->post_content;680		}681		if ( rest_is_field_included( 'content.rendered', $fields ) ) {682			/** This filter is documented in wp-includes/post-template.php */683			$data['content']['rendered'] = apply_filters( 'the_content', $post->post_content );684		}

History

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.0.4 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.