Changeset 60704 for trunk/src/wp-includes/class-wp-scripts.php

Timestamp:

09/03/2025 10:15:31 PM (6 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/class-wp-scripts.php (modified) (4 diffs)

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

@@ -425 +425 @@
         if ( $intended_strategy ) {
             $attr['data-wp-strategy'] = $intended_strategy;
+        }
+        if ( isset( $obj->extra['fetchpriority'] ) && 'auto' !== $obj->extra['fetchpriority'] && $this->is_valid_fetchpriority( $obj->extra['fetchpriority'] ) ) {
+            $attr['fetchpriority'] = $obj->extra['fetchpriority'];
         }
         $tag  = $translations . $ie_conditional_prefix . $before_script;
@@ -832 +835 @@
                 return false;
             }
+        } elseif ( 'fetchpriority' === $key ) {
+            if ( empty( $value ) ) {
+                $value = 'auto';
+            }
+            if ( ! $this->is_valid_fetchpriority( $value ) ) {
+                _doing_it_wrong(
+                    __METHOD__,
+                    sprintf(
+                        /* translators: 1: $fetchpriority, 2: $handle */
+                        __( 'Invalid fetchpriority `%1$s` defined for `%2$s` during script registration.' ),
+                        is_string( $value ) ? $value : gettype( $value ),
+                        $handle
+                    ),
+                    '6.9.0'
+                );
+                return false;
+            } elseif ( ! $this->registered[ $handle ]->src ) {
+                _doing_it_wrong(
+                    __METHOD__,
+                    sprintf(
+                        /* translators: 1: $fetchpriority, 2: $handle */
+                        __( 'Cannot supply a fetchpriority `%1$s` for script `%2$s` because it is an alias (it lacks a `src` value).' ),
+                        is_string( $value ) ? $value : gettype( $value ),
+                        $handle
+                    ),
+                    '6.9.0'
+                );
+                return false;
+            }
         }
         return parent::add_data( $handle, $key, $value );
@@ -870 +902 @@
      * @since 6.3.0
      *
-     * @param string $strategy The strategy to check.
+     * @param string|mixed $strategy The strategy to check.
      * @return bool True if $strategy is one of the delayed strategies, otherwise false.
      */
-    private function is_delayed_strategy( $strategy ) {
+    private function is_delayed_strategy( $strategy ): bool {
         return in_array(
             $strategy,
@@ -879 +911 @@
             true
         );
+    }
+
+    /**
+     * Checks if the provided fetchpriority is valid.
+     *
+     * @since 6.9.0
+     *
+     * @param string|mixed $priority Fetch priority.
+     * @return bool Whether valid fetchpriority.
+     */
+    private function is_valid_fetchpriority( $priority ): bool {
+        return in_array( $priority, array( 'auto', 'low', 'high' ), true );
     }