<!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>[58312] trunk: Editor: Add `__experimentalSkipSerialization` support to shadow.</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/58312">58312</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/58312","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-06-03 23:34:24 +0000 (Mon, 03 Jun 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: Add `__experimentalSkipSerialization` support to shadow.
Checks if `__experimentalSkipSerialization` is set and returns early from `wp_apply_shadow_support` if so.
Props colind, madhudollu, aaronrobertshaw, vcanales, isabel_brison, swissspidy, youknowriad.
Fixes <a href="https://core.trac.wordpress.org/ticket/60784">#60784</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksupportsshadowphp">trunk/src/wp-includes/block-supports/shadow.php</a></li>
<li><a href="#trunktestsphpunittestsblocksupportsshadowphp">trunk/tests/phpunit/tests/block-supports/shadow.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblocksupportsshadowphp"></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/block-supports/shadow.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-supports/shadow.php 2024-06-03 22:02:33 UTC (rev 58311)
+++ trunk/src/wp-includes/block-supports/shadow.php 2024-06-03 23:34:24 UTC (rev 58312)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -43,6 +43,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * This will be applied to the block markup in the front-end.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.3.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.6.0 Return early if __experimentalSkipSerialization is true.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Block_Type $block_type Block type.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -52,7 +53,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_apply_shadow_support( $block_type, $block_attributes ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $has_shadow_support = block_has_support( $block_type, 'shadow', false );
</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 ( ! $has_shadow_support ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ ! $has_shadow_support ||
+ wp_should_skip_block_supports_serialization( $block_type, 'shadow' )
+ ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return array();
</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="trunktestsphpunittestsblocksupportsshadowphp"></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/block-supports/shadow.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-supports/shadow.php 2024-06-03 22:02:33 UTC (rev 58311)
+++ trunk/tests/phpunit/tests/block-supports/shadow.php 2024-06-03 23:34:24 UTC (rev 58312)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -22,10 +22,15 @@
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @ticket 58590
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Registers a new block for testing shadow 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.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_shadow_style_is_applied() {
- $this->test_block_name = 'test/shadow-style-is-applied';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private function register_shadow_block_with_support( $block_name, $supports = array() ) {
+ $this->test_block_name = $block_name;
</ins><span class="cx" style="display: block; padding: 0 10px"> register_block_type(
</span><span class="cx" style="display: block; padding: 0 10px"> $this->test_block_name,
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -35,55 +40,71 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'supports' => array(
- 'shadow' => true,
- ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'supports' => $supports,
</ins><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $registry = WP_Block_Type_Registry::get_instance();
- $block_type = $registry->get_registered( $this->test_block_name );
- $block_atts = array(
- 'style' => array(
- 'shadow' => '60px -16px teal',
- ),
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $registry = WP_Block_Type_Registry::get_instance();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $actual = wp_apply_shadow_support( $block_type, $block_atts );
- $expected = array(
- 'style' => 'box-shadow:60px -16px teal;',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $registry->get_registered( $this->test_block_name );
+ }
+
+ /**
+ * Tests the generation of shadow block support styles.
+ *
+ * @dataProvider data_generate_shadow_fixtures
+ *
+ * @param boolean|array $support Shadow block support configuration.
+ * @param string $value Shadow style value for style attribute object.
+ * @param array $expected Expected shadow block support styles.
+ */
+ public function test_wp_apply_shadow_support( $support, $value, $expected ) {
+ $block_type = self::register_shadow_block_with_support(
+ 'test/shadow-block',
+ array( 'shadow' => $support )
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $block_attrs = array( 'style' => array( 'shadow' => $value ) );
+ $actual = wp_apply_shadow_support( $block_type, $block_attrs );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $expected, $actual );
</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><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @ticket 58590
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Data provider.
+ *
+ * @return array
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public function test_shadow_without_block_supports() {
- $this->test_block_name = 'test/shadow-with-skipped-serialization-block-supports';
- register_block_type(
- $this->test_block_name,
- array(
- 'api_version' => 2,
- 'attributes' => array(
- 'style' => array(
- 'type' => 'object',
- ),
- ),
- 'supports' => array(),
- )
- );
- $registry = WP_Block_Type_Registry::get_instance();
- $block_type = $registry->get_registered( $this->test_block_name );
- $block_atts = array(
- 'style' => array(
- 'shadow' => '60px -16px teal',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function data_generate_shadow_fixtures() {
+ return array(
+ 'with no styles' => array(
+ 'support' => true,
+ 'value' => '',
+ 'expected' => array(),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'without support' => array(
+ 'support' => false,
+ 'value' => '1px 1px 1px #000',
+ 'expected' => array(),
+ ),
+ 'with single shadow' => array(
+ 'support' => true,
+ 'value' => '1px 1px 1px #000',
+ 'expected' => array( 'style' => 'box-shadow:1px 1px 1px #000;' ),
+ ),
+ 'with comma separated shadows' => array(
+ 'support' => true,
+ 'value' => '1px 1px 1px #000, 2px 2px 2px #fff',
+ 'expected' => array( 'style' => 'box-shadow:1px 1px 1px #000, 2px 2px 2px #fff;' ),
+ ),
+ 'with preset shadow' => array(
+ 'support' => true,
+ 'value' => 'var:preset|shadow|natural',
+ 'expected' => array( 'style' => 'box-shadow:var(--wp--preset--shadow--natural);' ),
+ ),
+ 'with serialization skipped' => array(
+ 'support' => array( '__experimentalSkipSerialization' => true ),
+ 'value' => '1px 1px 1px #000',
+ 'expected' => array(),
+ ),
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
- $actual = wp_apply_spacing_support( $block_type, $block_atts );
- $expected = array();
-
- $this->assertSame( $expected, $actual );
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>