Changeset 55192 for trunk/src/wp-includes/global-styles-and-settings.php

Timestamp:

02/02/2023 06:50:54 PM (22 months ago)

Author:

flixos90

Message:

Editor: Add support for custom CSS in global styles.

This changeset introduces functions wp_get_global_styles_custom_css() and wp_enqueue_global_styles_custom_css(), which allow accessing and enqueuing custom CSS added via global styles.

Custom CSS via global styles is handled separately from custom CSS via the Customizer. If a site uses both features, the custom CSS from both sources will be loaded. The global styles custom CSS is then loaded after the Customizer custom CSS, so if there are any conflicts between the rules, the global styles take precedence.

Similarly to e.g. [55185], the result is cached in a non-persistent cache, except when WP_DEBUG is on to avoid interrupting the theme developer's workflow.

Props glendaviesnz, oandregal, ntsekouras, mamaduka, davidbaumwald, hellofromtonya, flixos90.
Fixes #57536.

File:

• trunk/src/wp-includes/global-styles-and-settings.php (modified) (2 diffs)

trunk/src/wp-includes/global-styles-and-settings.php

@@ -219 +219 @@
 
     $stylesheet = $styles_variables . $styles_rest;
+    if ( $can_use_cached ) {
+        wp_cache_set( $cache_key, $stylesheet, $cache_group );
+    }
+
+    return $stylesheet;
+}
+
+/**
+ * Gets the global styles custom css from theme.json.
+ *
+ * @since 6.2.0
+ *
+ * @return string Stylesheet.
+ */
+function wp_get_global_styles_custom_css() {
+    if ( ! wp_theme_has_theme_json() ) {
+        return '';
+    }
+    /*
+     * Ignore cache when `WP_DEBUG` is enabled, so it doesn't interfere with the theme
+     * developer's workflow.
+     *
+     * @todo Replace `WP_DEBUG` once an "in development mode" check is available in Core.
+     */
+    $can_use_cached = ! WP_DEBUG;
+
+    /*
+     * 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 );
@@ -370 +424 @@
     wp_cache_delete( 'wp_get_global_settings_custom', 'theme_json' );
     wp_cache_delete( 'wp_get_global_settings_theme', 'theme_json' );
+    wp_cache_delete( 'wp_get_global_styles_custom_css', 'theme_json' );
     WP_Theme_JSON_Resolver::clean_cached_data();
 }