Changeset 57565 for trunk/src/wp-includes/blocks.php

Timestamp:

02/08/2024 10:39:24 AM (3 years ago)

Author:

gziolo

Message:

Editor: Add viewScriptModule handling to block.json metadata

Syncing changes from the Gutenberg plugin: ​https://github.com/WordPress/gutenberg/pull/57437.

Scripts and styles can be registered for blocks via block.json metadata. There is now a Modules API, but was no way to register or associate module assets with blocks via block.json.

Fixes #60233.
Props jonsurrell, gziolo, cbravobernal, luisherranz, youknowriad.

File:

• trunk/src/wp-includes/blocks.php (modified) (6 diffs)

trunk/src/wp-includes/blocks.php

@@ -37 +37 @@
  * @since 5.5.0
  * @since 6.1.0 Added `$index` parameter.
+ * @since 6.5.0 Added support for `viewScriptModule` field.
  *
  * @param string $block_name Name of the block.
@@ -53 +54 @@
                         $asset_handle .= '-view';
                 }
+                if ( str_ends_with( strtolower( $field_name ), 'scriptmodule' ) ) {
+                        $asset_handle .= '-script-module';
+                }
                 if ( $index > 0 ) {
                         $asset_handle .= '-' . ( $index + 1 );
@@ -60 +64 @@
 
         $field_mappings = array(
-                'editorScript' => 'editor-script',
-                'script'       => 'script',
-                'viewScript'   => 'view-script',
-                'editorStyle'  => 'editor-style',
-                'style'        => 'style',
-                'viewStyle'    => 'view-style',
+                'editorScript'     => 'editor-script',
+                'editorStyle'      => 'editor-style',
+                'script'           => 'script',
+                'style'            => 'style',
+                'viewScript'       => 'view-script',
+                'viewScriptModule' => 'view-script-module',
+                'viewStyle'        => 'view-style',
         );
         $asset_handle   = str_replace( '/', '-', $block_name ) .
@@ -121 +126 @@
 
         return plugins_url( basename( $path ), $path );
+}
+
+/**
+ * Finds a script module ID for the selected block metadata field. It detects
+ * when a path to file was provided and optionally finds a corresponding asset
+ * file with details necessary to register the script module under with an
+ * automatically generated module ID. It returns unprocessed script module
+ * ID otherwise.
+ *
+ * @since 6.5.0
+ *
+ * @param array  $metadata   Block metadata.
+ * @param string $field_name Field name to pick from metadata.
+ * @param int    $index      Optional. Index of the script module ID to register when multiple
+ *                           items passed. Default 0.
+ * @return string|false Script module ID or false on failure.
+ */
+function register_block_script_module_id( $metadata, $field_name, $index = 0 ) {
+        if ( empty( $metadata[ $field_name ] ) ) {
+                return false;
+        }
+
+        $module_id = $metadata[ $field_name ];
+        if ( is_array( $module_id ) ) {
+                if ( empty( $module_id[ $index ] ) ) {
+                        return false;
+                }
+                $module_id = $module_id[ $index ];
+        }
+
+        $module_path = remove_block_asset_path_prefix( $module_id );
+        if ( $module_id === $module_path ) {
+                return $module_id;
+        }
+
+        $path                  = dirname( $metadata['file'] );
+        $module_asset_raw_path = $path . '/' . substr_replace( $module_path, '.asset.php', - strlen( '.js' ) );
+        $module_id             = generate_block_asset_handle( $metadata['name'], $field_name, $index );
+        $module_asset_path     = wp_normalize_path(
+                realpath( $module_asset_raw_path )
+        );
+
+        $module_path_norm = wp_normalize_path( realpath( $path . '/' . $module_path ) );
+        $module_uri       = get_block_asset_url( $module_path_norm );
+
+        $module_asset        = ! empty( $module_asset_path ) ? require $module_asset_path : array();
+        $module_dependencies = isset( $module_asset['dependencies'] ) ? $module_asset['dependencies'] : array();
+
+        wp_register_script_module(
+                $module_id,
+                $module_uri,
+                $module_dependencies,
+                isset( $module_asset['version'] ) ? $module_asset['version'] : false
+        );
+
+        return $module_id;
 }
 
@@ -315 +376 @@
  * @since 6.3.0 Added `selectors` field.
  * @since 6.4.0 Added support for `blockHooks` field.
- * @since 6.5.0 Added support for `allowedBlocks` and `viewStyle` fields.
+ * @since 6.5.0 Added support for `allowedBlocks`, `viewScriptModule`, and `viewStyle` fields.
  *
  * @param string $file_or_folder Path to the JSON file with metadata definition for
@@ -491 +552 @@
         }
 
+        $module_fields = array(
+                'viewScriptModule' => 'view_script_module_ids',
+        );
+        foreach ( $module_fields as $metadata_field_name => $settings_field_name ) {
+                if ( ! empty( $settings[ $metadata_field_name ] ) ) {
+                        $metadata[ $metadata_field_name ] = $settings[ $metadata_field_name ];
+                }
+                if ( ! empty( $metadata[ $metadata_field_name ] ) ) {
+                        $modules           = $metadata[ $metadata_field_name ];
+                        $processed_modules = array();
+                        if ( is_array( $modules ) ) {
+                                for ( $index = 0; $index < count( $modules ); $index++ ) {
+                                        $result = register_block_script_module_id(
+                                                $metadata,
+                                                $metadata_field_name,
+                                                $index
+                                        );
+                                        if ( $result ) {
+                                                $processed_modules[] = $result;
+                                        }
+                                }
+                        } else {
+                                $result = register_block_script_module_id(
+                                        $metadata,
+                                        $metadata_field_name
+                                );
+                                if ( $result ) {
+                                        $processed_modules[] = $result;
+                                }
+                        }
+                        $settings[ $settings_field_name ] = $processed_modules;
+                }
+        }
+
         $style_fields = array(
                 'editorStyle' => 'editor_style_handles',