Changeset 57026

Timestamp:

10/28/2023 01:00:14 AM (9 months ago)

Author:

SergeyBiryukov

Message:

Blocks: Parse the arguments earlier in register_block_type_from_metadata().

This makes it possible to register a block by passing an array of arguments, without the presence of a block.json file.

Follow-up to [48141], [49948].

Props aristath, spacedmonkey, mukesh27, costdev, audrasjb, oglekler, felipeelia, hellofromTonya.
Fixes #56865.

Location:

trunk

Files:

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

trunk/src/wp-includes/blocks.php

@@ -353 +353 @@
 
     $is_core_block = str_starts_with( $file_or_folder, ABSPATH . WPINC );
-
-    if ( ! $is_core_block && ! file_exists( $metadata_file ) ) {
+    // If the block is not a core block, the metadata file must exist.
+    $metadata_file_exists = $is_core_block || file_exists( $metadata_file );
+    if ( ! $metadata_file_exists && empty( $args['name'] ) ) {
         return false;
     }
 
     // Try to get metadata from the static cache for core blocks.
-    $metadata = false;
+    $metadata = ;
     if ( $is_core_block ) {
         $core_block_name = str_replace( ABSPATH . WPINC . '/blocks/', '', $file_or_folder );
@@ -368 +369 @@
 
     // If metadata is not found in the static cache, read it from the file.
-    if ( ! $metadata ) {
+    if (  ) {
         $metadata = wp_json_file_decode( $metadata_file, array( 'associative' => true ) );
     }
 
-    if ( ! is_array( $metadata ) || empty( $metadata['name'] ) ) {
+    if ( ! is_array( $metadata ) ||  ) ) {
         return false;
     }
-    $metadata['file'] = wp_normalize_path( realpath( $metadata_file ) );
+
+    $metadata['file'] = $metadata_file_exists ? wp_normalize_path( realpath( $metadata_file ) ) : null;
 
     /**
@@ -405 +407 @@
     $property_mappings = array(
         'apiVersion'      => 'api_version',
+
         'title'           => 'title',
         'category'        => 'category',
@@ -427 +430 @@
         if ( isset( $metadata[ $key ] ) ) {
             $settings[ $mapped_key ] = $metadata[ $key ];
-            if ( $textdomain && isset( $i18n_schema->$key ) ) {
+            if ( $textdomain && isset( $i18n_schema->$key ) ) {
                 $settings[ $mapped_key ] = translate_settings_using_i18n_schema( $i18n_schema->$key, $settings[ $key ], $textdomain );
             }
-        }
-    }
-
-    $script_fields = array(
-        'editorScript' => 'editor_script_handles',
-        'script'       => 'script_handles',
-        'viewScript'   => 'view_script_handles',
-    );
-    foreach ( $script_fields as $metadata_field_name => $settings_field_name ) {
-        if ( ! empty( $metadata[ $metadata_field_name ] ) ) {
-            $scripts           = $metadata[ $metadata_field_name ];
-            $processed_scripts = array();
-            if ( is_array( $scripts ) ) {
-                for ( $index = 0; $index < count( $scripts ); $index++ ) {
-                    $result = register_block_script_handle(
-                        $metadata,
-                        $metadata_field_name,
-                        $index
-                    );
-                    if ( $result ) {
-                        $processed_scripts[] = $result;
-                    }
-                }
-            } else {
-                $result = register_block_script_handle(
-                    $metadata,
-                    $metadata_field_name
-                );
-                if ( $result ) {
-                    $processed_scripts[] = $result;
-                }
-            }
-            $settings[ $settings_field_name ] = $processed_scripts;
-        }
-    }
-
-    $style_fields = array(
-        'editorStyle' => 'editor_style_handles',
-        'style'       => 'style_handles',
-    );
-    foreach ( $style_fields as $metadata_field_name => $settings_field_name ) {
-        if ( ! empty( $metadata[ $metadata_field_name ] ) ) {
-            $styles           = $metadata[ $metadata_field_name ];
-            $processed_styles = array();
-            if ( is_array( $styles ) ) {
-                for ( $index = 0; $index < count( $styles ); $index++ ) {
-                    $result = register_block_style_handle(
-                        $metadata,
-                        $metadata_field_name,
-                        $index
-                    );
-                    if ( $result ) {
-                        $processed_styles[] = $result;
-                    }
-                }
-            } else {
-                $result = register_block_style_handle(
-                    $metadata,
-                    $metadata_field_name
-                );
-                if ( $result ) {
-                    $processed_styles[] = $result;
-                }
-            }
-            $settings[ $settings_field_name ] = $processed_styles;
-        }
-    }
-
-    if ( ! empty( $metadata['blockHooks'] ) ) {
-        /**
-         * Map camelCased position string (from block.json) to snake_cased block type position.
-         *
-         * @var array
-         */
-        $position_mappings = array(
-            'before'     => 'before',
-            'after'      => 'after',
-            'firstChild' => 'first_child',
-            'lastChild'  => 'last_child',
-        );
-
-        $settings['block_hooks'] = array();
-        foreach ( $metadata['blockHooks'] as $anchor_block_name => $position ) {
-            // Avoid infinite recursion (hooking to itself).
-            if ( $metadata['name'] === $anchor_block_name ) {
-                _doing_it_wrong(
-                    __METHOD__,
-                    __( 'Cannot hook block to itself.' ),
-                    '6.4.0'
-                );
-                continue;
-            }
-
-            if ( ! isset( $position_mappings[ $position ] ) ) {
-                continue;
-            }
-
-            $settings['block_hooks'][ $anchor_block_name ] = $position_mappings[ $position ];
         }
     }
@@ -558 +463 @@
     }
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     /**
      * Filters the settings determined from the block type metadata.
@@ -566 +577 @@
      * @param array $metadata Metadata provided for registering a block type.
      */
-    $settings = apply_filters(
-        'block_type_metadata_settings',
-        array_merge(
-            $settings,
-            $args
-        ),
-        $metadata
-    );
+    $settings = apply_filters( 'block_type_metadata_settings', $settings, $metadata );
+
+    $metadata['name'] = ! empty( $settings['name'] ) ? $settings['name'] : $metadata['name'];
 
     return WP_Block_Type_Registry::get_instance()->register(

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

@@ -601 +601 @@
 
     /**
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      * Tests that the function returns the registered block when the `block.json`
      * is found in the fixtures directory.