Changeset 59083 for trunk/src/wp-includes/script-modules.php

Timestamp:

09/24/2024 07:33:55 AM (17 months ago)

Author:

gziolo

Message:

Build: Prepare for more Script Modules

This is a companion to ​https://github.com/WordPress/gutenberg/pull/65460 that requires syncing in WordPress Core. Namely, the block-library changes require registration with their updated script module IDs so that the blocks continue to work correctly.

They key improvement is script modules registration is handled in one central place, and a combined asset file is used to improve the performance by avoiding multiple disk operations for every individual file.

Props jonsurrell, gziolo, wildworks, noisysocks.
See #60647, #59462.

File:

• trunk/src/wp-includes/script-modules.php (modified) (1 diff)

trunk/src/wp-includes/script-modules.php

@@ -124 +124 @@
     wp_script_modules()->deregister( $id );
 }
+
+/**
+ * Registers all the default WordPress Script Modules.
+ *
+ * @since 6.7.0
+ */
+function wp_default_script_modules() {
+    $suffix = defined( 'WP_RUN_CORE_TESTS' ) ? '.min' : wp_scripts_get_suffix();
+
+    /*
+     * Expects multidimensional array like:
+     *
+     *     'interactivity/index.min.js' => array('dependencies' => array(…), 'version' => '…'),
+     *     'interactivity/debug.min.js' => array('dependencies' => array(…), 'version' => '…'),
+     *     'interactivity-router/index.min.js' => …
+     */
+    $assets = include ABSPATH . WPINC . "/assets/script-modules-packages{$suffix}.php";
+
+    foreach ( $assets as $file_name => $script_module_data ) {
+        /*
+         * Build the WordPress Script Module ID from the file name.
+         * Prepend `@wordpress/` and remove extensions and `/index` if present:
+         *   - interactivity/index.min.js  => @wordpress/interactivity
+         *   - interactivity/debug.min.js  => @wordpress/interactivity/debug
+         *   - block-library/query/view.js => @wordpress/block-library/query/view
+         */
+        $script_module_id = '@wordpress/' . preg_replace( '~(?:/index)?(?:\.min)?\.js$~D', '', $file_name, 1 );
+
+        switch ( $script_module_id ) {
+            /*
+             * Interactivity exposes two entrypoints, "/index" and "/debug".
+             * "/debug" should replalce "/index" in devlopment.
+             */
+            case '@wordpress/interactivity/debug':
+                if ( ! SCRIPT_DEBUG ) {
+                    continue 2;
+                }
+                $script_module_id = '@wordpress/interactivity';
+                break;
+            case '@wordpress/interactivity':
+                if ( SCRIPT_DEBUG ) {
+                    continue 2;
+                }
+                break;
+        }
+
+        $path = "/wp-includes/js/dist/script-modules/{$file_name}";
+        wp_register_script_module( $script_module_id, $path, $script_module_data['dependencies'], $script_module_data['version'] );
+    }
+}