Changeset 57844

Timestamp:

03/15/2024 02:59:10 PM (10 months ago)

Author:

swissspidy

Message:

Script Loader: Add new script_module_loader_src filter for the script module src.

Ensures parity with the script_loader_src filter for regular scripts, allowing the URL to be filtered, for example to load them from a CDN or alter query parameters.

Reviewed by swissspidy.
Merges [57840] to the to the 6.5 branch.

Props dd32, peterwilsoncc, westonruter.
Fixes #60742.

Location:

branches/6.5

Files:

• . (modified) (1 prop)
• src/wp-includes/class-wp-script-modules.php (modified) (4 diffs)
• tests/phpunit/tests/script-modules/wpScriptModules.php (modified) (1 diff)

branches/6.5/src/wp-includes/class-wp-script-modules.php

@@ -192 +192 @@
                 array(
                     'type' => 'module',
-                    'src'  => $this->get_versioned_src( $script_module ),
+                    'src'  => $this->get_src( $id ),
                     'id'   => $id . '-js-module',
                 )
@@ -213 +213 @@
                 echo sprintf(
                     '<link rel="modulepreload" href="%s" id="%s">',
-                    esc_url( $this->get_versioned_src( $script_module ) ),
+                    esc_url( $this->get_src( $id ) ),
                     esc_attr( $id . '-js-modulepreload' )
                 );
@@ -265 +265 @@
         $imports = array();
         foreach ( $this->get_dependencies( array_keys( $this->get_marked_for_enqueue() ) ) as $id => $script_module ) {
-            $imports[ $id ] = $this->get_versioned_src( $script_module );
+            $imports[ $id ] = $this->get_src( $id );
         }
         return array( 'imports' => $imports );
@@ -332 +332 @@
      * @since 6.5.0
      *
-     * @param array $script_module The script module.
+     * @param string $id The script module identifier.
      * @return string The script module src with a version if relevant.
      */
-    private function get_versioned_src( array $script_module ): string {
-        $args = array();
+    private function get_src( string $id ): string {
+        if ( ! isset( $this->registered[ $id ] ) ) {
+            return '';
+        }
+
+        $script_module = $this->registered[ $id ];
+        $src           = $script_module['src'];
+
         if ( false === $script_module['version'] ) {
-            $args['ver'] = get_bloginfo( 'version' );
+            $src = add_query_arg( 'ver', get_bloginfo( 'version' ), $src );
         } elseif ( null !== $script_module['version'] ) {
-            $args['ver'] = $script_module['version'];
-        }
-        if ( $args ) {
-            return add_query_arg( $args, $script_module['src'] );
-        }
-        return $script_module['src'];
+            $src = add_query_arg( 'ver', $script_module['version'], $src );
+        }
+
+        /**
+         * Filters the script module source.
+         *
+         * @since 6.5.0
+         *
+         * @param string $src Module source url.
+         * @param string $id  Module identifier.
+         */
+        $src = apply_filters( 'script_module_loader_src', $src, $id );
+
+        return $src;
     }
 }

branches/6.5/tests/phpunit/tests/script-modules/wpScriptModules.php

@@ -513 +513 @@
 
     /**
-     * Tests the functionality of the `get_versioned_src` method to ensure
+     * Tests the functionality of the `get_src` method to ensure
      * proper URLs with version strings are returned.
      *
      * @ticket 56313
      *
-     * @covers ::get_versioned_src()
-     */
-    public function test_get_versioned_src() {
-        $get_versioned_src = new ReflectionMethod( $this->script_modules, 'get_versioned_src' );
-        $get_versioned_src->setAccessible( true );
-
-        $module_with_version = array(
-            'src'     => 'http://example.com/module.js',
-            'version' => '1.0',
-        );
-
-        $result = $get_versioned_src->invoke( $this->script_modules, $module_with_version );
+     * @covers ::get_src()
+     */
+    public function test_get_src() {
+        $get_src = new ReflectionMethod( $this->script_modules, 'get_src' );
+        $get_src->setAccessible( true );
+
+        $this->script_modules->register(
+            'module_with_version',
+            'http://example.com/module.js',
+            array(),
+            '1.0'
+        );
+
+        $result = $get_src->invoke( $this->script_modules, 'module_with_version' );
         $this->assertEquals( 'http://example.com/module.js?ver=1.0', $result );
 
-        $module_without_version = array(
-            'src'     => 'http://example.com/module.js',
-            'version' => null,
-        );
-
-        $result = $get_versioned_src->invoke( $this->script_modules, $module_without_version );
+        $this->script_modules->register(
+            'module_without_version',
+            'http://example.com/module.js',
+            array(),
+            null
+        );
+
+        $result = $get_src->invoke( $this->script_modules, 'module_without_version' );
         $this->assertEquals( 'http://example.com/module.js', $result );
 
-        $module_with_wp_version = array(
-            'src'     => 'http://example.com/module.js',
-            'version' => false,
-        );
-
-        $result = $get_versioned_src->invoke( $this->script_modules, $module_with_wp_version );
+        $this->script_modules->register(
+            'module_with_wp_version',
+            'http://example.com/module.js',
+            array(),
+            false
+        );
+
+        $result = $get_src->invoke( $this->script_modules, 'module_with_wp_version' );
         $this->assertEquals( 'http://example.com/module.js?ver=' . get_bloginfo( 'version' ), $result );
 
-        $module_with_existing_query_string = array(
-            'src'     => 'http://example.com/module.js?foo=bar',
-            'version' => '1.0',
-        );
-
-        $result = $get_versioned_src->invoke( $this->script_modules, $module_with_existing_query_string );
+        $this->script_modules->register(
+            'module_with_existing_query_string',
+            'http://example.com/module.js?foo=bar',
+            array(),
+            '1.0'
+        );
+
+        $result = $get_src->invoke( $this->script_modules, 'module_with_existing_query_string' );
         $this->assertEquals( 'http://example.com/module.js?foo=bar&ver=1.0', $result );
+
+        // Filter the version to include the ID in the final URL, to test the filter, this should affect the tests below.
+        add_filter(
+            'script_module_loader_src',
+            function ( $src, $id ) {
+                return add_query_arg( 'script_module_id', urlencode( $id ), $src );
+            },
+            10,
+            2
+        );
+
+        $result = $get_src->invoke( $this->script_modules, 'module_without_version' );
+        $this->assertEquals( 'http://example.com/module.js?script_module_id=module_without_version', $result );
+
+        $result = $get_src->invoke( $this->script_modules, 'module_with_existing_query_string' );
+        $this->assertEquals( 'http://example.com/module.js?foo=bar&ver=1.0&script_module_id=module_with_existing_query_string', $result );
     }