WP_REST_Posts_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 object.

$requestWP_REST_Request

Request object.

Return value

WP_REST_Response

Response object.

Performance profile

How much work a call to WP_REST_Posts_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

2

Executed per call on PHP 8.5. The body compiles to 656.

Plugin surface

5 hooks

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

Called by

6

6 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
• optionoption read or writeget_option()called directly
• cacheobject cachewp_cache_get()one call below WP_REST_Posts_Controller::prepare_item_for_response()
• serializeserialisationmaybe_unserialize()one call below WP_REST_Posts_Controller::prepare_item_for_response()
• querycontent queryget_post()one call below WP_REST_Posts_Controller::prepare_item_for_response()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 1 distinct outcome

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

Hooks and filters fired · 5

5 hooks fire while WP_REST_Posts_Controller::prepare_item_for_response() runs, in this order:

1. 1
   apply_filters( get_the_guid )filterline 1862 (+39 into the body)

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

2. 2
   apply_filters( the_content )filterline 1939 (+116 into the body)

   Filters the post content.

3. 3
   apply_filters( get_the_excerpt )filterline 1963 (+140 into the body)

   Filters the retrieved post excerpt.

4. 4
   apply_filters( the_excerpt )filterline 1966 (+143 into the body)

   Filters the displayed post excerpt.

5. 5
   apply_filters( rest_prepare_{$this->post_type} )filterline 2114 (+291 into the body)

   Filters the post data for a REST API response.

Uses · 31

• setup_postdata()Set up global post data.
• 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_gmt_from_date()Given a date in the timezone of the site, returns that date in UTC.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_option()Retrieves an option value based on an option name.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• add_filter()Adds a callback function to a filter hook.
• get_the_title()Retrieves the post title.
• remove_filter()Removes a callback function from a filter hook.
• post_password_required()Determines whether the post requires password and whether a correct password has been provided.
• block_version()Returns the current version of the block format that the content string is using.
• get_post_thumbnail_id()Retrieves the post thumbnail ID.

Used by · 6

• WP_REST_Attachments_Controller::prepare_item_for_response()Prepares a single attachment output for response.
• WP_REST_Posts_Controller::create_item()Creates a single post.
• WP_REST_Posts_Controller::delete_item()Deletes a single post.
• WP_REST_Posts_Controller::get_item()Retrieves a single post.
• WP_REST_Posts_Controller::get_items()Retrieves a collection of posts.
• WP_REST_Posts_Controller::update_item()Updates a single post.

Source code

View on Trac ↗View on GitHub ↗

1823	public function prepare_item_for_response( $item, $request ) {1824		// Restores the more descriptive, specific name for use within this method.1825		$post = $item;1826 1827		$GLOBALS['post'] = $post;1828 1829		setup_postdata( $post );1830 1831		$fields = $this->get_fields_for_response( $request );1832 1833		// Base fields for every post.1834		$data = array();1835 1836		if ( rest_is_field_included( 'id', $fields ) ) {1837			$data['id'] = $post->ID;1838		}1839 1840		if ( rest_is_field_included( 'date', $fields ) ) {1841			$data['date'] = $this->prepare_date_response( $post->post_date_gmt, $post->post_date );1842		}1843 1844		if ( rest_is_field_included( 'date_gmt', $fields ) ) {1845			/*1846			 * For drafts, `post_date_gmt` may not be set, indicating that the date1847			 * of the draft should be updated each time it is saved (see #38883).1848			 * In this case, shim the value based on the `post_date` field1849			 * with the site's timezone offset applied.1850			 */1851			if ( '0000-00-00 00:00:00' === $post->post_date_gmt ) {1852				$post_date_gmt = get_gmt_from_date( $post->post_date );1853			} else {1854				$post_date_gmt = $post->post_date_gmt;1855			}1856			$data['date_gmt'] = $this->prepare_date_response( $post_date_gmt );1857		}1858 1859		if ( rest_is_field_included( 'guid', $fields ) ) {1860			$data['guid'] = array(1861				/** This filter is documented in wp-includes/post-template.php */1862				'rendered' => apply_filters( 'get_the_guid', $post->guid, $post->ID ),1863				'raw'      => $post->guid,1864			);1865		}1866 1867		if ( rest_is_field_included( 'modified', $fields ) ) {1868			$data['modified'] = $this->prepare_date_response( $post->post_modified_gmt, $post->post_modified );1869		}1870 1871		if ( rest_is_field_included( 'modified_gmt', $fields ) ) {1872			/*1873			 * For drafts, `post_modified_gmt` may not be set (see `post_date_gmt` comments1874			 * above). In this case, shim the value based on the `post_modified` field1875			 * with the site's timezone offset applied.1876			 */1877			if ( '0000-00-00 00:00:00' === $post->post_modified_gmt ) {1878				$post_modified_gmt = gmdate( 'Y-m-d H:i:s', strtotime( $post->post_modified ) - (int) ( (float) get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) );1879			} else {1880				$post_modified_gmt = $post->post_modified_gmt;1881			}1882			$data['modified_gmt'] = $this->prepare_date_response( $post_modified_gmt );1883		}1884 1885		if ( rest_is_field_included( 'password', $fields ) ) {1886			$data['password'] = $post->post_password;1887		}1888 1889		if ( rest_is_field_included( 'slug', $fields ) ) {1890			$data['slug'] = $post->post_name;1891		}1892 1893		if ( rest_is_field_included( 'status', $fields ) ) {1894			$data['status'] = $post->post_status;1895		}1896 1897		if ( rest_is_field_included( 'type', $fields ) ) {1898			$data['type'] = $post->post_type;1899		}1900 1901		if ( rest_is_field_included( 'link', $fields ) ) {1902			$data['link'] = get_permalink( $post->ID );

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.7.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-posts-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.