<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[54214] trunk: Editor: Backport block supports filter callback, registrations and tests to 6.1.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/54214">54214</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/54214","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-09-19 20:54:20 +0000 (Mon, 19 Sep 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Editor: Backport block supports filter callback, registrations and tests to 6.1.
This changeset backports the following changes:
- Implement [https://github.com/WordPress/gutenberg/pull/42880 gutenberg<a href="https://core.trac.wordpress.org/ticket/42880">#42880</a>]: Backport script loader: enqueue stored block supports styles
- Allow a way to bypass `SCRIPT_DEBUG` in tests. See [https://github.com/WordPress/wordpress-develop/pull/3259#issuecomment-1250403735 comment] and the related [https://github.com/WordPress/gutenberg/pull/44248 Gutenberg pull request]
Props ramonopoly, gziolo, bernhard-reiter, audrasjb, costdev.
See <a href="https://core.trac.wordpress.org/ticket/56467">#56467</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesdefaultfiltersphp">trunk/src/wp-includes/default-filters.php</a></li>
<li><a href="#trunksrcwpincludesscriptloaderphp">trunk/src/wp-includes/script-loader.php</a></li>
<li><a href="#trunktestsphpunitteststhemewpGetGlobalStylesheetphp">trunk/tests/phpunit/tests/theme/wpGetGlobalStylesheet.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesdefaultfiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/default-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/default-filters.php 2022-09-19 20:47:22 UTC (rev 54213)
+++ trunk/src/wp-includes/default-filters.php 2022-09-19 20:54:20 UTC (rev 54214)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -575,6 +575,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_enqueue_scripts', 'wp_enqueue_global_styles' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_footer', 'wp_enqueue_global_styles', 1 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Block supports, and other styles parsed and stored in the Style Engine.
+add_action( 'wp_enqueue_scripts', 'wp_enqueue_stored_styles' );
+add_action( 'wp_footer', 'wp_enqueue_stored_styles', 1 );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // SVG filters like duotone have to be loaded at the beginning of the body in both admin and the front-end.
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_body_open', 'wp_global_styles_render_svg_filters' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'in_admin_header', 'wp_global_styles_render_svg_filters' );
</span></span></pre></div>
<a id="trunksrcwpincludesscriptloaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/script-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/script-loader.php 2022-09-19 20:47:22 UTC (rev 54213)
+++ trunk/src/wp-includes/script-loader.php 2022-09-19 20:54:20 UTC (rev 54214)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2967,6 +2967,75 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Fetches, processes and compiles stored core styles, then combines and renders them to the page.
+ * Styles are stored via the style engine API.
+ *
+ * @link https://developer.wordpress.org/block-editor/reference-guides/packages/packages-style-engine/
+ *
+ * @since 6.1.0
+ *
+ * @param array $options {
+ * Optional. An array of options to pass to wp_style_engine_get_stylesheet_from_context(). Default empty array.
+ *
+ * @type bool $optimize Whether to optimize the CSS output, e.g., combine rules. Default is `false`.
+ * @type bool $prettify Whether to add new lines and indents to output. Default is the test of whether the global constant `SCRIPT_DEBUG` is defined.
+ * }
+ *
+ * @return void
+ */
+function wp_enqueue_stored_styles( $options = array() ) {
+ $is_block_theme = wp_is_block_theme();
+ $is_classic_theme = ! $is_block_theme;
+
+ /*
+ * For block themes, this function prints stored styles in the header.
+ * For classic themes, in the footer.
+ */
+ if (
+ ( $is_block_theme && doing_action( 'wp_footer' ) ) ||
+ ( $is_classic_theme && doing_action( 'wp_enqueue_scripts' ) )
+ ) {
+ return;
+ }
+
+ $core_styles_keys = array( 'block-supports' );
+ $compiled_core_stylesheet = '';
+ $style_tag_id = 'core';
+ // Adds comment if code is prettified to identify core styles sections in debugging.
+ $should_prettify = isset( $options['prettify'] ) ? true === $options['prettify'] : defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG;
+ foreach ( $core_styles_keys as $style_key ) {
+ if ( $should_prettify ) {
+ $compiled_core_stylesheet .= "/**\n * Core styles: $style_key\n */\n";
+ }
+ // Chains core store ids to signify what the styles contain.
+ $style_tag_id .= '-' . $style_key;
+ $compiled_core_stylesheet .= wp_style_engine_get_stylesheet_from_context( $style_key, $options );
+ }
+
+ // Combines Core styles.
+ if ( ! empty( $compiled_core_stylesheet ) ) {
+ wp_register_style( $style_tag_id, false, array(), true, true );
+ wp_add_inline_style( $style_tag_id, $compiled_core_stylesheet );
+ wp_enqueue_style( $style_tag_id );
+ }
+
+ // Prints out any other stores registered by themes or otherwise.
+ $additional_stores = WP_Style_Engine_CSS_Rules_Store::get_stores();
+ foreach ( array_keys( $additional_stores ) as $store_name ) {
+ if ( in_array( $store_name, $core_styles_keys, true ) ) {
+ continue;
+ }
+ $styles = wp_style_engine_get_stylesheet_from_context( $store_name, $options );
+ if ( ! empty( $styles ) ) {
+ $key = "wp-style-engine-$store_name";
+ wp_register_style( $key, false, array(), true, true );
+ wp_add_inline_style( $key, $styles );
+ wp_enqueue_style( $key );
+ }
+ }
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Enqueues a stylesheet for a specific block.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If the theme has opted-in to separate-styles loading,
</span></span></pre></div>
<a id="trunktestsphpunitteststhemewpGetGlobalStylesheetphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/theme/wpGetGlobalStylesheet.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/theme/wpGetGlobalStylesheet.php 2022-09-19 20:47:22 UTC (rev 54213)
+++ trunk/tests/phpunit/tests/theme/wpGetGlobalStylesheet.php 2022-09-19 20:54:20 UTC (rev 54214)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -54,6 +54,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> parent::tear_down();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Cleans up global scope.
+ *
+ * @global WP_Styles $wp_styles
+ */
+ public function clean_up_global_scope() {
+ global $wp_styles;
+ parent::clean_up_global_scope();
+ $wp_styles = null;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> public function filter_set_theme_root() {
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->theme_root;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -199,4 +210,64 @@
</span><span class="cx" style="display: block; padding: 0 10px"> remove_theme_support( 'editor-font-sizes' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Tests that stored CSS is enqueued.
+ *
+ * @ticket 56467
+ *
+ * @covers ::wp_enqueue_stored_styles
+ */
+ public function test_should_enqueue_stored_styles() {
+ $core_styles_to_enqueue = array(
+ array(
+ 'selector' => '.saruman',
+ 'declarations' => array(
+ 'color' => 'white',
+ 'height' => '100px',
+ 'border-style' => 'solid',
+ ),
+ ),
+ );
+
+ // Enqueues a block supports (core styles).
+ wp_style_engine_get_stylesheet_from_css_rules(
+ $core_styles_to_enqueue,
+ array(
+ 'context' => 'block-supports',
+ )
+ );
+
+ $my_styles_to_enqueue = array(
+ array(
+ 'selector' => '.gandalf',
+ 'declarations' => array(
+ 'color' => 'grey',
+ 'height' => '90px',
+ 'border-style' => 'dotted',
+ ),
+ ),
+ );
+
+ // Enqueues some other styles.
+ wp_style_engine_get_stylesheet_from_css_rules(
+ $my_styles_to_enqueue,
+ array(
+ 'context' => 'my-styles',
+ )
+ );
+
+ wp_enqueue_stored_styles( array( 'prettify' => false ) );
+
+ $this->assertSame(
+ array( '.saruman{color:white;height:100px;border-style:solid;}' ),
+ wp_styles()->registered['core-block-supports']->extra['after'],
+ 'Registered styles with handle of "core-block-supports" do not match expected value from Style Engine store.'
+ );
+
+ $this->assertSame(
+ array( '.gandalf{color:grey;height:90px;border-style:dotted;}' ),
+ wp_styles()->registered['wp-style-engine-my-styles']->extra['after'],
+ 'Registered styles with handle of "wp-style-engine-my-styles" do not match expected value from the Style Engine store.'
+ );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>