WP_Theme_JSON_Resolver::get_theme_data( array $deprecated = array(), array $options = array() ): WP_Theme_JSON

Description

Compatibility

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

Parameters

$deprecatedarrayoptional

Deprecated. Not used.Default: array()

$optionsarrayoptional

Options arguments.Default: array()

• $with_supportsbooldefault: true

  Whether to include theme supports in the data.

Return value

WP_Theme_JSON

Entity that holds theme data.

Performance profile

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

20–227

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

Plugin surface

1 hook

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

Called by

4

4 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 · 215 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Theme_JSON_Resolver::get_theme_data() 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_Theme_JSON_Resolver::get_theme_data() runs, in this order:

1. 1
   apply_filters( wp_theme_json_data_theme )filterline 292 (+48 into the body)

   Filters the data provided by the theme for global styles and settings.

Uses · 17

• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• wp_parse_args()Merges user defined arguments into defaults array.
• wp_get_theme()Gets a WP_Theme object for a theme.
• wp_register_block_style_variations_from_theme_json_partials()Registers block style variations read in from theme.json partials.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• get_classic_theme_supports_block_editor_settings()Returns the classic theme supports settings for block editor.
• wp_theme_has_theme_json()Checks whether a theme or its parent has a theme.json file.
• current_theme_supports()Checks a theme's support for a given feature.
• static::has_same_registered_blocks()
• static::read_json_file()
• static::translate()
• static::get_style_variations()

Used by · 4

• wp_generate_block_templates_export_file()Creates an export of the current templates and template parts from the site editor at the specified path in a ZIP file.
• wp_get_theme_data_custom_templates()Returns the metadata for the custom templates defined by the theme via theme.json.
• wp_get_theme_data_template_parts()Returns the metadata for the template parts defined by the theme.
• wp_get_theme_directory_pattern_slugs()Returns the current theme's wanted patterns (slugs) to be registered from Pattern Directory.

Source code

View on Trac ↗View on GitHub ↗

244	public static function get_theme_data( $deprecated = array(), $options = array() ) {245		if ( ! empty( $deprecated ) ) {246			_deprecated_argument( __METHOD__, '5.9.0' );247		}248 249		$options = wp_parse_args( $options, array( 'with_supports' => true ) );250 251		if ( null === static::$theme || ! static::has_same_registered_blocks( 'theme' ) ) {252			$wp_theme        = wp_get_theme();253			$theme_json_file = $wp_theme->get_file_path( 'theme.json' );254			if ( is_readable( $theme_json_file ) ) {255				$theme_json_data = static::read_json_file( $theme_json_file );256				$theme_json_data = static::translate( $theme_json_data, $wp_theme->get( 'TextDomain' ) );257			} else {258				$theme_json_data = array( 'version' => WP_Theme_JSON::LATEST_SCHEMA );259			}260 261			/*262			 * Register variations defined by theme partials (theme.json files in the styles directory).263			 * This is required so the variations pass sanitization of theme.json data.264			 */265			$variations = static::get_style_variations( 'block' );266			wp_register_block_style_variations_from_theme_json_partials( $variations );267 268			/*269			 * Source variations from the block registry and block style variation files. Then, merge them into the existing theme.json data.270			 *271			 * In case the same style properties are defined in several sources, this is how we should resolve the values,272			 * from higher to lower priority:273			 *274			 * - styles.blocks.blockType.variations from theme.json275			 * - styles.variations from theme.json276			 * - variations from block style variation files277			 * - variations from block styles registry278			 *279			 * See test_add_registered_block_styles_to_theme_data and test_unwraps_block_style_variations.280			 *281			 */282			$theme_json_data = static::inject_variations_from_block_style_variation_files( $theme_json_data, $variations );283			$theme_json_data = static::inject_variations_from_block_styles_registry( $theme_json_data );284 285			/**286			 * Filters the data provided by the theme for global styles and settings.287			 *288			 * @since 6.1.0289			 *290			 * @param WP_Theme_JSON_Data $theme_json Class to access and update the underlying data.291			 */292			$theme_json = apply_filters( 'wp_theme_json_data_theme', new WP_Theme_JSON_Data( $theme_json_data, 'theme' ) );293 294			/*295			 * Backward compatibility for extenders returning a WP_Theme_JSON_Data296			 * compatible class that is not a WP_Theme_JSON_Data object.297			 */298			if ( $theme_json instanceof WP_Theme_JSON_Data ) {299				static::$theme = $theme_json->get_theme_json();300			} else {301				$config        = $theme_json->get_data();302				static::$theme = new WP_Theme_JSON( $config );303			}304 305			if ( $wp_theme->parent() ) {306				// Get parent theme.json.307				$parent_theme_json_file = $wp_theme->parent()->get_file_path( 'theme.json' );308				if ( $theme_json_file !== $parent_theme_json_file && is_readable( $parent_theme_json_file ) ) {309					$parent_theme_json_data = static::read_json_file( $parent_theme_json_file );310					$parent_theme_json_data = static::translate( $parent_theme_json_data, $wp_theme->parent()->get( 'TextDomain' ) );311					$parent_theme           = new WP_Theme_JSON( $parent_theme_json_data );312 313					/*314					 * Merge the child theme.json into the parent theme.json.315					 * The child theme takes precedence over the parent.316					 */317					$parent_theme->merge( static::$theme );318					static::$theme = $parent_theme;319				}320			}321		}322 323		if ( ! $options['with_supports'] ) {

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.8.8 tag, from src/wp-includes/class-wp-theme-json-resolver.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.