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

Timestamp:

09/03/2025 10:15:31 PM (5 months ago)

Author:

westonruter

Message:

Script Loader: Introduce fetchpriority for Scripts and Script Modules.

• Allow scripts and script modules to be registered with a fetchpriority of auto (default), high, low:
  • When registering a script, add a fetchpriority arg to go alongside the strategy arg which was added for loading scripts with the defer and async loading strategies. See #12009.
  • For script modules, introduce an $args array parameter with a fetchpriority key to the wp_register_script_module(), and wp_enqueue_script_module() functions (and their respective underlying WP_Script_Modules::register() and WP_Script_Modules::enqueue() methods). This $args parameter corresponds with the same parameter used when registering non-module scripts.
  • Also for script modules, introduce WP_Script_Modules::set_fetchpriority() to override the fetchpriority for what was previously registered.
  • Emit a _doing_it_wrong() warning when an invalid fetchpriority value is used, and when fetchpriority is added to a script alias.
  • Include fetchpriority as an attribute on printed SCRIPT tags as well as on preload LINK tags for static script module dependencies.
• Use a fetchpriority of low by default for:
  • Script modules used with the Interactivity API. For overriding this default in blocks, see ​Gutenberg#71366.
  • The comment-reply script.
• Improve type checks and type hints.

Developed in ​GitHub PR, with ​companion for Gutenberg.

Props westonruter, jonsurrell, swissspidy, luisherranz, kraftbj, audrasjb, dennysdionigi.
Fixes #61734.

File:

• trunk/src/wp-includes/script-modules.php (modified) (5 diffs)

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

@@ -36 +36 @@
  *
  * @since 6.5.0
+ * @since 6.9.0 Added the $args parameter.
  *
  * @param string            $id      The identifier of the script module. Should be unique. It will be used in the
@@ -61 +62 @@
  *                                   is set to false, the version number is the currently installed WordPress version.
  *                                   If $version is set to null, no version is added.
+ * @param array             $args    {
+ *     Optional. An array of additional args. Default empty array.
+ *
+ *     @type 'auto'|'low'|'high' $fetchpriority Fetch priority. Default 'auto'. Optional.
+ * }
  */
-function wp_register_script_module( string $id, string $src, array $deps = array(), $version = false ) {
-    wp_script_modules()->register( $id, $src, $deps, $version );
+function wp_register_script_module( string $id, string $src, array $deps = array(), $version = false, array $args = array() ) {
+    wp_script_modules()->register( $id, $src, $deps, $version, $args );
 }
 
@@ -73 +79 @@
  *
  * @since 6.5.0
+ * @since 6.9.0 Added the $args parameter.
  *
  * @param string            $id      The identifier of the script module. Should be unique. It will be used in the
@@ -98 +105 @@
  *                                   is set to false, the version number is the currently installed WordPress version.
  *                                   If $version is set to null, no version is added.
+ * @param array             $args    {
+ *     Optional. An array of additional args. Default empty array.
+ *
+ *     @type 'auto'|'low'|'high' $fetchpriority Fetch priority. Default 'auto'. Optional.
+ * }
  */
-function wp_enqueue_script_module( string $id, string $src = '', array $deps = array(), $version = false ) {
-    wp_script_modules()->enqueue( $id, $src, $deps, $version );
+function wp_enqueue_script_module( string $id, string $src = '', array $deps = array(), $version = false, array $args = array() ) {
+    wp_script_modules()->enqueue( $id, $src, $deps, $version, $args );
 }
 
@@ -170 +182 @@
         }
 
+        // The Interactivity API is designed with server-side rendering as its primary goal, so all of its script modules should be loaded with low fetch priority since they should not be needed in the critical rendering path.
+        $args = array();
+        if ( str_starts_with( $script_module_id, '@wordpress/interactivity' ) || str_starts_with( $script_module_id, '@wordpress/block-library' ) ) {
+            $args['fetchpriority'] = 'low';
+        }
+
         $path = includes_url( "js/dist/script-modules/{$file_name}" );
-        wp_register_script_module( $script_module_id, $path, $script_module_data['dependencies'], $script_module_data['version'] );
+        wp_register_script_module( $script_module_id, $path, $script_module_data['dependencies'], $script_module_data['version'], $args );
     }
 }