<!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>[57559] trunk: Editor: Make asset file optional for block scripts</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/57559">57559</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/57559","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>gziolo</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-02-08 08:16:59 +0000 (Thu, 08 Feb 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: Make asset file optional for block scripts
It is no longer a hard requirement that a *.asset.php file is present to register a script for block.
Fixes <a href="https://core.trac.wordpress.org/ticket/57234">#57234</a>.
Props joefusco, gziolo, spacedmonkey, colorful-tones. </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>
</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-02-08 07:36:36 UTC (rev 57558)
+++ trunk/src/wp-includes/blocks.php 2024-02-08 08:16:59 UTC (rev 57559)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -124,12 +124,13 @@
</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"> * Finds a script handle for the selected block metadata field. It detects
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * when a path to file was provided and finds a corresponding asset file
- * with details necessary to register the script under automatically
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * when a path to file was provided and optionally finds a corresponding asset
+ * file with details necessary to register the script under automatically
</ins><span class="cx" style="display: block; padding: 0 10px"> * generated handle name. It returns unprocessed script handle otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.1.0 Added `$index` parameter.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 6.5.0 The asset file is optional.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $metadata Block metadata.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $field_name Field name to pick from metadata.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -163,21 +164,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> realpath( $script_asset_raw_path )
</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">- if ( empty( $script_asset_path ) ) {
- _doing_it_wrong(
- __FUNCTION__,
- sprintf(
- /* translators: 1: Asset file location, 2: Field name, 3: Block name. */
- __( 'The asset file (%1$s) for the "%2$s" defined in "%3$s" block definition is missing.' ),
- $script_asset_raw_path,
- $field_name,
- $metadata['name']
- ),
- '5.5.0'
- );
- return false;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> $script_path_norm = wp_normalize_path( realpath( $path . '/' . $script_path ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $script_uri = get_block_asset_url( $script_path_norm );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -186,7 +172,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $script_args['strategy'] = 'defer';
</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">- $script_asset = require $script_asset_path;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Asset file for blocks is optional. See https://core.trac.wordpress.org/ticket/60460.
+ $script_asset = ! empty( $script_asset_path ) ? require $script_asset_path : array();
</ins><span class="cx" style="display: block; padding: 0 10px"> $script_dependencies = isset( $script_asset['dependencies'] ) ? $script_asset['dependencies'] : array();
</span><span class="cx" style="display: block; padding: 0 10px"> $result = wp_register_script(
</span><span class="cx" style="display: block; padding: 0 10px"> $script_handle,
</span></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-02-08 07:36:36 UTC (rev 57558)
+++ trunk/tests/phpunit/tests/blocks/register.php 2024-02-08 08:16:59 UTC (rev 57559)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,6 +60,12 @@
</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">+ foreach ( wp_scripts()->registered as $script_handle => $script ) {
+ if ( str_starts_with( $script_handle, 'unit-tests-' ) ) {
+ wp_deregister_script( $script_handle );
+ }
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> parent::tear_down();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -226,23 +232,8 @@
</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">- * @expectedIncorrectUsage register_block_script_handle
</del><span class="cx" style="display: block; padding: 0 10px"> * @ticket 50263
</span><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_missing_asset_file_register_block_script_handle() {
- $metadata = array(
- 'file' => __FILE__,
- 'name' => 'unit-tests/test-block',
- 'script' => 'file:./blocks/notice/missing-asset.js',
- );
- $result = register_block_script_handle( $metadata, 'script' );
-
- $this->assertFalse( $result );
- }
-
- /**
- * @ticket 50263
- */
</del><span class="cx" style="display: block; padding: 0 10px"> public function test_handle_passed_register_block_script_handle() {
</span><span class="cx" style="display: block; padding: 0 10px"> $metadata = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'script' => 'test-script-handle',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -266,7 +257,22 @@
</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"> * @ticket 50263
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 60460
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public function test_missing_asset_file_register_block_script_handle_with_default_settings() {
+ $metadata = array(
+ 'file' => __FILE__,
+ 'name' => 'unit-tests/test-block',
+ 'script' => 'file:./blocks/notice/missing-asset.js',
+ );
+ $result = register_block_script_handle( $metadata, 'script' );
+
+ $this->assertSame( 'unit-tests-test-block-script', $result );
+ }
+
+ /**
+ * @ticket 50263
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> public function test_success_register_block_script_handle() {
</span><span class="cx" style="display: block; padding: 0 10px"> $metadata = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'file' => DIR_TESTDATA . '/blocks/notice/block.json',
</span></span></pre>
</div>
</div>
</body>
</html>