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

141–205

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

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 · 32 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 631 (+25 into the body)

   Filters a revision returned from the REST API.

2. 2
   apply_filters( get_the_guid )filterline 678 (+72 into the body)

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

3. 3
   apply_filters( the_content )filterline 702 (+96 into the body)

   Filters the post content.

4. 4
   apply_filters( rest_prepare_revision )filterline 739 (+133 into the body)

   Filters a revision returned from the REST API.

Uses · 14

• 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::restore_post_data()Restores the global post to its previous value after preparing a revision.
• 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.

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 ↗

606	public function prepare_item_for_response( $item, $request ) {607		/*608		 * Save the previous global post so it can be restored before returning.609		 * Preparing the revision sets up the global post and post data, which610		 * must not leak into the rest of the request (e.g. the autosaves endpoint611		 * is preloaded in the block editor, where a leaked global post can cause612		 * the editor to be initialized with the wrong post).613		 *614		 * Note that $post is intentionally not declared as a global here. It must615		 * remain local to this method so that a filter which reassigns the global616		 * post while the response is being prepared (for example on 'the_content')617		 * cannot change which post the remaining fields are read from.618		 */619		$previous_post = isset( $GLOBALS['post'] ) && $GLOBALS['post'] instanceof WP_Post ? $GLOBALS['post'] : null;620 621		// Restores the more descriptive, specific name for use within this method.622		$post = $item;623 624		$GLOBALS['post'] = $post;625 626		setup_postdata( $post );627 628		// Don't prepare the response body for HEAD requests.629		if ( $request->is_method( 'HEAD' ) ) {630			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php */631			$response = apply_filters( 'rest_prepare_revision', new WP_REST_Response( array() ), $post, $request );632 633			$this->restore_post_data( $previous_post );634 635			return $response;636		}637 638		$fields = $this->get_fields_for_response( $request );639		$data   = array();640 641		if ( in_array( 'author', $fields, true ) ) {642			$data['author'] = (int) $post->post_author;643		}644 645		if ( in_array( 'date', $fields, true ) ) {646			$data['date'] = $this->prepare_date_response( $post->post_date_gmt, $post->post_date );647		}648 649		if ( in_array( 'date_gmt', $fields, true ) ) {650			$data['date_gmt'] = $this->prepare_date_response( $post->post_date_gmt );651		}652 653		if ( in_array( 'id', $fields, true ) ) {654			$data['id'] = $post->ID;655		}656 657		if ( in_array( 'modified', $fields, true ) ) {658			$data['modified'] = $this->prepare_date_response( $post->post_modified_gmt, $post->post_modified );659		}660 661		if ( in_array( 'modified_gmt', $fields, true ) ) {662			$data['modified_gmt'] = $this->prepare_date_response( $post->post_modified_gmt );663		}664 665		if ( in_array( 'parent', $fields, true ) ) {666			$data['parent'] = (int) $post->post_parent;667		}668 669		if ( in_array( 'slug', $fields, true ) ) {670			$data['slug'] = $post->post_name;671		}672 673		if ( rest_is_field_included( 'guid', $fields ) ) {674			$data['guid'] = array();675		}676		if ( rest_is_field_included( 'guid.rendered', $fields ) ) {677			/** This filter is documented in wp-includes/post-template.php */678			$data['guid']['rendered'] = apply_filters( 'get_the_guid', $post->guid, $post->ID );679		}680		if ( rest_is_field_included( 'guid.raw', $fields ) ) {681			$data['guid']['raw'] = $post->guid;682		}683 684		if ( rest_is_field_included( 'title', $fields ) ) {685			$data['title'] = array();

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