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

Timestamp:

02/04/2026 01:41:25 AM (8 weeks ago)

Author:

westonruter

Message:

Script Loader: Allow classic scripts to depend on script modules.

This allows classic scripts to declare dependencies on script modules by passing module_dependencies in the $args param for wp_register_script() or wp_enqueue_script(). The WP_Script_Modules::get_import_map() method is updated to traverse the dependency tree of all enqueued classic scripts to find any associated script module dependencies and include them in the importmap, enabling dynamic imports of modules within classic scripts.

A _wp_scripts_add_args_data() helper function is introduced to consolidate argument validation and processing for wp_register_script() and wp_enqueue_script(), reducing code duplication. This function validates that the $args array only contains recognized keys (strategy, in_footer, fetchpriority, module_dependencies) and triggers a _doing_it_wrong() notice for any unrecognized keys. Similarly, WP_Scripts::add_data() is updated to do early type checking for the data passed to $args. The script modules in module_dependencies may be referenced by a module ID string or by an array that has an id key, following the same pattern as dependencies in WP_Script_Modules.

When a script module is added to the module_dependencies for a classic script, but it does not exist at the time the importmap is printed, a _doing_it_wrong() notice is emitted.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/8024

Follow-up to [61323].

Props sirreal, westonruter.
See #64229.
Fixes #61500.

File:

• trunk/src/wp-includes/class-wp-scripts.php (modified) (1 diff)

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

@@ -921 +921 @@
                 return false;
             }
+        } elseif ( 'module_dependencies' === $key ) {
+            if ( ! is_array( $value ) ) {
+                _doing_it_wrong(
+                    __METHOD__,
+                    sprintf(
+                        /* translators: 1: 'module_dependencies', 2: Script handle. */
+                        __( 'The value for "%1$s" must be an array for the "%2$s" script.' ),
+                        'module_dependencies',
+                        $handle
+                    ),
+                    '7.0.0'
+                );
+                return false;
+            }
+
+            $sanitized_value = array();
+            $has_invalid_ids = false;
+            foreach ( $value as $module ) {
+                if (
+                    is_string( $module ) ||
+                    ( is_array( $module ) && isset( $module['id'] ) && is_string( $module['id'] ) )
+                ) {
+                    $sanitized_value[] = $module;
+                } else {
+                    $has_invalid_ids = true;
+                }
+            }
+
+            if ( $has_invalid_ids ) {
+                _doing_it_wrong(
+                    __METHOD__,
+                    sprintf(
+                        /* translators: 1: Script handle, 2: 'module_dependencies' */
+                        __( 'The script handle "%1$s" has one or more of its script module dependencies ("%2$s") which are invalid.' ),
+                        $handle,
+                        'module_dependencies'
+                    ),
+                    '7.0.0'
+                );
+            }
+
+            $value = $sanitized_value;
         }
         return parent::add_data( $handle, $key, $value );