Changeset 61260

Timestamp:

11/18/2025 10:10:49 AM (9 months ago)

Author:

jonsurrell

Message:

Script Loader: Omit sourceURL from translation data when not printed.

The data returned from WP_Scripts::print_translations() when $display is false may be used in unpredictable ways that are incompatible with sourceURL comments. Omit the sourceURL comment in this case.

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

Follow-up to [60719].

Reviewed by westonruter.
Merges [61223] to the 6.9 branch.

Props jonsurrell, ralucastn, westonruter, peterwilsoncc.
See #63887.

Location:

branches/6.9

Files:

• . (modified) (1 prop)
• src/wp-includes/class-wp-scripts.php (modified) (3 diffs)
• tests/phpunit/tests/dependencies/scripts.php (modified) (1 diff)

branches/6.9/src/wp-includes/class-wp-scripts.php

@@ -351 +351 @@
                 $translations = $this->print_translations( $handle, false );
                 if ( $translations ) {
-                        $translations = wp_get_inline_script_tag( $translations, array( 'id' => "{$handle}-js-translations" ) );
+                        /*
+                         * The sourceURL comment is not included by WP_Scripts::print_translations()
+                         * when `$display` is `false` to prevent issues where the script tag contents are used
+                         * by extenders for other purposes, for example concatenated with other script content.
+                         *
+                         * Include the sourceURL comment here as it would be when printed directly.
+                         */
+                        $source_url    = rawurlencode( "{$handle}-js-translations" );
+                        $translations .= "\n//# sourceURL={$source_url}";
+                        $translations  = wp_get_inline_script_tag( $translations, array( 'id' => "{$handle}-js-translations" ) );
                 }
 
@@ -723 +732 @@
                 }
 
-                $source_url = rawurlencode( "{$handle}-js-translations" );
-
                 $output = <<<JS
 ( function( domain, translations ) {
@@ -731 +738 @@
         wp.i18n.setLocaleData( localeData, domain );
 } )( "{$domain}", {$json_translations} );
-//# sourceURL={$source_url}
 JS;
 
                 if ( $display ) {
+                        $source_url = rawurlencode( "{$handle}-js-translations" );
+                        $output    .= "\n//# sourceURL={$source_url}";
                         wp_print_inline_script_tag( $output, array( 'id' => "{$handle}-js-translations" ) );
                 }

branches/6.9/tests/phpunit/tests/dependencies/scripts.php

@@ -4076 +4076 @@
                 $this->assertEqualHTML( $expected, $print_scripts );
         }
+
+        /**
+         * Ensure that `::print_translations()` does not include the sourceURL comment when `$display` is false.
+         *
+         * @ticket 63887
+         * @covers ::print_translations
+         */
+        public function test_print_translations_no_display_no_sourceurl() {
+                global $wp_scripts;
+                $this->add_html5_script_theme_support();
+
+                wp_register_script( 'wp-i18n', '/wp-includes/js/dist/wp-i18n.js', array(), null );
+                wp_enqueue_script( 'test-example', '/wp-includes/js/script.js', array(), null );
+                wp_set_script_translations( 'test-example', 'default', DIR_TESTDATA . '/languages' );
+
+                $translations_script_data = $wp_scripts->print_translations( 'test-example', false );
+                $this->assertStringNotContainsStringIgnoringCase( 'sourceURL=', $translations_script_data );
+        }
 }