<!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>[58801] trunk: block.json: Allow passing PHP filename as `variations` field.</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/58801">58801</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/58801","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>Bernhard Reiter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-07-24 14:09:58 +0000 (Wed, 24 Jul 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'>block.json: Allow passing PHP filename as `variations` field.
Previously, the `variations` field in a block.json file could be used to provide a static list of the block's variations (i.e., an array). Alternatively, the block's `variation_callback` could be set during server-side block registration to point to a PHP function to generate those variations.
This changeset makes it so that the block.json `variations` field can be alternatively set to a string, which will be interpreted as the filename of a PHP file that generates the variations.
It is loosely modeled after <a href="https://core.trac.wordpress.org/changeset/54132">[54132]</a>, which introduced the `render` field for `block.json`, as a way to point to a PHP file instead of providing a `render_callback`.
Props bernhard-reiter, gziolo.
Fixes <a href="https://core.trac.wordpress.org/ticket/61280">#61280</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>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunitdatablocksnoticevariationsphp">trunk/tests/phpunit/data/blocks/notice/variations.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-07-24 14:05:18 UTC (rev 58800)
+++ trunk/src/wp-includes/blocks.php 2024-07-24 14:09:58 UTC (rev 58801)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -385,6 +385,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.3.0 Added `selectors` field.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.4.0 Added support for `blockHooks` field.
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.5.0 Added support for `allowedBlocks`, `viewScriptModule`, and `viewStyle` fields.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.7.0 Allow PHP filename as `variations` argument.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $file_or_folder Path to the JSON file with metadata definition for
</span><span class="cx" style="display: block; padding: 0 10px"> * the block or path to the folder where the `block.json` file is located.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -522,6 +523,34 @@
</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">+ // If `variations` is a string, it's the name of a PHP file that
+ // generates the variations.
+ if ( ! empty( $metadata['variations'] ) && is_string( $metadata['variations'] ) ) {
+ $variations_path = wp_normalize_path(
+ realpath(
+ dirname( $metadata['file'] ) . '/' .
+ remove_block_asset_path_prefix( $metadata['variations'] )
+ )
+ );
+ if ( $variations_path ) {
+ /**
+ * Generates the list of block variations.
+ *
+ * @since 6.7.0
+ *
+ * @return string Returns the list of block variations.
+ */
+ $settings['variation_callback'] = static function () use ( $variations_path ) {
+ $variations = require $variations_path;
+ return $variations;
+ };
+ // The block instance's `variations` field is only allowed to be an array
+ // (of known block variations). We unset it so that the block instance will
+ // provide a getter that returns the result of the `variation_callback` instead.
+ unset( $settings['variations'] );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $settings = array_merge( $settings, $args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $script_fields = array(
</span></span></pre></div>
<a id="trunktestsphpunitdatablocksnoticevariationsphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/data/blocks/notice/variations.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/data/blocks/notice/variations.php (rev 0)
+++ trunk/tests/phpunit/data/blocks/notice/variations.php 2024-07-24 14:09:58 UTC (rev 58801)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,10 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+return array(
+ array(
+ 'name' => 'warning',
+ 'title' => 'warning',
+ 'description' => 'Shows warning.',
+ 'keywords' => array( 'warning' ),
+ ),
+);
</ins></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 2024-07-24 14:05:18 UTC (rev 58800)
+++ trunk/tests/phpunit/tests/blocks/register.php 2024-07-24 14:09:58 UTC (rev 58801)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -958,6 +958,37 @@
</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 registering a block with variations from a PHP file.
+ *
+ * @ticket 61280
+ *
+ * @covers ::register_block_type_from_metadata
+ */
+ public function test_register_block_type_from_metadata_with_variations_php_file() {
+ $filter_metadata_registration = static function ( $metadata ) {
+ $metadata['variations'] = 'file:./variations.php';
+ return $metadata;
+ };
+
+ add_filter( 'block_type_metadata', $filter_metadata_registration, 10, 2 );
+ $result = register_block_type_from_metadata(
+ DIR_TESTDATA . '/blocks/notice'
+ );
+ remove_filter( 'block_type_metadata', $filter_metadata_registration );
+
+ $this->assertInstanceOf( 'WP_Block_Type', $result, 'The block was not registered' );
+
+ $this->assertIsCallable( $result->variation_callback, 'The variation callback hasn\'t been set' );
+ $expected_variations = require DIR_TESTDATA . '/blocks/notice/variations.php';
+ $this->assertSame(
+ $expected_variations,
+ call_user_func( $result->variation_callback ),
+ 'The variation callback hasn\'t been set correctly'
+ );
+ $this->assertSame( $expected_variations, $result->variations, 'The block variations are incorrect' );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Tests that the function returns the registered block when the `block.json`
</span><span class="cx" style="display: block; padding: 0 10px"> * is found in the fixtures directory.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre>
</div>
</div>
</body>
</html>