WP_REST_Themes_Controller::prepare_item_for_response( WP_Theme $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_Theme

Theme object.

$requestWP_REST_Request

Request object.

Return value

WP_REST_Response

Response object.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

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

Instructions

81–140

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

Plugin surface

1 hook

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

Called by

2

2 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

Further down the call graph this can also reach option, cache, serialize, transient and query. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 972 distinct outcomes

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

One hook fires while WP_REST_Themes_Controller::prepare_item_for_response() runs, in this order:

1. 1
   apply_filters( rest_prepare_theme )filterline 369 (+136 into the body)

   Filters theme data returned from the REST API.

Uses · 14

• 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.
• wp_get_theme()Gets a WP_Theme object for a theme.
• get_registered_theme_features()Gets the list of registered theme features.
• current_theme_supports()Checks a theme's support for a given feature.
• get_theme_support()Gets the theme support arguments passed when registering that support.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• get_stylesheet_directory_uri()Retrieves stylesheet directory URI for the active theme.
• get_template_directory_uri()Retrieves template directory URI for the active theme.
• rest_ensure_response()Ensures a REST response is a response object (for consistency).
• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_REST_Themes_Controller::get_fields_for_response()
• WP_REST_Themes_Controller::is_same_theme()Helper function to compare two themes.

Used by · 2

• WP_REST_Themes_Controller::get_item()Retrieves a single theme.
• WP_REST_Themes_Controller::get_items()Retrieves a collection of themes.

Source code

View on Trac ↗View on GitHub ↗

233	public function prepare_item_for_response( $item, $request ) {234		// Restores the more descriptive, specific name for use within this method.235		$theme = $item;236 237		$fields = $this->get_fields_for_response( $request );238		$data   = array();239 240		if ( rest_is_field_included( 'stylesheet', $fields ) ) {241			$data['stylesheet'] = $theme->get_stylesheet();242		}243 244		if ( rest_is_field_included( 'template', $fields ) ) {245			/**246			 * Use the get_template() method, not the 'Template' header, for finding the template.247			 * The 'Template' header is only good for what was written in the style.css, while248			 * get_template() takes into account where WordPress actually located the theme and249			 * whether it is actually valid.250			 */251			$data['template'] = $theme->get_template();252		}253 254		$plain_field_mappings = array(255			'requires_php' => 'RequiresPHP',256			'requires_wp'  => 'RequiresWP',257			'textdomain'   => 'TextDomain',258			'version'      => 'Version',259		);260 261		foreach ( $plain_field_mappings as $field => $header ) {262			if ( rest_is_field_included( $field, $fields ) ) {263				$data[ $field ] = $theme->get( $header );264			}265		}266 267		if ( rest_is_field_included( 'screenshot', $fields ) ) {268			// Using $theme->get_screenshot() with no args to get absolute URL.269			$data['screenshot'] = $theme->get_screenshot() ? $theme->get_screenshot() : '';270		}271 272		$rich_field_mappings = array(273			'author'      => 'Author',274			'author_uri'  => 'AuthorURI',275			'description' => 'Description',276			'name'        => 'Name',277			'tags'        => 'Tags',278			'theme_uri'   => 'ThemeURI',279		);280 281		foreach ( $rich_field_mappings as $field => $header ) {282			if ( rest_is_field_included( "{$field}.raw", $fields ) ) {283				$data[ $field ]['raw'] = $theme->display( $header, false, true );284			}285 286			if ( rest_is_field_included( "{$field}.rendered", $fields ) ) {287				$data[ $field ]['rendered'] = $theme->display( $header );288			}289		}290 291		$current_theme = wp_get_theme();292		if ( rest_is_field_included( 'status', $fields ) ) {293			$data['status'] = ( $this->is_same_theme( $theme, $current_theme ) ) ? 'active' : 'inactive';294		}295 296		if ( rest_is_field_included( 'theme_supports', $fields ) && $this->is_same_theme( $theme, $current_theme ) ) {297			foreach ( get_registered_theme_features() as $feature => $config ) {298				if ( ! is_array( $config['show_in_rest'] ) ) {299					continue;300				}301 302				$name = $config['show_in_rest']['name'];303 304				if ( ! rest_is_field_included( "theme_supports.{$name}", $fields ) ) {305					continue;306				}307 308				if ( ! current_theme_supports( $feature ) ) {309					$data['theme_supports'][ $name ] = $config['show_in_rest']['schema']['default'];310					continue;311				}312

Changelog

Introduced in 5.0.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-themes-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.