<!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>[56254] trunk: Editor: Fix bug where it was not possible to style custom block elements in `theme.json`.</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/56254">56254</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/56254","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-07-18 00:00:49 +0000 (Tue, 18 Jul 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 bug where it was not possible to style custom block elements in `theme.json`.
This changeset resolves a bug where WordPress would only allow HTML elements within core's own blocks to be styled in `theme.json`. Prior to this change, any `theme.json` rules applying to elements in custom blocks were ignored. With this fix it is now possible to style third-party block elements in `theme.json`.
Props flixos90, azaozz, costdev, glendaviesnz, spacedmonkey, oandregal.
Fixes <a href="https://core.trac.wordpress.org/ticket/57868">#57868</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesglobalstylesandsettingsphp">trunk/src/wp-includes/global-styles-and-settings.php</a></li>
<li><a href="#trunktestsphpunitdatathemedir1blockthemethemejson">trunk/tests/phpunit/data/themedir1/block-theme/theme.json</a></li>
<li><a href="#trunktestsphpunitteststhemewpAddGlobalStylesForBlocksphp">trunk/tests/phpunit/tests/theme/wpAddGlobalStylesForBlocks.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesglobalstylesandsettingsphp"></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/global-styles-and-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/global-styles-and-settings.php 2023-07-17 22:24:39 UTC (rev 56253)
+++ trunk/src/wp-includes/global-styles-and-settings.php 2023-07-18 00:00:49 UTC (rev 56254)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -320,20 +320,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // The likes of block element styles from theme.json do not have $metadata['name'] set.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $metadata['name'] ) && ! empty( $metadata['path'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $result = array_values(
- array_filter(
- $metadata['path'],
- static function ( $item ) {
- if ( str_contains( $item, 'core/' ) ) {
- return true;
- }
- return false;
- }
- )
- );
- if ( isset( $result[0] ) ) {
- if ( str_starts_with( $result[0], 'core/' ) ) {
- $block_name = str_replace( 'core/', '', $result[0] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $block_name = wp_get_block_name_from_theme_json_path( $metadata['path'] );
+ if ( $block_name ) {
+ if ( str_starts_with( $block_name, 'core/' ) ) {
+ $block_name = str_replace( 'core/', '', $block_name );
</ins><span class="cx" style="display: block; padding: 0 10px"> $stylesheet_handle = 'wp-block-' . $block_name;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> wp_add_inline_style( $stylesheet_handle, $block_css );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -343,6 +333,47 @@
</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">+ * Gets the block name from a given theme.json path.
+ *
+ * @since 6.3.0
+ * @access private
+ *
+ * @param array $path An array of keys describing the path to a property in theme.json.
+ * @return string Identified block name, or empty string if none found.
+ */
+function wp_get_block_name_from_theme_json_path( $path ) {
+ // Block name is expected to be the third item after 'styles' and 'blocks'.
+ if (
+ count( $path ) >= 3
+ && 'styles' === $path[0]
+ && 'blocks' === $path[1]
+ && str_contains( $path[2], '/' )
+ ) {
+ return $path[2];
+ }
+
+ /*
+ * As fallback and for backward compatibility, allow any core block to be
+ * at any position.
+ */
+ $result = array_values(
+ array_filter(
+ $path,
+ static function ( $item ) {
+ if ( str_contains( $item, 'core/' ) ) {
+ return true;
+ }
+ return false;
+ }
+ )
+ );
+ if ( isset( $result[0] ) ) {
+ return $result[0];
+ }
+ return '';
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Checks whether a theme or its parent has a theme.json file.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.2.0
</span></span></pre></div>
<a id="trunktestsphpunitdatathemedir1blockthemethemejson"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/data/themedir1/block-theme/theme.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/data/themedir1/block-theme/theme.json 2023-07-17 22:24:39 UTC (rev 56253)
+++ trunk/tests/phpunit/data/themedir1/block-theme/theme.json 2023-07-18 00:00:49 UTC (rev 56254)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -73,6 +73,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "my/third-party-block": {
</span><span class="cx" style="display: block; padding: 0 10px"> "color": {
</span><span class="cx" style="display: block; padding: 0 10px"> "background": "hotpink"
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ },
+ "elements": {
+ "cite": {
+ "color": {
+ "text": "white"
+ }
+ }
</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"> },
</span></span></pre></div>
<a id="trunktestsphpunitteststhemewpAddGlobalStylesForBlocksphp"></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/wpAddGlobalStylesForBlocks.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/theme/wpAddGlobalStylesForBlocks.php 2023-07-17 22:24:39 UTC (rev 56253)
+++ trunk/tests/phpunit/tests/theme/wpAddGlobalStylesForBlocks.php 2023-07-18 00:00:49 UTC (rev 56254)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -139,6 +139,88 @@
</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 57868
+ */
+ public function test_third_party_blocks_inline_styles_for_elements_get_rendered_when_per_block() {
+ $this->set_up_third_party_block();
+ add_filter( 'should_load_separate_core_block_assets', '__return_true' );
+
+ wp_register_style( 'global-styles', false, array(), true, true );
+ wp_enqueue_style( 'global-styles' );
+ wp_add_global_styles_for_blocks();
+
+ $actual = get_echo( 'wp_print_styles' );
+
+ $this->assertStringContainsString(
+ '.wp-block-my-third-party-block cite{color: white;}',
+ $actual
+ );
+ }
+
+ /**
+ * @ticket 57868
+ */
+ public function test_third_party_blocks_inline_styles_for_elements_get_rendered() {
+ wp_register_style( 'global-styles', false, array(), true, true );
+ wp_enqueue_style( 'global-styles' );
+ wp_add_global_styles_for_blocks();
+
+ $actual = get_echo( 'wp_print_styles' );
+
+ $this->assertStringContainsString(
+ '.wp-block-my-third-party-block cite{color: white;}',
+ $actual
+ );
+ }
+
+ /**
+ * @ticket 57868
+ *
+ * @dataProvider data_wp_get_block_name_from_theme_json_path
+ *
+ * @param array $path An array of keys describing the path to a property in theme.json.
+ * @param string $expected The expected block name.
+ */
+ public function test_wp_get_block_name_from_theme_json_path( $path, $expected ) {
+ $block_name = wp_get_block_name_from_theme_json_path( $path );
+ $this->assertSame( $expected, $block_name );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array[]
+ */
+ public function data_wp_get_block_name_from_theme_json_path() {
+ return array(
+ 'core block styles' => array(
+ array( 'styles', 'blocks', 'core/navigation' ),
+ 'core/navigation',
+ ),
+ 'core block element styles' => array(
+ array( 'styles', 'blocks', 'core/navigation', 'elements', 'link' ),
+ 'core/navigation',
+ ),
+ 'custom block styles' => array(
+ array( 'styles', 'blocks', 'my/third-party-block' ),
+ 'my/third-party-block',
+ ),
+ 'custom block element styles' => array(
+ array( 'styles', 'blocks', 'my/third-party-block', 'elements', 'cite' ),
+ 'my/third-party-block',
+ ),
+ 'custom block wrong format' => array(
+ array( 'styles', 'my/third-party-block' ),
+ '',
+ ),
+ 'invalid path but works for BC' => array(
+ array( 'something', 'core/image' ),
+ 'core/image',
+ ),
+ );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> private function set_up_third_party_block() {
</span><span class="cx" style="display: block; padding: 0 10px"> switch_theme( 'block-theme' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>