wppaste
WordPress

WP_Theme_JSON_Resolver::get_style_variations( string $scope = 'theme' ): array

Since
6.0.0, 6.2.0, 6.6.0
Source
wp-includes/class-wp-theme-json-resolver.php:802
Returns the style variations defined by the theme.

Compatibility

WordPress
since 6.6.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$scopestringoptional
The scope or type of style variation to retrieve e.g. theme, block etc.Default: 'theme'

Return value

array
The style variations defined by the theme.

Performance profile

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

Reads or writes the filesystem via is_dir().

Scaling
Scales with input

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

Instructions
23–42

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
5

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

What it touches

  • filesystemfilesystem accessis_dir()called directly
  • hookthird-party callbacksapply_filters()one call below WP_Theme_JSON_Resolver::get_style_variations()

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 · 4 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_style_variations() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
!is_dir()23–26get_stylesheet_directory(), get_template_directory(), is_dir(), is_dir(), ksort()
is_dir()27–30get_stylesheet_directory(), get_template_directory(), is_dir(), ::recursively_iterate_json(), is_dir(), ksort()
$template_directory !== false36–38get_stylesheet_directory(), get_template_directory(), is_dir(), is_dir(), ::recursively_iterate_json(), array_merge(), ksort()
is_dir() && $template_directory !== false40–42get_stylesheet_directory(), get_template_directory(), is_dir(), ::recursively_iterate_json(), is_dir(), ::recursively_iterate_json(), array_merge(), ksort()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 97 instructions, 23–42 executed per call, 13 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 10

Used by · 5

Source code

View on Trac View on GitHub 

	public static function get_style_variations( $scope = 'theme' ) {		$variation_files    = array();		$variations         = array();		$base_directory     = get_stylesheet_directory() . '/styles';		$template_directory = get_template_directory() . '/styles';		if ( is_dir( $base_directory ) ) {			$variation_files = static::recursively_iterate_json( $base_directory );		}		if ( is_dir( $template_directory ) && $template_directory !== $base_directory ) {			$variation_files_parent = static::recursively_iterate_json( $template_directory );			// If the child and parent variation file basename are the same, only include the child theme's.			foreach ( $variation_files_parent as $parent_path => $parent ) {				foreach ( $variation_files as $child_path => $child ) {					if ( basename( $parent_path ) === basename( $child_path ) ) {						unset( $variation_files_parent[ $parent_path ] );					}				}			}			$variation_files = array_merge( $variation_files, $variation_files_parent );		}		ksort( $variation_files );		foreach ( $variation_files as $path => $file ) {			$decoded_file = self::read_json_file( $path );			if ( is_array( $decoded_file ) && static::style_variation_has_scope( $decoded_file, $scope ) ) {				$translated = static::translate( $decoded_file, wp_get_theme()->get( 'TextDomain' ) );				$variation  = ( new WP_Theme_JSON( $translated ) )->get_raw_data();				if ( empty( $variation['title'] ) ) {					$variation['title'] = basename( $path, '.json' );				}				$variations[] = $variation;			}		}		return $variations;	}

Changelog

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

6.6.0
Added configurable scope parameter to allow filtering theme.json partial files by the scope to which they can be applied e.g. theme vs block etc.
Added basic caching for read theme.json partial files.from the docblock
6.2.0
Returns parent theme variations if theme is a child.from the docblock
6.0.0
Introduced.from the docblock

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 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.