Skip to content

Scripts: Remove sourceURL from print_translations when not printing #10505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sirreal wants to merge 6 commits into from
+30 −4
Closed

Scripts: Remove sourceURL from print_translations when not printing #10505

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
1c77555
Prevent adding sourceURL to translation script if not printed
sirreal Nov 11, 2025
45ae336
Include the sourceURL comment when printed by do_item
sirreal Nov 11, 2025
7f51e59
Fix typo
westonruter Nov 11, 2025
9d9c903
Fix @see tag and comment text
sirreal Nov 11, 2025
a48d5aa
Add test for no sourceURL when display is false
sirreal Nov 12, 2025
8f95b08
Remove phpdoc syntax from multiline comment
sirreal Nov 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 12 additions & 4 deletions src/wp-includes/class-wp-scripts.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,16 @@ public function do_item( $handle, $group = false ) {

$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" ) );
}

if ( $this->do_concat ) {
Expand Down Expand Up @@ -722,18 +731,17 @@ public function print_translations( $handle, $display = true ) {
return false;
}

$source_url = rawurlencode( "{$handle}-js-translations" );

$output = <<<JS
( function( domain, translations ) {
var localeData = translations.locale_data[ domain ] || translations.locale_data.messages;
localeData[""].domain = domain;
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" ) );
}

Expand Down
18 changes: 18 additions & 0 deletions tests/phpunit/tests/dependencies/scripts.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4075,4 +4075,22 @@ public function test_source_url_with_concat() {

$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 );
}
}
Loading