WP_REST_Global_Styles_Revisions_Controller::prepare_item_for_response( WP_Post $post, WP_REST_Request $request ): WP_REST_Response|WP_Error

Compatibility

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

Parameters

$postWP_Post

Post revision object.

$requestWP_REST_Request

Request object.

Return value

WP_REST_Response|WP_Error

Response object.

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

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

Instructions

111–176

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

1

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

What it touches

• hookthird-party callbacksdo_action()one call below WP_REST_Global_Styles_Revisions_Controller::prepare_item_for_response()

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

Uses · 15

• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_register_block_style_variations_from_theme_json_partials()Registers block style variations read in from theme.json partials.
• 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).
• WP_REST_Response::__construct()
• WP_REST_Global_Styles_Revisions_Controller::get_parent()
• WP_REST_Global_Styles_Revisions_Controller::get_decoded_global_styles_json()Returns decoded JSON from post content string, or a 404 if not found.
• WP_REST_Global_Styles_Revisions_Controller::get_fields_for_response()
• WP_Theme_JSON_Resolver::get_style_variations()Returns the style variations defined by the theme.
• WP_Theme_JSON::__construct()Constructor.
• stdClass::__construct()
• WP_REST_Global_Styles_Revisions_Controller::prepare_date_response()

Used by · 1

• WP_REST_Global_Styles_Revisions_Controller::get_items()Returns paginated revisions of the given global styles config custom post type.

Source code

View on Trac ↗View on GitHub ↗

297	public function prepare_item_for_response( $post, $request ) {298		// Don't prepare the response body for HEAD requests.299		if ( $request->is_method( 'HEAD' ) ) {300			return new WP_REST_Response( array() );301		}302 303		$parent               = $this->get_parent( $request['parent'] );304		$global_styles_config = $this->get_decoded_global_styles_json( $post->post_content );305 306		if ( is_wp_error( $global_styles_config ) ) {307			return $global_styles_config;308		}309 310		$fields     = $this->get_fields_for_response( $request );311		$data       = array();312		$theme_json = null;313 314		if ( ! empty( $global_styles_config['styles'] ) || ! empty( $global_styles_config['settings'] ) ) {315			/*316			 * Register block style variations from the theme data.317			 * This is required so the variations pass sanitization of theme.json data.318			 */319			if ( ! empty( $global_styles_config['styles']['blocks'] ) ) {320				$variations = WP_Theme_JSON_Resolver::get_style_variations( 'block' );321				wp_register_block_style_variations_from_theme_json_partials( $variations );322			}323 324			$theme_json           = new WP_Theme_JSON( $global_styles_config, 'custom' );325			$global_styles_config = $theme_json->get_raw_data();326			if ( rest_is_field_included( 'settings', $fields ) ) {327				$data['settings'] = ! empty( $global_styles_config['settings'] ) ? $global_styles_config['settings'] : new stdClass();328			}329			if ( rest_is_field_included( 'styles', $fields ) ) {330				$data['styles'] = ! empty( $global_styles_config['styles'] ) ? $global_styles_config['styles'] : new stdClass();331			}332		}333 334		if ( rest_is_field_included( 'author', $fields ) ) {335			$data['author'] = (int) $post->post_author;336		}337 338		if ( rest_is_field_included( 'date', $fields ) ) {339			$data['date'] = $this->prepare_date_response( $post->post_date_gmt, $post->post_date );340		}341 342		if ( rest_is_field_included( 'date_gmt', $fields ) ) {343			$data['date_gmt'] = $this->prepare_date_response( $post->post_date_gmt );344		}345 346		if ( rest_is_field_included( 'id', $fields ) ) {347			$data['id'] = (int) $post->ID;348		}349 350		if ( rest_is_field_included( 'modified', $fields ) ) {351			$data['modified'] = $this->prepare_date_response( $post->post_modified_gmt, $post->post_modified );352		}353 354		if ( rest_is_field_included( 'modified_gmt', $fields ) ) {355			$data['modified_gmt'] = $this->prepare_date_response( $post->post_modified_gmt );356		}357 358		if ( rest_is_field_included( 'parent', $fields ) ) {359			$data['parent'] = (int) $parent->ID;360		}361 362		$context             = ! empty( $request['context'] ) ? $request['context'] : 'view';363		$data                = $this->add_additional_fields_to_object( $data, $request );364		$data                = $this->filter_response_by_context( $data, $context );365		$response            = rest_ensure_response( $data );366		$resolved_theme_uris = WP_Theme_JSON_Resolver::get_resolved_theme_uris( $theme_json );367 368		if ( ! empty( $resolved_theme_uris ) ) {369			$response->add_links(370				array(371					'https://api.w.org/theme-file' => $resolved_theme_uris,372				)373			);374		}375 376		return $response;

Changelog

Introduced in 6.3.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-global-styles-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.