<!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>[56005] trunk: Editor: Fix block editor styles being registered with frontend stylesheets.</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/56005">56005</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/56005","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-06-23 18:59:53 +0000 (Fri, 23 Jun 2023)</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: Fix block editor styles being registered with frontend stylesheets.
This changeset fixes a bug where WordPress core's own block editor styles (`wp-block-{$block_name}-editor`) were referencing the same CSS files as their frontend equivalents (`wp-block-{$block_name}`). This would result in incorrect frontend styles potentially being loaded in the block editor.
Tests for the related logic have been added.
Props flixos90, joemcgill, mukesh27, spacedmonkey.
Fixes <a href="https://core.trac.wordpress.org/ticket/58605">#58605</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksphp">trunk/src/wp-includes/blocks.php</a></li>
<li><a href="#trunktestsphpunittestsblocksregisterphp">trunk/tests/phpunit/tests/blocks/register.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocksphp"></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/blocks.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/blocks.php 2023-06-23 17:47:34 UTC (rev 56004)
+++ trunk/src/wp-includes/blocks.php 2023-06-23 18:59:53 UTC (rev 56005)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -219,7 +219,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Check whether styles should have a ".min" suffix or not.
</span><span class="cx" style="display: block; padding: 0 10px"> $suffix = SCRIPT_DEBUG ? '' : '.min';
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $is_core_block ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $style_path = "style$suffix.css";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $style_path = ( 'editorStyle' === $field_name ) ? "editor{$suffix}.css" : "style{$suffix}.css";
</ins><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"> $style_path_norm = wp_normalize_path( realpath( dirname( $metadata['file'] ) . '/' . $style_path ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -239,7 +239,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $is_theme_block ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $style_uri = get_theme_file_uri( str_replace( $theme_path_norm, '', $style_path_norm ) );
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( $is_core_block ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $style_uri = includes_url( 'blocks/' . str_replace( 'core/', '', $metadata['name'] ) . "/style$suffix.css" );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // All possible $style_path variants for core blocks are hard-coded above.
+ $style_uri = includes_url( 'blocks/' . str_replace( 'core/', '', $metadata['name'] ) . '/' . $style_path );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $style_uri = false;
</span></span></pre></div>
<a id="trunktestsphpunittestsblocksregisterphp"></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/blocks/register.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/register.php 2023-06-23 17:47:34 UTC (rev 56004)
+++ trunk/tests/phpunit/tests/blocks/register.php 2023-06-23 18:59:53 UTC (rev 56005)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -323,6 +323,76 @@
</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">+ * @ticket 58605
+ *
+ * @dataProvider data_register_block_style_handle_uses_correct_core_stylesheet
+ *
+ * @param string $block_json_path Path to the `block.json` file, relative to ABSPATH.
+ * @param string $style_field Either 'style' or 'editorStyle'.
+ * @param string|bool $expected_path Expected path of registered stylesheet, relative to ABSPATH.
+ */
+ public function test_register_block_style_handle_uses_correct_core_stylesheet( $block_json_path, $style_field, $expected_path ) {
+ $metadata_file = ABSPATH . $block_json_path;
+ $metadata = wp_json_file_decode( $metadata_file, array( 'associative' => true ) );
+
+ $block_name = str_replace( 'core/', '', $metadata['name'] );
+
+ // Normalize metadata similar to `register_block_type_from_metadata()`.
+ $metadata['file'] = wp_normalize_path( realpath( $metadata_file ) );
+ if ( ! isset( $metadata['style'] ) ) {
+ $metadata['style'] = "wp-block-$block_name";
+ }
+ if ( ! isset( $metadata['editorStyle'] ) ) {
+ $metadata['editorStyle'] = "wp-block-{$block_name}-editor";
+ }
+
+ // Ensure block assets are separately registered.
+ add_filter( 'should_load_separate_core_block_assets', '__return_true' );
+
+ /*
+ * Account for minified asset path and ensure the file exists.
+ * This may not be the case in the testing environment since it requires the build process to place them.
+ */
+ if ( is_string( $expected_path ) ) {
+ $expected_path = str_replace( '.css', wp_scripts_get_suffix() . '.css', $expected_path );
+ self::touch( ABSPATH . $expected_path );
+ }
+
+ $result = register_block_style_handle( $metadata, $style_field );
+ $this->assertSame( $metadata[ $style_field ], $result, 'Core block registration failed' );
+ if ( $expected_path ) {
+ $this->assertStringEndsWith( $expected_path, wp_styles()->registered[ $result ]->src, 'Core block stylesheet path incorrect' );
+ } else {
+ $this->assertFalse( wp_styles()->registered[ $result ]->src, 'Core block stylesheet src should be false' );
+ }
+ }
+
+ public function data_register_block_style_handle_uses_correct_core_stylesheet() {
+ return array(
+ 'block with style' => array(
+ WPINC . '/blocks/archives/block.json',
+ 'style',
+ WPINC . '/blocks/archives/style.css',
+ ),
+ 'block with editor style' => array(
+ WPINC . '/blocks/archives/block.json',
+ 'editorStyle',
+ WPINC . '/blocks/archives/editor.css',
+ ),
+ 'block without style' => array(
+ WPINC . '/blocks/widget-group/block.json',
+ 'style',
+ false,
+ ),
+ 'block without editor style' => array(
+ WPINC . '/blocks/widget-group/block.json',
+ 'editorStyle',
+ false,
+ ),
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 50263
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_handle_passed_register_block_style_handle() {
</span></span></pre>
</div>
</div>
</body>
</html>