<!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>[59938] trunk: Editor: Fix block type and block metadata collection registration issues on Windows due to lack of path normalization.</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/59938">59938</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/59938","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>flixos90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2025-03-05 22:15:09 +0000 (Wed, 05 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'>Editor: Fix block type and block metadata collection registration issues on Windows due to lack of path normalization.
Props flixos90, gziolo, joemcgill.
Fixes <a href="https://core.trac.wordpress.org/ticket/63027">#63027</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocksphp">trunk/src/wp-includes/blocks.php</a></li>
<li><a href="#trunksrcwpincludesclasswpblockmetadataregistryphp">trunk/src/wp-includes/class-wp-block-metadata-registry.php</a></li>
<li><a href="#trunktestsphpunittestsblocksregisterphp">trunk/tests/phpunit/tests/blocks/register.php</a></li>
<li><a href="#trunktestsphpunittestsblockswpBlockMetadataRegistryphp">trunk/tests/phpunit/tests/blocks/wpBlockMetadataRegistry.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 2025-03-05 22:12:06 UTC (rev 59937)
+++ trunk/src/wp-includes/blocks.php 2025-03-05 22:15:09 UTC (rev 59938)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -445,11 +445,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Using a static variable ensures that the metadata is only read once per request.
</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">+ $file_or_folder = wp_normalize_path( $file_or_folder );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $metadata_file = ( ! str_ends_with( $file_or_folder, 'block.json' ) ) ?
</span><span class="cx" style="display: block; padding: 0 10px"> trailingslashit( $file_or_folder ) . 'block.json' :
</span><span class="cx" style="display: block; padding: 0 10px"> $file_or_folder;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $is_core_block = str_starts_with( $file_or_folder, ABSPATH . WPINC );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $is_core_block = str_starts_with( $file_or_folder, wp_normalize_path( ABSPATH . WPINC ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $metadata_file_exists = $is_core_block || file_exists( $metadata_file );
</span><span class="cx" style="display: block; padding: 0 10px"> $registry_metadata = WP_Block_Metadata_Registry::get_metadata( $file_or_folder );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpblockmetadataregistryphp"></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-metadata-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-metadata-registry.php 2025-03-05 22:12:06 UTC (rev 59937)
+++ trunk/src/wp-includes/class-wp-block-metadata-registry.php 2025-03-05 22:15:09 UTC (rev 59938)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -82,7 +82,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if the collection was registered successfully, false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function register_collection( $path, $manifest ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $path = wp_normalize_path( rtrim( $path, '/' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $path = rtrim( wp_normalize_path( $path ), '/' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $collection_roots = self::get_default_collection_roots();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -112,7 +112,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $collection_roots = array_unique(
</span><span class="cx" style="display: block; padding: 0 10px"> array_map(
</span><span class="cx" style="display: block; padding: 0 10px"> static function ( $allowed_root ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return rtrim( $allowed_root, '/' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return rtrim( wp_normalize_path( $allowed_root ), '/' );
</ins><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> $collection_roots
</span><span class="cx" style="display: block; padding: 0 10px"> )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -161,6 +161,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array|null The block metadata for the block, or null if not found.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function get_metadata( $file_or_folder ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $file_or_folder = wp_normalize_path( $file_or_folder );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $path = self::find_collection_path( $file_or_folder );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $path ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return null;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -194,7 +196,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string[] List of block metadata file paths, or an empty array if the given `$path` is invalid.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function get_collection_block_metadata_files( $path ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $path = wp_normalize_path( rtrim( $path, '/' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $path = rtrim( wp_normalize_path( $path ), '/' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( self::$collections[ $path ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> _doing_it_wrong(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -213,6 +215,7 @@
</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"> return array_map(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // No normalization necessary since `$path` is already normalized and `$block_name` is just a folder name.
</ins><span class="cx" style="display: block; padding: 0 10px"> static function ( $block_name ) use ( $path ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return "{$path}/{$block_name}/block.json";
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -225,8 +228,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.7.0
</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 $file_or_folder The path to the file or folder.
- * @return string|null The collection path if found, or null if not found.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $file_or_folder The normalized path to the file or folder.
+ * @return string|null The normalized collection path if found, or null if not found.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> private static function find_collection_path( $file_or_folder ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $file_or_folder ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -234,7 +237,7 @@
</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"> // Check the last matched collection first, since block registration usually happens in batches per plugin or theme.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $path = wp_normalize_path( rtrim( $file_or_folder, '/' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $path = rtrim( $file_or_folder, '/' );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( self::$last_matched_collection && str_starts_with( $path, self::$last_matched_collection ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return self::$last_matched_collection;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -279,7 +282,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.7.0
</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 $path The file or folder path to determine the block identifier from.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $path The normalized file or folder path to determine the block identifier from.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string The block identifier, or an empty string if the path is empty.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> private static function default_identifier_callback( $path ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -302,8 +305,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.7.2
</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 $path Block metadata collection path, without trailing slash.
- * @param string[] $collection_roots List of collection root paths, without trailing slashes.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $path Normalized block metadata collection path, without trailing slash.
+ * @param string[] $collection_roots List of normalized collection root paths, without trailing slashes.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if the path is allowed, false otherwise.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> private static function is_valid_collection_path( $path, $collection_roots ) {
</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 2025-03-05 22:12:06 UTC (rev 59937)
+++ trunk/tests/phpunit/tests/blocks/register.php 2025-03-05 22:15:09 UTC (rev 59938)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1501,4 +1501,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $block_type->block_hooks
</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">+
+ /**
+ * @ticket 63027
+ *
+ * @covers ::register_block_type_from_metadata
+ */
+ public function test_register_block_type_from_metadata_with_windows_path() {
+ $windows_like_path = str_replace( '/', '\\', DIR_TESTDATA ) . '\\blocks\\notice';
+
+ $this->assertNotFalse( register_block_type_from_metadata( $windows_like_path ) );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsblockswpBlockMetadataRegistryphp"></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/wpBlockMetadataRegistry.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/wpBlockMetadataRegistry.php 2025-03-05 22:12:06 UTC (rev 59937)
+++ trunk/tests/phpunit/tests/blocks/wpBlockMetadataRegistry.php 2025-03-05 22:15:09 UTC (rev 59938)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -220,4 +220,72 @@
</span><span class="cx" style="display: block; padding: 0 10px"> WP_Block_Metadata_Registry::get_collection_block_metadata_files( $path )
</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 that `register_collection()`, `get_metadata()`, and `get_collection_metadata_files()` handle Windows paths.
+ *
+ * @ticket 63027
+ * @covers ::register_collection
+ * @covers ::get_metadata
+ * @covers ::get_collection_metadata_files
+ */
+ public function test_with_windows_paths() {
+ // Set up a mock manifest file.
+ $manifest_data = array(
+ 'test-block' => array(
+ 'name' => 'test-block',
+ 'title' => 'Test Block',
+ ),
+ );
+ file_put_contents( $this->temp_manifest_file, '<?php return ' . var_export( $manifest_data, true ) . ';' );
+
+ $plugins_path = 'C:\\Site\\wp-content\\plugins';
+ $plugin_path = $plugins_path . '\\my-plugin\\blocks';
+ $block_path = $plugin_path . '\\test-block\\block.json';
+
+ // Register the mock plugins directory as an allowed root.
+ add_filter(
+ 'wp_allowed_block_metadata_collection_roots',
+ static function ( $paths ) use ( $plugins_path ) {
+ $paths[] = $plugins_path;
+ return $paths;
+ }
+ );
+
+ $this->assertTrue( WP_Block_Metadata_Registry::register_collection( $plugin_path, $this->temp_manifest_file ), 'Could not register block metadata collection.' );
+ $this->assertSame( $manifest_data['test-block'], WP_Block_Metadata_Registry::get_metadata( $block_path ), 'Could not find collection for provided block.json path.' );
+ $this->assertSame( array( wp_normalize_path( $block_path ) ), WP_Block_Metadata_Registry::get_collection_block_metadata_files( $plugin_path ), 'Could not get correct list of block.json paths for collection.' );
+ }
+
+ /**
+ * Tests that `register_collection()` handles Windows paths correctly for verifying allowed roots.
+ *
+ * @ticket 63027
+ * @covers ::register_collection
+ */
+ public function test_with_windows_paths_and_disallowed_location() {
+ $parent_path = 'C:\\Site\\wp-content';
+ $plugins_path = $parent_path . '\\plugins';
+ $plugin_path = $plugins_path . '\\my-plugin\\blocks';
+
+ // Register the mock plugins directory as an allowed root.
+ add_filter(
+ 'wp_allowed_block_metadata_collection_roots',
+ static function ( $paths ) use ( $plugins_path ) {
+ $paths[] = $plugins_path;
+ return $paths;
+ }
+ );
+
+ $this->setExpectedIncorrectUsage( 'WP_Block_Metadata_Registry::register_collection' );
+
+ $result = WP_Block_Metadata_Registry::register_collection( $plugins_path, $this->temp_manifest_file );
+ $this->assertFalse( $result, 'Arbitrary Windows path should not be registered if it matches a collection root' );
+
+ $result = WP_Block_Metadata_Registry::register_collection( $parent_path, $this->temp_manifest_file );
+ $this->assertFalse( $result, 'Arbitrary Windows path should not be registered if it is a parent directory of a collection root' );
+
+ $result = WP_Block_Metadata_Registry::register_collection( $plugin_path, $this->temp_manifest_file );
+ $this->assertTrue( $result, 'Arbitrary Windows path should be registered successfully if it is within a collection root' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>