Changeset 61073

Timestamp:

10/27/2025 04:10:24 PM (7 weeks ago)

Author:

westonruter

Message:

Script Loader: Restore original return value for WP_Script_Modules::get_dependencies().

Even though this method is private, there are some usages of it in the ecosystem via the Reflection API. So this reverts the script module IDs string[] return value in favor of the original array<string, array> return value. This re-emphasizes the need for more public accessor methods being tracked in #60597.

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

Follow-up to [60999].

Props pbiron, westonruter, johnbillion.
See #63486, #60597.

Location:

trunk

Files:

• src/wp-includes/class-wp-script-modules.php (modified) (5 diffs)
• tests/phpunit/tests/script-modules/wpScriptModules.php (modified) (3 diffs)

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

@@ -399 +399 @@
             ) {
                 // If any dependency is set to be printed in footer, skip printing this module in head.
-                $dependencies = $this->get_dependencies( array( $id ) );
+                $dependencies = array_keys( $this->get_dependencies( array( $id ) ) );
                 foreach ( $dependencies as $dependency_id ) {
                     if (
@@ -529 +529 @@
     private function get_import_map(): array {
         $imports = array();
-        foreach ( $this->get_dependencies( $this->queue ) as $id ) {
+        foreach ( array_keys( $this->get_dependencies( $this->queue ) ) as $id ) {
             $src = $this->get_src( $id );
             if ( '' !== $src ) {
@@ -567 +567 @@
      * @param string[] $import_types Optional. Import types of dependencies to retrieve: 'static', 'dynamic', or both.
      *                                         Default is both.
-     * @return string[] List of IDs for script module dependencies.
+     * @return array<string, array> List of dependencies, keyed by script module identifier.
      */
     private function get_dependencies( array $ids, array $import_types = array( 'static', 'dynamic' ) ): array {
@@ -585 +585 @@
                     isset( $this->registered[ $dependency['id'] ] )
                 ) {
-                    $all_dependencies[ $dependency['id'] ] = true;
+                    $all_dependencies[ $dependency['id'] ] = $this->registered[ $dependency['id'] ];
 
                     // Add this dependency to the list to get dependencies for.
@@ -593 +593 @@
         }
 
-        return array_keys( $all_dependencies );
+        return $all_dependencies;
     }
 

trunk/tests/phpunit/tests/script-modules/wpScriptModules.php

@@ -226 +226 @@
         $reflection_class       = new ReflectionClass( wp_script_modules() );
         $get_marked_for_enqueue = $reflection_class->getMethod( 'get_marked_for_enqueue' );
+        $get_dependencies       = $reflection_class->getMethod( 'get_dependencies' );
         if ( PHP_VERSION_ID < 80100 ) {
             $get_marked_for_enqueue->setAccessible( true );
+            $get_dependencies->setAccessible( true );
         }
 
@@ -255 +257 @@
         $this->assertIsArray( $marked_for_enqueue['a'], 'Expected script module "a" to have an array entry.' );
         $this->assertSame( '/a.js', $marked_for_enqueue['a']['src'], 'Expected script module "a" to have the given src.' );
+        $this->assertSame( array(), $get_dependencies->invoke( wp_script_modules(), array( 'a' ) ) );
 
         // One Dependency.
@@ -261 +264 @@
         $this->assertTrue( wp_script_modules()->set_fetchpriority( 'b', 'low' ) );
         $this->assertSame( array( 'a', 'b' ), wp_script_modules()->get_queue() );
+        $this->assertSame(
+            array(
+                'b-dep' => array(
+                    'src'           => '/b-dep.js',
+                    'version'       => false,
+                    'dependencies'  => array(),
+                    'in_footer'     => false,
+                    'fetchpriority' => 'auto',
+                ),
+            ),
+            $get_dependencies->invoke( wp_script_modules(), array( 'b' ) )
+        );
 
         // Two dependencies with different formats and a false version.