Changeset 60704 for trunk/src/wp-includes/functions.wp-scripts.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/functions.wp-scripts.php (modified) (6 diffs)

trunk/src/wp-includes/functions.wp-scripts.php

@@ -159 +159 @@
  * @since 4.3.0 A return value was added.
  * @since 6.3.0 The $in_footer parameter of type boolean was overloaded to be an $args parameter of type array.
+ * @since 6.9.0 The $fetchpriority parameter of type string was added to the $args parameter of type array.
  *
  * @param string           $handle    Name of the script. Should be unique.
@@ -172 +173 @@
  *     Otherwise, it may be a boolean in which case it determines whether the script is printed in the footer. Default false.
  *
- *     @type string    $strategy     Optional. If provided, may be either 'defer' or 'async'.
- *     @type bool      $in_footer    Optional. Whether to print the script in the footer. Default 'false'.
+ *     @type string    $strategy      Optional. If provided, may be either 'defer' or 'async'.
+ *     @type bool      $in_footer     Optional. Whether to print the script in the footer. Default 'false'.
+ *     @type string    $fetchpriority Optional. The fetch priority for the script. Default 'auto'.
  * }
  * @return bool Whether the script has been registered. True on success, false on failure.
@@ -193 +195 @@
     if ( ! empty( $args['strategy'] ) ) {
         $wp_scripts->add_data( $handle, 'strategy', $args['strategy'] );
+    }
+    if ( ! empty( $args['fetchpriority'] ) ) {
+        $wp_scripts->add_data( $handle, 'fetchpriority', $args['fetchpriority'] );
     }
     return $registered;
@@ -340 +345 @@
  * @since 2.1.0
  * @since 6.3.0 The $in_footer parameter of type boolean was overloaded to be an $args parameter of type array.
+ * @since 6.9.0 The $fetchpriority parameter of type string was added to the $args parameter of type array.
  *
  * @param string           $handle    Name of the script. Should be unique.
@@ -353 +359 @@
  *     Otherwise, it may be a boolean in which case it determines whether the script is printed in the footer. Default false.
  *
- *     @type string    $strategy     Optional. If provided, may be either 'defer' or 'async'.
- *     @type bool      $in_footer    Optional. Whether to print the script in the footer. Default 'false'.
+ *     @type string    $strategy      Optional. If provided, may be either 'defer' or 'async'.
+ *     @type bool      $in_footer     Optional. Whether to print the script in the footer. Default 'false'.
+ *     @type string    $fetchpriority Optional. The fetch priority for the script. Default 'auto'.
  * }
  */
@@ -379 +386 @@
             $wp_scripts->add_data( $_handle[0], 'strategy', $args['strategy'] );
         }
+        if ( ! empty( $args['fetchpriority'] ) ) {
+            $wp_scripts->add_data( $_handle[0], 'fetchpriority', $args['fetchpriority'] );
+        }
     }