wp_get_global_stylesheet( array $types = array() ): string

Compatibility

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

Parameters

$typesarrayoptional

Types of styles to load.
See 'WP_Theme_JSON::get_stylesheet' for all valid types.
If empty, it'll load the following:
- for themes without theme.json: 'variables', 'presets', 'base-layout-styles'.
- for themes with theme.json: 'variables', 'presets', 'styles'.Default: array()

Return value

string

Stylesheet.

Performance profile

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

Only touches the object cache, via wp_cache_get().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

14–79

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

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

What it touches

• cacheobject cachewp_cache_get()called directly
• hookthird-party callbacksapply_filters()one call below wp_get_global_stylesheet()

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

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

Uses · 7

• wp_is_development_mode()Checks whether the site is in the given development mode.
• wp_cache_get()Retrieves the cache contents from the cache by key and group.
• 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.
• wp_cache_set()Saves the data to the cache.
• 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.
• WP_Theme_JSON_Resolver::get_merged_data()Returns the data merged from multiple origins.

Used by · 3

• get_block_editor_settings()Returns the contextualized block editor settings for a selected editor context.
• wp_enqueue_global_styles()Enqueues the global styles defined via theme.json.
• wp_enqueue_global_styles_css_custom_properties()Function that enqueues the CSS Custom Properties coming from theme.json.

Source code

View on Trac ↗View on GitHub ↗

151function wp_get_global_stylesheet( $types = array() ) {152	/*153	 * Ignore cache when the development mode is set to 'theme', so it doesn't interfere with the theme154	 * developer's workflow.155	 */156	$can_use_cached = empty( $types ) && ! wp_is_development_mode( 'theme' );157 158	/*159	 * By using the 'theme_json' group, this data is marked to be non-persistent across requests.160	 * @see `wp_cache_add_non_persistent_groups()`.161	 *162	 * The rationale for this is to make sure derived data from theme.json163	 * is always fresh from the potential modifications done via hooks164	 * that can use dynamic data (modify the stylesheet depending on some option,165	 * settings depending on user permissions, etc.).166	 * See some of the existing hooks to modify theme.json behavior:167	 * @see https://make.wordpress.org/core/2022/10/10/filters-for-theme-json-data/168	 *169	 * A different alternative considered was to invalidate the cache upon certain170	 * events such as options add/update/delete, user meta, etc.171	 * It was judged not enough, hence this approach.172	 * @see https://github.com/WordPress/gutenberg/pull/45372173	 */174	$cache_group = 'theme_json';175	$cache_key   = 'wp_get_global_stylesheet';176	if ( $can_use_cached ) {177		$cached = wp_cache_get( $cache_key, $cache_group );178		if ( $cached ) {179			return $cached;180		}181	}182 183	$tree                = WP_Theme_JSON_Resolver::resolve_theme_file_uris( WP_Theme_JSON_Resolver::get_merged_data() );184	$supports_theme_json = wp_theme_has_theme_json();185 186	if ( empty( $types ) && ! $supports_theme_json ) {187		$types = array( 'variables', 'presets', 'base-layout-styles' );188	} elseif ( empty( $types ) ) {189		$types = array( 'variables', 'styles', 'presets' );190	}191 192	/*193	 * If variables are part of the stylesheet, then add them.194	 * This is so themes without a theme.json still work as before 5.9:195	 * they can override the default presets.196	 * See https://core.trac.wordpress.org/ticket/54782197	 */198	$styles_variables = '';199	if ( in_array( 'variables', $types, true ) ) {200		/*201		 * Only use the default, theme, and custom origins. Why?202		 * Because styles for `blocks` origin are added at a later phase203		 * (i.e. in the render cycle). Here, only the ones in use are rendered.204		 * @see wp_add_global_styles_for_blocks205		 */206		$origins          = array( 'default', 'theme', 'custom' );207		$styles_variables = $tree->get_stylesheet( array( 'variables' ), $origins );208		$types            = array_diff( $types, array( 'variables' ) );209	}210 211	/*212	 * For the remaining types (presets, styles), we do consider origins:213	 *214	 * - themes without theme.json: only the classes for the presets defined by core215	 * - themes with theme.json: the presets and styles classes, both from core and the theme216	 */217	$styles_rest = '';218	if ( ! empty( $types ) ) {219		/*220		 * Only use the default, theme, and custom origins. Why?221		 * Because styles for `blocks` origin are added at a later phase222		 * (i.e. in the render cycle). Here, only the ones in use are rendered.223		 * @see wp_add_global_styles_for_blocks224		 */225		$origins = array( 'default', 'theme', 'custom' );226		/*227		 * If the theme doesn't have theme.json but supports both appearance tools and color palette,228		 * the 'theme' origin should be included so color palette presets are also output.229		 */230		if ( ! $supports_theme_json && ( current_theme_supports( 'appearance-tools' ) || current_theme_supports( 'border' ) ) && current_theme_supports( 'editor-color-palette' ) ) {

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 6.8.8 tag, from src/wp-includes/global-styles-and-settings.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.