WP_Theme_JSON::__construct( array $theme_json = array('version' => self::LATEST_SCHEMA), string $origin = 'theme' )

Compatibility

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

Parameters

$theme_jsonarrayoptional

A structure that follows the theme.json schema.Default: array('version' => self::LATEST_SCHEMA)

$originstringoptional

What source of data this object represents.
One of 'blocks', 'default', 'theme', or 'custom'. Default 'theme'.Default: 'theme'

Performance profile

How much work a call to WP_Theme_JSON::__construct() 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

88–136

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

14

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

What one call costs · 4 distinct outcomes

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

Uses · 11

• _wp_array_get()Accesses an array in depth based on a path of keys.
• _wp_array_set()Sets an array in depth based on a path of keys.
• WP_Theme_JSON_Schema::migrate()Function that migrates a given theme.json structure to the last version.
• static::get_blocks_metadata()
• static::get_valid_block_style_variations()
• static::unwrap_shared_block_style_variations()
• static::sanitize()
• static::maybe_opt_in_into_settings()
• static::get_setting_nodes()
• static::compute_spacing_sizes()
• static::merge_spacing_sizes()

Used by · 14

• WP_REST_Global_Styles_Controller::get_theme_items()Returns the given theme global styles variations.
• WP_REST_Global_Styles_Controller::prepare_item_for_response()Prepare a global styles config output for response.
• WP_REST_Global_Styles_Revisions_Controller::prepare_item_for_response()Prepares the revision for the REST response.
• WP_Theme_JSON_Data::__construct()Constructor.
• WP_Theme_JSON_Data::update_with()Updates the theme.json with the the given data.
• WP_Theme_JSON_Resolver::get_block_data()Gets the styles for blocks from the block.json file.
• WP_Theme_JSON_Resolver::get_core_data()Returns core's origin config.
• WP_Theme_JSON_Resolver::get_merged_data()Returns the data merged from multiple origins.
• WP_Theme_JSON_Resolver::get_style_variations()Returns the style variations defined by the theme.
• WP_Theme_JSON_Resolver::get_theme_data()Returns the theme's data.
• WP_Theme_JSON_Resolver::get_user_data()Returns the user's origin config.
• WP_Theme_JSON_Resolver::resolve_theme_file_uris()Resolves relative paths in theme.json styles to theme absolute paths and merges them with incoming theme JSON.

Source code

View on Trac ↗View on GitHub ↗

770	public function __construct( $theme_json = array( 'version' => self::LATEST_SCHEMA ), $origin = 'theme' ) {771		if ( ! in_array( $origin, static::VALID_ORIGINS, true ) ) {772			$origin = 'theme';773		}774 775		$this->theme_json    = WP_Theme_JSON_Schema::migrate( $theme_json, $origin );776		$blocks_metadata     = static::get_blocks_metadata();777		$valid_block_names   = array_keys( $blocks_metadata );778		$valid_element_names = array_keys( static::ELEMENTS );779		$valid_variations    = static::get_valid_block_style_variations( $blocks_metadata );780		$this->theme_json    = static::unwrap_shared_block_style_variations( $this->theme_json, $valid_variations );781		$this->theme_json    = static::sanitize( $this->theme_json, $valid_block_names, $valid_element_names, $valid_variations );782		$this->theme_json    = static::maybe_opt_in_into_settings( $this->theme_json );783 784		// Internally, presets are keyed by origin.785		$nodes = static::get_setting_nodes( $this->theme_json );786		foreach ( $nodes as $node ) {787			foreach ( static::PRESETS_METADATA as $preset_metadata ) {788				$path = $node['path'];789				foreach ( $preset_metadata['path'] as $subpath ) {790					$path[] = $subpath;791				}792				$preset = _wp_array_get( $this->theme_json, $path, null );793				if ( null !== $preset ) {794					// If the preset is not already keyed by origin.795					if ( isset( $preset[0] ) || empty( $preset ) ) {796						_wp_array_set( $this->theme_json, $path, array( $origin => $preset ) );797					}798				}799			}800		}801 802		// In addition to presets, spacingScale (which generates presets) is also keyed by origin.803		$scale_path    = array( 'settings', 'spacing', 'spacingScale' );804		$spacing_scale = _wp_array_get( $this->theme_json, $scale_path, null );805		if ( null !== $spacing_scale ) {806			// If the spacingScale is not already keyed by origin.807			if ( empty( array_intersect( array_keys( $spacing_scale ), static::VALID_ORIGINS ) ) ) {808				_wp_array_set( $this->theme_json, $scale_path, array( $origin => $spacing_scale ) );809			}810		}811 812		// Pre-generate the spacingSizes from spacingScale.813		$scale_path    = array( 'settings', 'spacing', 'spacingScale', $origin );814		$spacing_scale = _wp_array_get( $this->theme_json, $scale_path, null );815		if ( isset( $spacing_scale ) ) {816			$sizes_path           = array( 'settings', 'spacing', 'spacingSizes', $origin );817			$spacing_sizes        = _wp_array_get( $this->theme_json, $sizes_path, array() );818			$spacing_scale_sizes  = static::compute_spacing_sizes( $spacing_scale );819			$merged_spacing_sizes = static::merge_spacing_sizes( $spacing_scale_sizes, $spacing_sizes );820			_wp_array_set( $this->theme_json, $sizes_path, $merged_spacing_sizes );821		}822	}

Changelog

Introduced in 5.8.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.9.7 tag, from src/wp-includes/class-wp-theme-json.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.