WP_REST_Global_Styles_Controller::prepare_item_for_response( WP_Post $post, 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

$postWP_Post

Global Styles post object.

$requestWP_REST_Request

Request object.

Return value

WP_REST_Response

Response object.

Performance profile

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

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

78–166

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

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

Further down the call graph this can also reach option, cache 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 · 72 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Global_Styles_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 · 13

• 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.
• 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.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• WP_Theme_JSON::__construct()Constructor.
• WP_REST_Global_Styles_Controller::get_fields_for_response()
• stdClass::__construct()
• WP_REST_Global_Styles_Controller::add_additional_fields_to_object()
• WP_REST_Global_Styles_Controller::filter_response_by_context()
• WP_REST_Global_Styles_Controller::prepare_links()Prepares links for the request.
• WP_Theme_JSON_Resolver::get_resolved_theme_uris()Resolves relative paths in theme.json styles to theme absolute paths and returns them in an array that can be embedded as the value of `_link` object in REST API responses.

Source code

View on Trac ↗View on GitHub ↗

310	public function prepare_item_for_response( $post, $request ) {311		$raw_config                       = json_decode( $post->post_content, true );312		$is_global_styles_user_theme_json = isset( $raw_config['isGlobalStylesUserThemeJSON'] ) && true === $raw_config['isGlobalStylesUserThemeJSON'];313		$config                           = array();314		$theme_json                       = null;315		if ( $is_global_styles_user_theme_json ) {316			$theme_json = new WP_Theme_JSON( $raw_config, 'custom' );317			$config     = $theme_json->get_raw_data();318		}319 320		// Base fields for every post.321		$fields = $this->get_fields_for_response( $request );322		$data   = array();323 324		if ( rest_is_field_included( 'id', $fields ) ) {325			$data['id'] = $post->ID;326		}327 328		if ( rest_is_field_included( 'title', $fields ) ) {329			$data['title'] = array();330		}331		if ( rest_is_field_included( 'title.raw', $fields ) ) {332			$data['title']['raw'] = $post->post_title;333		}334		if ( rest_is_field_included( 'title.rendered', $fields ) ) {335			add_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );336			add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );337 338			$data['title']['rendered'] = get_the_title( $post->ID );339 340			remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );341			remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );342		}343 344		if ( rest_is_field_included( 'settings', $fields ) ) {345			$data['settings'] = ! empty( $config['settings'] ) && $is_global_styles_user_theme_json ? $config['settings'] : new stdClass();346		}347 348		if ( rest_is_field_included( 'styles', $fields ) ) {349			$data['styles'] = ! empty( $config['styles'] ) && $is_global_styles_user_theme_json ? $config['styles'] : new stdClass();350		}351 352		$context = ! empty( $request['context'] ) ? $request['context'] : 'view';353		$data    = $this->add_additional_fields_to_object( $data, $request );354		$data    = $this->filter_response_by_context( $data, $context );355 356		// Wrap the data in a response object.357		$response = rest_ensure_response( $data );358 359		if ( rest_is_field_included( '_links', $fields ) || rest_is_field_included( '_embedded', $fields ) ) {360			$links = $this->prepare_links( $post->ID );361 362			// Only return resolved URIs for get requests to user theme JSON.363			if ( $theme_json ) {364				$resolved_theme_uris = WP_Theme_JSON_Resolver::get_resolved_theme_uris( $theme_json );365				if ( ! empty( $resolved_theme_uris ) ) {366					$links['https://api.w.org/theme-file'] = $resolved_theme_uris;367				}368			}369 370			$response->add_links( $links );371			if ( ! empty( $links['self']['href'] ) ) {372				$actions = $this->get_available_actions( $post, $request );373				$self    = $links['self']['href'];374				foreach ( $actions as $rel ) {375					$response->add_link( $rel, $self );376				}377			}378		}379 380		return $response;381	}

Changelog

Introduced in 5.9.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-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.