Changeset 57559

Timestamp:

02/08/2024 08:16:59 AM (8 months ago)

Author:

gziolo

Message:

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 #57234.
Props joefusco, gziolo, spacedmonkey, colorful-tones.

Location:

trunk

Files:

• src/wp-includes/blocks.php (modified) (3 diffs)
• tests/phpunit/tests/blocks/register.php (modified) (3 diffs)

trunk/src/wp-includes/blocks.php

@@ -125 +125 @@
 /**
  * Finds a script handle for the selected block metadata field. It detects
- * when a path to file was provided and finds a corresponding asset file
- * with details necessary to register the script under automatically
+ * when a path to file was provided and optionally finds a corresponding asset
+ * file with details necessary to register the script under automatically
  * generated handle name. It returns unprocessed script handle otherwise.
  *
  * @since 5.5.0
  * @since 6.1.0 Added `$index` parameter.
+ * @since 6.5.0 The asset file is optional.
  *
  * @param array  $metadata   Block metadata.
@@ -164 +165 @@
     );
 
-    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;
-    }
-
     $script_path_norm = wp_normalize_path( realpath( $path . '/' . $script_path ) );
     $script_uri       = get_block_asset_url( $script_path_norm );
@@ -187 +173 @@
     }
 
-    $script_asset        = require $script_asset_path;
+    // 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();
     $script_dependencies = isset( $script_asset['dependencies'] ) ? $script_asset['dependencies'] : array();
     $result              = wp_register_script(

trunk/tests/phpunit/tests/blocks/register.php

@@ -61 +61 @@
         }
 
+        foreach ( wp_scripts()->registered as $script_handle => $script ) {
+            if ( str_starts_with( $script_handle, 'unit-tests-' ) ) {
+                wp_deregister_script( $script_handle );
+            }
+        }
+
         parent::tear_down();
     }
@@ -227 +233 @@
 
     /**
-     * @expectedIncorrectUsage register_block_script_handle
-     * @ticket 50263
-     */
-    public function test_missing_asset_file_register_block_script_handle() {
+     * @ticket 50263
+     */
+    public function test_handle_passed_register_block_script_handle() {
+        $metadata = array(
+            'script' => 'test-script-handle',
+        );
+        $result   = register_block_script_handle( $metadata, 'script' );
+
+        $this->assertSame( 'test-script-handle', $result );
+    }
+
+    public function test_handles_passed_register_block_script_handles() {
+        $metadata = array(
+            'script' => array( 'test-script-handle', 'test-script-handle-2' ),
+        );
+
+        $result = register_block_script_handle( $metadata, 'script' );
+        $this->assertSame( 'test-script-handle', $result );
+
+        $result = register_block_script_handle( $metadata, 'script', 1 );
+        $this->assertSame( 'test-script-handle-2', $result, 1 );
+    }
+
+    /**
+     * @ticket 50263
+     * @ticket 60460
+     */
+    public function test_missing_asset_file_register_block_script_handle_with_default_settings() {
         $metadata = array(
             'file'   => __FILE__,
@@ -238 +268 @@
         $result   = register_block_script_handle( $metadata, 'script' );
 
-        $this->assertFalse( $result );
-    }
-
-    /**
-     * @ticket 50263
-     */
-    public function test_handle_passed_register_block_script_handle() {
-        $metadata = array(
-            'script' => 'test-script-handle',
-        );
-        $result   = register_block_script_handle( $metadata, 'script' );
-
-        $this->assertSame( 'test-script-handle', $result );
-    }
-
-    public function test_handles_passed_register_block_script_handles() {
-        $metadata = array(
-            'script' => array( 'test-script-handle', 'test-script-handle-2' ),
-        );
-
-        $result = register_block_script_handle( $metadata, 'script' );
-        $this->assertSame( 'test-script-handle', $result );
-
-        $result = register_block_script_handle( $metadata, 'script', 1 );
-        $this->assertSame( 'test-script-handle-2', $result, 1 );
+        $this->assertSame( 'unit-tests-test-block-script', $result );
     }