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

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$itemWP_Post

Post revision object.

$requestWP_REST_Request

Request object.

Return value

WP_REST_Response

Response object.

Performance profile

How much work a call to WP_REST_Revisions_Controller::prepare_item_for_response() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

85–177

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 212.

Plugin surface

3 hooks

Third-party callbacks on 'rest_prepare_revision', 'get_the_guid', 'the_content' run inside this call, and their cost is not bounded by anything here.

Called by

3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• hookthird-party callbacksapply_filters()called directly
• querycontent queryget_post()one call below WP_REST_Revisions_Controller::prepare_item_for_response()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 168 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Revisions_Controller::prepare_item_for_response() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters 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 594 (+11 into the body)

   Filters a revision returned from the REST API.

2. 2
   apply_filters( get_the_guid )filterline 635 (+52 into the body)

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

3. 3
   apply_filters( the_content )filterline 652 (+69 into the body)

   Filters the post content.

4. 4
   apply_filters( rest_prepare_revision )filterline 687 (+104 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.
• get_the_title()Retrieves the post title.
• 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.
• 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 code

View on Trac ↗View on GitHub ↗

583	public function prepare_item_for_response( $item, $request ) {584		// Restores the more descriptive, specific name for use within this method.585		$post = $item;586 587		$GLOBALS['post'] = $post;588 589		setup_postdata( $post );590 591		// Don't prepare the response body for HEAD requests.592		if ( $request->is_method( 'HEAD' ) ) {593			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php */594			return apply_filters( 'rest_prepare_revision', new WP_REST_Response( array() ), $post, $request );595		}596 597		$fields = $this->get_fields_for_response( $request );598		$data   = array();599 600		if ( in_array( 'author', $fields, true ) ) {601			$data['author'] = (int) $post->post_author;602		}603 604		if ( in_array( 'date', $fields, true ) ) {605			$data['date'] = $this->prepare_date_response( $post->post_date_gmt, $post->post_date );606		}607 608		if ( in_array( 'date_gmt', $fields, true ) ) {609			$data['date_gmt'] = $this->prepare_date_response( $post->post_date_gmt );610		}611 612		if ( in_array( 'id', $fields, true ) ) {613			$data['id'] = $post->ID;614		}615 616		if ( in_array( 'modified', $fields, true ) ) {617			$data['modified'] = $this->prepare_date_response( $post->post_modified_gmt, $post->post_modified );618		}619 620		if ( in_array( 'modified_gmt', $fields, true ) ) {621			$data['modified_gmt'] = $this->prepare_date_response( $post->post_modified_gmt );622		}623 624		if ( in_array( 'parent', $fields, true ) ) {625			$data['parent'] = (int) $post->post_parent;626		}627 628		if ( in_array( 'slug', $fields, true ) ) {629			$data['slug'] = $post->post_name;630		}631 632		if ( in_array( 'guid', $fields, true ) ) {633			$data['guid'] = array(634				/** This filter is documented in wp-includes/post-template.php */635				'rendered' => apply_filters( 'get_the_guid', $post->guid, $post->ID ),636				'raw'      => $post->guid,637			);638		}639 640		if ( in_array( 'title', $fields, true ) ) {641			$data['title'] = array(642				'raw'      => $post->post_title,643				'rendered' => get_the_title( $post->ID ),644			);645		}646 647		if ( in_array( 'content', $fields, true ) ) {648 649			$data['content'] = array(650				'raw'      => $post->post_content,651				/** This filter is documented in wp-includes/post-template.php */652				'rendered' => apply_filters( 'the_content', $post->post_content ),653			);654		}655 656		if ( in_array( 'excerpt', $fields, true ) ) {657			$data['excerpt'] = array(658				'raw'      => $post->post_excerpt,659				'rendered' => $this->prepare_excerpt_response( $post->post_excerpt, $post ),660			);661		}662

Changelog

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 6.8.8 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.