-
Notifications
You must be signed in to change notification settings - Fork 3.2k
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.
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
Scripts: Remove sourceURL from print_translations when not printing #10505
Conversation
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.
|
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 Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
Test using WordPress PlaygroundThe 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
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
westonruter
left a comment
There was a problem hiding this 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.
|
It would be good to see a unit test on this to ensure |
|
I cleaned up the comment and added a test to verify that This should be ready to merge now. |
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
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
|
This was merged in r61223. |
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
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
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
Prevent adding
sourceURLcomment to script translations when not printed.In this comment, @ralucaStan reported an issue where a plugin uses
WP_Scripts::print_translations()with$display == falseto 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
sourceURLwhen$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.