wp_get_global_styles_custom_css(): string
- Since
- 6.2.0
- Source
wp-includes/deprecated.php:6318
Compatibility
Deprecated in WordPress 6.7.0. Use {@see 'wp_get_global_stylesheet'} instead for top-level custom CSS, or {@see 'WP_Theme_JSON::get_styles_for_block'} for block-level custom CSS.
- WordPress
- since 6.2.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.
Return value
string- The global styles custom CSS.
Performance profile
How much work a call to wp_get_global_styles_custom_css() 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
- Scaling
- Constant
- Instructions
- 9–34
- Plugin surface
- None
- Called by
- 1
Only touches the object cache, via wp_cache_get().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 36.
Nothing here hands control to plugin code.
1 place in core call this, so the cost is paid more often than your own code shows.
What it touches
- cacheobject cache
wp_cache_get()called directly - hookthird-party callbacks
do_action()one call below wp_get_global_styles_custom_css()
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 · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_global_styles_custom_css() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!wp_theme_has_theme_json() | 9 | _deprecated_function(), wp_theme_has_theme_json() |
wp_theme_has_theme_json() && !$value | 22 | _deprecated_function(), wp_theme_has_theme_json(), wp_is_development_mode(), wp_cache_get() |
wp_theme_has_theme_json() && $value | 23 | _deprecated_function(), wp_theme_has_theme_json(), wp_is_development_mode(), ::WP_Theme_JSON_Resolver(), ->get_custom_css() |
wp_theme_has_theme_json() | 28 | _deprecated_function(), wp_theme_has_theme_json(), wp_is_development_mode(), ::WP_Theme_JSON_Resolver(), ->get_custom_css(), wp_cache_set() |
wp_theme_has_theme_json() | 29 | _deprecated_function(), wp_theme_has_theme_json(), wp_is_development_mode(), wp_cache_get(), ::WP_Theme_JSON_Resolver(), ->get_custom_css() |
wp_theme_has_theme_json() && !$value | 34 | _deprecated_function(), wp_theme_has_theme_json(), wp_is_development_mode(), wp_cache_get(), ::WP_Theme_JSON_Resolver(), ->get_custom_css(), wp_cache_set() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 36 instructions, 9–34 executed per call, 4 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 · 6
- _deprecated_function()Marks a function as deprecated and inform when it has been used.
- wp_theme_has_theme_json()Checks whether a theme or its parent has a theme.json file.
- 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_cache_set()Saves the data to the cache.
- WP_Theme_JSON_Resolver::get_merged_data()Returns the data merged from multiple origins.
Used by · 1
- wp_enqueue_global_styles_custom_css()Enqueues the global styles custom css defined via theme.json.
Source code
function wp_get_global_styles_custom_css() { _deprecated_function( __FUNCTION__, '6.7.0', 'wp_get_global_stylesheet' ); if ( ! wp_theme_has_theme_json() ) { return ''; } /* * Ignore cache when the development mode is set to 'theme', so it doesn't interfere with the theme * developer's workflow. */ $can_use_cached = ! wp_is_development_mode( 'theme' ); /* * By using the 'theme_json' group, this data is marked to be non-persistent across requests. * @see `wp_cache_add_non_persistent_groups()`. * * The rationale for this is to make sure derived data from theme.json * is always fresh from the potential modifications done via hooks * that can use dynamic data (modify the stylesheet depending on some option, * settings depending on user permissions, etc.). * See some of the existing hooks to modify theme.json behavior: * @see https://make.wordpress.org/core/2022/10/10/filters-for-theme-json-data/ * * A different alternative considered was to invalidate the cache upon certain * events such as options add/update/delete, user meta, etc. * It was judged not enough, hence this approach. * @see https://github.com/WordPress/gutenberg/pull/45372 */ $cache_key = 'wp_get_global_styles_custom_css'; $cache_group = 'theme_json'; if ( $can_use_cached ) { $cached = wp_cache_get( $cache_key, $cache_group ); if ( $cached ) { return $cached; } } $tree = WP_Theme_JSON_Resolver::get_merged_data(); $stylesheet = $tree->get_custom_css(); if ( $can_use_cached ) { wp_cache_set( $cache_key, $stylesheet, $cache_group ); } return $stylesheet;}Changelog
Introduced in 6.2.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/deprecated.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.