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

Parameters

$itemWP_Post

Post object.

$requestWP_REST_Request

Request object.

Return

WP_REST_Response

Response object.

Hooks fired · 6

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

1. 1
   apply_filters( rest_prepare_{$this->post_type} )filterline 1856 (+11 into the body)

   Filters the post data for a REST API response.

2. 2
   apply_filters( get_the_guid )filterline 1890 (+45 into the body)

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

3. 3
   apply_filters( the_content )filterline 1967 (+122 into the body)

   Filters the post content.

4. 4
   apply_filters( get_the_excerpt )filterline 1991 (+146 into the body)

   Filters the retrieved post excerpt.

5. 5
   apply_filters( the_excerpt )filterline 1994 (+149 into the body)

   Filters the displayed post excerpt.

6. 6
   apply_filters( rest_prepare_{$this->post_type} )filterline 2142 (+297 into the body)

   Filters the post data for a REST API response.

Uses · 32

• 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_gmt_from_date()Given a date in the timezone of the site, returns that date in UTC.
• 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

View on Trac ↗View on GitHub ↗

1845	public function prepare_item_for_response( $item, $request ) {1846		// Restores the more descriptive, specific name for use within this method.1847		$post = $item;1848 1849		$GLOBALS['post'] = $post;1850 1851		setup_postdata( $post );1852 1853		// Don't prepare the response body for HEAD requests.1854		if ( $request->is_method( 'HEAD' ) ) {1855			/** This filter is documented in wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php */1856			return apply_filters( "rest_prepare_{$this->post_type}", new WP_REST_Response( array() ), $post, $request );1857		}1858 1859		$fields = $this->get_fields_for_response( $request );1860 1861		// Base fields for every post.1862		$data = array();1863 1864		if ( rest_is_field_included( 'id', $fields ) ) {1865			$data['id'] = $post->ID;1866		}1867 1868		if ( rest_is_field_included( 'date', $fields ) ) {1869			$data['date'] = $this->prepare_date_response( $post->post_date_gmt, $post->post_date );1870		}1871 1872		if ( rest_is_field_included( 'date_gmt', $fields ) ) {1873			/*1874			 * For drafts, `post_date_gmt` may not be set, indicating that the date1875			 * of the draft should be updated each time it is saved (see #38883).1876			 * In this case, shim the value based on the `post_date` field1877			 * with the site's timezone offset applied.1878			 */1879			if ( '0000-00-00 00:00:00' === $post->post_date_gmt ) {1880				$post_date_gmt = get_gmt_from_date( $post->post_date );1881			} else {1882				$post_date_gmt = $post->post_date_gmt;1883			}1884			$data['date_gmt'] = $this->prepare_date_response( $post_date_gmt );1885		}1886 1887		if ( rest_is_field_included( 'guid', $fields ) ) {1888			$data['guid'] = array(1889				/** This filter is documented in wp-includes/post-template.php */1890				'rendered' => apply_filters( 'get_the_guid', $post->guid, $post->ID ),1891				'raw'      => $post->guid,1892			);1893		}1894 1895		if ( rest_is_field_included( 'modified', $fields ) ) {1896			$data['modified'] = $this->prepare_date_response( $post->post_modified_gmt, $post->post_modified );1897		}1898 1899		if ( rest_is_field_included( 'modified_gmt', $fields ) ) {1900			/*1901			 * For drafts, `post_modified_gmt` may not be set (see `post_date_gmt` comments1902			 * above). In this case, shim the value based on the `post_modified` field1903			 * with the site's timezone offset applied.1904			 */1905			if ( '0000-00-00 00:00:00' === $post->post_modified_gmt ) {1906				$post_modified_gmt = gmdate( 'Y-m-d H:i:s', strtotime( $post->post_modified ) - (int) ( (float) get_option( 'gmt_offset' ) * HOUR_IN_SECONDS ) );1907			} else {1908				$post_modified_gmt = $post->post_modified_gmt;1909			}1910			$data['modified_gmt'] = $this->prepare_date_response( $post_modified_gmt );1911		}1912 1913		if ( rest_is_field_included( 'password', $fields ) ) {1914			$data['password'] = $post->post_password;1915		}1916 1917		if ( rest_is_field_included( 'slug', $fields ) ) {1918			$data['slug'] = $post->post_name;1919		}1920 1921		if ( rest_is_field_included( 'status', $fields ) ) {1922			$data['status'] = $post->post_status;1923		}1924

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