Skip to content

Conversation

@sirreal
Copy link
Member

@sirreal sirreal commented Nov 11, 2025

Prevent adding sourceURL comment to script translations when not printed.

In this comment, @ralucaStan reported an issue where a plugin uses WP_Scripts::print_translations() with $display == false to collect and concatenate multiple script tags into a single script tag. This reveals a possible regression and reveals that it's difficult to anticipate how the script tag contents may be used.

By not printing the sourceURL when $display == false, it's less likely to introduce problems for extenders in this case.

Trac ticket: https://core.trac.wordpress.org/ticket/63887
Follow-up to r60719.


This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

It's unclear how the script tag contents may be used by extenders. Avoid
printing the sourceURL if the contents are not immediately printed.

See
https://github.com/WordPress/wordpress-develop/blob/81e3dbeba63838a13b137c6308548e35a616f3b6/src/wp-includes/script-loader.php#L3015.
WP_Scripts uses print_translations() internally with $display == false.
In this case, the sourceURL comment is still desirable so include it.
@github-actions
Copy link

github-actions bot commented Nov 11, 2025

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Core Committers: Use this line as a base for the props when committing in SVN:

Props jonsurrell, westonruter, peterwilsoncc.

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

@sirreal sirreal requested a review from westonruter November 11, 2025 18:04
@github-actions
Copy link

Test using WordPress Playground

The changes in this pull request can previewed and tested using a WordPress Playground instance.

WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

Some things to be aware of

  • The Plugin and Theme Directories cannot be accessed within Playground.
  • All changes will be lost when closing a tab with a Playground instance.
  • All changes will be lost when refreshing the page.
  • A fresh instance is created each time the link below is clicked.
  • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
    it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

Test this pull request with WordPress Playground.

Copy link
Member

@westonruter westonruter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aside from the comment suggestion, this looks good to me. I haven't tested it, however.

@peterwilsoncc
Copy link
Contributor

It would be good to see a unit test on this to ensure WP_Scripts::print_translations( ..., true ) has the source url and that WP_Scripts::print_translations( ..., false ) does not.

@sirreal sirreal requested a review from Copilot November 12, 2025 10:07
@sirreal
Copy link
Member Author

sirreal commented Nov 12, 2025

I cleaned up the comment and added a test to verify that sourceURL= is not present in the print_translations() return value when $display === false.

This should be ready to merge now.

Copilot finished reviewing on behalf of sirreal November 12, 2025 10:09

This comment was marked as resolved.

pento pushed a commit that referenced this pull request Nov 12, 2025
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 #10505.

Follow-up to [60719].

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


git-svn-id: https://develop.svn.wordpress.org/trunk@61223 602fd350-edb4-49c9-b593-d223f7449a82
markjaquith pushed a commit to markjaquith/WordPress that referenced this pull request Nov 12, 2025
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 WordPress/wordpress-develop#10505.

Follow-up to [60719].

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

Built from https://develop.svn.wordpress.org/trunk@61223


git-svn-id: http://core.svn.wordpress.org/trunk@60552 1a063a9b-81f0-0310-95a4-ce76da25c4cd
@sirreal
Copy link
Member Author

sirreal commented Nov 12, 2025

This was merged in r61223.

@sirreal sirreal closed this Nov 12, 2025
@sirreal sirreal deleted the fix/no-add-sourceurl-unprinted-script-translations branch November 12, 2025 11:40
github-actions bot pushed a commit to platformsh/wordpress-performance that referenced this pull request Nov 12, 2025
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 WordPress/wordpress-develop#10505.

Follow-up to [60719].

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

Built from https://develop.svn.wordpress.org/trunk@61223


git-svn-id: https://core.svn.wordpress.org/trunk@60552 1a063a9b-81f0-0310-95a4-ce76da25c4cd
pento pushed a commit that referenced this pull request Nov 18, 2025
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 #10505.

Follow-up to [60719].

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

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


git-svn-id: https://develop.svn.wordpress.org/branches/6.9@61260 602fd350-edb4-49c9-b593-d223f7449a82
markjaquith pushed a commit to markjaquith/WordPress that referenced this pull request Nov 18, 2025
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 WordPress/wordpress-develop#10505.

Follow-up to [60719].

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

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

Built from https://develop.svn.wordpress.org/branches/6.9@61260


git-svn-id: http://core.svn.wordpress.org/branches/6.9@60572 1a063a9b-81f0-0310-95a4-ce76da25c4cd
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants