<!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>[59925] trunk: Block support: Add server-side processing for ariaLabel.</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/59925">59925</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/59925","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>Mamaduka</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-03-04 13:04:49 +0000 (Tue, 04 Mar 2025)</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'>Block support: Add server-side processing for ariaLabel.
Adds server-side registration for `ariaLabel` block support and its required fields. Fully enabling feature support for dynamic blocks and consumers using `ServerSideRender` component.
Props wildworks, fabiankaegy, joemcgill, poena.
Fixes <a href="https://core.trac.wordpress.org/ticket/62919">#62919</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpblocksupportsphp">trunk/src/wp-includes/class-wp-block-supports.php</a></li>
<li><a href="#trunksrcwpsettingsphp">trunk/src/wp-settings.php</a></li>
<li><a href="#trunktestsphpunittestsblockssupportedStylesphp">trunk/tests/phpunit/tests/blocks/supportedStyles.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksupportsarialabelphp">trunk/src/wp-includes/block-supports/aria-label.php</a></li>
<li><a href="#trunktestsphpunittestsblocksupportsarialabelphp">trunk/tests/phpunit/tests/block-supports/aria-label.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocksupportsarialabelphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/block-supports/aria-label.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-supports/aria-label.php (rev 0)
+++ trunk/src/wp-includes/block-supports/aria-label.php 2025-03-04 13:04:49 UTC (rev 59925)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,70 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Aria label block support flag.
+ *
+ * @package WordPress
+ * @since 6.8.0
+ */
+
+/**
+ * Registers the aria-label block attribute for block types that support it.
+ *
+ * @since 6.8.0
+ * @access private
+ *
+ * @param WP_Block_Type $block_type Block Type.
+ */
+function wp_register_aria_label_support( $block_type ) {
+ $has_aria_label_support = block_has_support( $block_type, array( 'ariaLabel' ), false );
+
+ if ( ! $has_aria_label_support ) {
+ return;
+ }
+
+ if ( ! $block_type->attributes ) {
+ $block_type->attributes = array();
+ }
+
+ if ( ! array_key_exists( 'ariaLabel', $block_type->attributes ) ) {
+ $block_type->attributes['ariaLabel'] = array(
+ 'type' => 'string',
+ );
+ }
+}
+
+/**
+ * Add the aria-label to the output.
+ *
+ * @since 6.8.0
+ * @access private
+ *
+ * @param WP_Block_Type $block_type Block Type.
+ * @param array $block_attributes Block attributes.
+ *
+ * @return array Block aria-label.
+ */
+function wp_apply_aria_label_support( $block_type, $block_attributes ) {
+ if ( ! $block_attributes ) {
+ return array();
+ }
+
+ $has_aria_label_support = block_has_support( $block_type, array( 'ariaLabel' ), false );
+ if ( ! $has_aria_label_support ) {
+ return array();
+ }
+
+ $has_aria_label = array_key_exists( 'ariaLabel', $block_attributes );
+ if ( ! $has_aria_label ) {
+ return array();
+ }
+ return array( 'aria-label' => $block_attributes['ariaLabel'] );
+}
+
+// Register the block support.
+WP_Block_Supports::get_instance()->register(
+ 'aria-label',
+ array(
+ 'register_attribute' => 'wp_register_aria_label_support',
+ 'apply' => 'wp_apply_aria_label_support',
+ )
+);
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/src/wp-includes/block-supports/aria-label.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><a id="trunksrcwpincludesclasswpblocksupportsphp"></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-supports.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-block-supports.php 2025-03-04 06:05:15 UTC (rev 59924)
+++ trunk/src/wp-includes/class-wp-block-supports.php 2025-03-04 13:04:49 UTC (rev 59925)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -181,7 +181,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // This is hardcoded on purpose.
</span><span class="cx" style="display: block; padding: 0 10px"> // We only support a fixed list of attributes.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $attributes_to_merge = array( 'style', 'class', 'id' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $attributes_to_merge = array( 'style', 'class', 'id', 'aria-label' );
</ins><span class="cx" style="display: block; padding: 0 10px"> $attributes = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $attributes_to_merge as $attribute_name ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $new_attributes[ $attribute_name ] ) && empty( $extra_attributes[ $attribute_name ] ) ) {
</span></span></pre></div>
<a id="trunksrcwpsettingsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-settings.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-settings.php 2025-03-04 06:05:15 UTC (rev 59924)
+++ trunk/src/wp-settings.php 2025-03-04 13:04:49 UTC (rev 59925)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -387,6 +387,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/block-supports/shadow.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/block-supports/background.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/block-supports/block-style-variations.php';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+require ABSPATH . WPINC . '/block-supports/aria-label.php';
</ins><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/style-engine.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/style-engine/class-wp-style-engine.php';
</span><span class="cx" style="display: block; padding: 0 10px"> require ABSPATH . WPINC . '/style-engine/class-wp-style-engine-css-declarations.php';
</span></span></pre></div>
<a id="trunktestsphpunittestsblocksupportsarialabelphp"></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/block-supports/aria-label.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-supports/aria-label.php (rev 0)
+++ trunk/tests/phpunit/tests/block-supports/aria-label.php 2025-03-04 13:04:49 UTC (rev 59925)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,87 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * @group block-supports
+ *
+ * @covers ::wp_apply_aria_label_support
+ */
+class Tests_Block_Supports_Aria_Label extends WP_UnitTestCase {
+ /**
+ * @var string|null
+ */
+ private $test_block_name;
+
+ public function set_up() {
+ parent::set_up();
+ $this->test_block_name = null;
+ }
+
+ public function tear_down() {
+ unregister_block_type( $this->test_block_name );
+ $this->test_block_name = null;
+ parent::tear_down();
+ }
+
+ /**
+ * Registers a new block for testing aria-label support.
+ *
+ * @param string $block_name Name for the test block.
+ * @param array $supports Array defining block support configuration.
+ *
+ * @return WP_Block_Type The block type for the newly registered test block.
+ */
+ private function register_aria_label_block_with_support( $block_name, $supports = array() ) {
+ $this->test_block_name = $block_name;
+ register_block_type(
+ $this->test_block_name,
+ array(
+ 'api_version' => 3,
+ 'supports' => $supports,
+ )
+ );
+ $registry = WP_Block_Type_Registry::get_instance();
+
+ return $registry->get_registered( $this->test_block_name );
+ }
+
+ /**
+ * Tests that position block support works as expected.
+ *
+ * @ticket 62919
+ *
+ * @dataProvider data_aria_label_block_support
+ *
+ * @param boolean|array $support Aria label block support configuration.
+ * @param string $value Aria label value for attribute object.
+ * @param array $expected Expected aria label block support styles.
+ */
+ public function test_wp_apply_aria_label_support( $support, $value, $expected ) {
+ $block_type = self::register_aria_label_block_with_support(
+ 'test/aria-label-block',
+ array( 'ariaLabel' => $support )
+ );
+ $block_attrs = array( 'ariaLabel' => $value );
+ $actual = wp_apply_aria_label_support( $block_type, $block_attrs );
+
+ $this->assertSame( $expected, $actual );
+ }
+
+ /**
+ * Data provider.
+ *
+ * @return array
+ */
+ public function data_aria_label_block_support() {
+ return array(
+ 'aria-label attribute is applied' => array(
+ 'support' => true,
+ 'value' => 'Label',
+ 'expected' => array( 'aria-label' => 'Label' ),
+ ),
+ 'aria-label attribute is not applied if block does not support it' => array(
+ 'support' => false,
+ 'value' => 'Label',
+ 'expected' => array(),
+ ),
+ );
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/tests/block-supports/aria-label.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><a id="trunktestsphpunittestsblockssupportedStylesphp"></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/supportedStyles.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/supportedStyles.php 2025-03-04 06:05:15 UTC (rev 59924)
+++ trunk/tests/phpunit/tests/blocks/supportedStyles.php 2025-03-04 13:04:49 UTC (rev 59925)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -152,6 +152,24 @@
</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">+ * Runs assertions that the rendered output has expected content and aria-label attr.
+ *
+ * @param array $block Block to render.
+ * @param string $expected_aria_label Expected output aria-label attr string.
+ */
+ private function assert_content_and_aria_label_match( $block, $expected_aria_label ) {
+ $styled_block = $this->render_example_block( $block );
+ $content = $this->get_content_from_block( $styled_block );
+
+ $this->assertSame( self::BLOCK_CONTENT, $content, 'Block content does not match expected content' );
+ $this->assertSame(
+ $expected_aria_label,
+ $this->get_attribute_from_block( 'aria-label', $styled_block ),
+ 'Aria-label does not match expected aria-label'
+ );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Tests color support for named color support for named colors.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_named_color_support() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -686,6 +704,31 @@
</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">+ * Tests aria-label server-side block support.
+ */
+ public function test_aria_label_support() {
+ $block_type_settings = array(
+ 'attributes' => array(),
+ 'supports' => array(
+ 'ariaLabel' => true,
+ ),
+ );
+ $this->register_block_type( 'core/example', $block_type_settings );
+
+ $block = array(
+ 'blockName' => 'core/example',
+ 'attrs' => array(
+ 'ariaLabel' => 'Label',
+ ),
+ 'innerBlock' => array(),
+ 'innerContent' => array(),
+ 'innerHTML' => array(),
+ );
+
+ $this->assert_content_and_aria_label_match( $block, 'Label' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Ensures libxml_internal_errors is being used instead of @ warning suppression
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_render_block_suppresses_warnings_without_at_suppression() {
</span></span></pre>
</div>
</div>
</body>
</html>