<!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>[58246] trunk: Editor: allow registering block styles for multiple block types.</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/58246">58246</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/58246","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>isabel_brison</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-05-30 07:33:23 +0000 (Thu, 30 May 2024)</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: allow registering block styles for multiple block types.
Updates the `WP_Block_Styles_Registry` class to allow registering an array of blocks.
Props aaronrobertshaw, talldanwp, isabel_brison.
Fixes <a href="https://core.trac.wordpress.org/ticket/61274">#61274</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksphp">trunk/src/wp-includes/blocks.php</a></li>
<li><a href="#trunksrcwpincludesclasswpblockstylesregistryphp">trunk/src/wp-includes/class-wp-block-styles-registry.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunittestsblockswpBlockStylesRegistryphp">trunk/tests/phpunit/tests/blocks/wpBlockStylesRegistry.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 2024-05-30 05:21:00 UTC (rev 58245)
+++ trunk/src/wp-includes/blocks.php 2024-05-30 07:33:23 UTC (rev 58246)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1902,14 +1902,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Registers a new block style.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.3.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.6.0 Updated types as registry now allows registering styles for multiple block types at once.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles/
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $block_name Block type name including namespace.
- * @param array $style_properties Array containing the properties of the style name, label,
- * style_handle (name of the stylesheet to be enqueued),
- * inline_style (string containing the CSS to be added).
- * See WP_Block_Styles_Registry::register().
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|array $block_name Block type name including namespace or array of namespaced block type names.
+ * @param array $style_properties Array containing the properties of the style name, label,
+ * style_handle (name of the stylesheet to be enqueued),
+ * inline_style (string containing the CSS to be added),
+ * style_data (theme.json-like array to generate CSS from).
+ * See WP_Block_Styles_Registry::register().
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if the block style was registered with success and false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function register_block_style( $block_name, $style_properties ) {
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpblockstylesregistryphp"></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/class-wp-block-styles-registry.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-block-styles-registry.php 2024-05-30 05:21:00 UTC (rev 58245)
+++ trunk/src/wp-includes/class-wp-block-styles-registry.php 2024-05-30 07:33:23 UTC (rev 58246)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -42,11 +42,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * or with an inline tag.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.3.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.6.0 Added ability to register style across multiple block types along with theme.json-like style data.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @link https://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles/
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $block_name Block type name including namespace.
- * @param array $style_properties {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|array $block_name Block type name including namespace or array of namespaced block type names.
+ * @param array $style_properties {
</ins><span class="cx" style="display: block; padding: 0 10px"> * Array containing the properties of the style.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $name The identifier of the style used to compute a CSS class.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,16 +57,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $style_handle The handle to an already registered style that should be
</span><span class="cx" style="display: block; padding: 0 10px"> * enqueued in places where block styles are needed.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type bool $is_default Whether this is the default style for the block type.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array $style_data Theme.json-like object to generate CSS from.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if the block style was registered with success and false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function register( $block_name, $style_properties ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! isset( $block_name ) || ! is_string( $block_name ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! is_string( $block_name ) && ! is_array( $block_name ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> _doing_it_wrong(
</span><span class="cx" style="display: block; padding: 0 10px"> __METHOD__,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- __( 'Block name must be a string.' ),
- '5.3.0'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ __( 'Block name must be a string or array.' ),
+ '6.6.0'
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -89,11 +91,14 @@
</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"> $block_style_name = $style_properties['name'];
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $block_names = is_string( $block_name ) ? array( $block_name ) : $block_name;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! isset( $this->registered_block_styles[ $block_name ] ) ) {
- $this->registered_block_styles[ $block_name ] = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $block_names as $name ) {
+ if ( ! isset( $this->registered_block_styles[ $name ] ) ) {
+ $this->registered_block_styles[ $name ] = array();
+ }
+ $this->registered_block_styles[ $name ][ $block_style_name ] = $style_properties;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->registered_block_styles[ $block_name ][ $block_style_name ] = $style_properties;
</del><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsblockswpBlockStylesRegistryphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/tests/blocks/wpBlockStylesRegistry.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/wpBlockStylesRegistry.php (rev 0)
+++ trunk/tests/phpunit/tests/blocks/wpBlockStylesRegistry.php 2024-05-30 07:33:23 UTC (rev 58246)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,69 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Tests for WP_Block_Styles_Registry.
+ *
+ * @package WordPress
+ * @subpackage Blocks
+ * @since 6.6.0
+ *
+ * @group blocks
+ */
+class Tests_Blocks_wpBlockStylesRegistry extends WP_UnitTestCase {
+
+ /**
+ * Fake block styles registry.
+ *
+ * @since 6.6.0
+ * @var WP_Block_Styles_Registry
+ */
+ private $registry = null;
+
+ /**
+ * Set up each test method.
+ *
+ * @since 6.6.0
+ */
+ public function set_up() {
+ parent::set_up();
+
+ $this->registry = new WP_Block_Styles_Registry();
+ }
+
+ /**
+ * Tear down each test method.
+ *
+ * @since 6.6.0
+ */
+ public function tear_down() {
+ $this->registry = null;
+
+ parent::tear_down();
+ }
+
+ /**
+ * Should accept valid string block type name.
+ *
+ * @ticket 61274
+ */
+ public function test_register_block_style_with_string_block_name() {
+ $name = 'core/paragraph';
+ $style_properties = array( 'name' => 'fancy' );
+ $result = $this->registry->register( $name, $style_properties );
+ $this->assertTrue( $result );
+ $this->assertTrue( $this->registry->is_registered( 'core/paragraph', 'fancy' ) );
+ }
+
+ /**
+ * Should accept valid array of block type names.
+ *
+ * @ticket 61274
+ */
+ public function test_register_block_style_with_array_of_block_names() {
+ $names = array( 'core/paragraph', 'core/group' );
+ $style_properties = array( 'name' => 'plain' );
+ $result = $this->registry->register( $names, $style_properties );
+ $this->assertTrue( $result );
+ $this->assertTrue( $this->registry->is_registered( 'core/paragraph', 'plain' ) );
+ $this->assertTrue( $this->registry->is_registered( 'core/group', 'plain' ) );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/blocks/wpBlockStylesRegistry.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>