Add sourceURL comments for directly constructed inline scripts in wp-includes #9955

westonruter · 2025-09-19T00:55:03Z

I realized in https://github.com/WordPress/wordpress-develop/pull/9531/files#r2361414013 that that the emoji loader script wasn't geting the sourceURL comment. I then realized that there were more than a dozen other such instances of scripts constructed via wp_get_inline_script_tag() and wp_print_inline_script_tag() in wp-includes which lacked these comments.

Note that there are quite a few scripts constructed in wp-admin which are not yet using wp_get_inline_script_tag() and wp_print_inline_script_tag(). See Core-59446.

There are also instances of inline scripts being printed in themes which this PR does not address. I've suggested that these be handled as part of Core-63806.

Upstream block change to Gutenberg. See Categories block: Improve and harden JavaScript used when displayed as dropdown gutenberg#72118

Trac ticket: https://core.trac.wordpress.org/ticket/63887

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.

…includes

westonruter · 2025-09-19T00:55:28Z

src/wp-includes/blocks/categories.php

 		}
 		dropdown.onchange = onCatChange;
 	})();
+	//# sourceURL=<?php echo __FUNCTION__; ?>


I realize this change will need to be done upstream in Gutenberg.

See WordPress/gutenberg#72118

src/wp-includes/class-wp-customize-manager.php

src/wp-includes/formatting.php

sirreal

Let's pass all of these through rawurlencode() rather than any string replacement or otherwise relying on the strings to be safe.

That's how it's implemented in script loader:

wordpress-develop/src/wp-includes/script-loader.php

Line 2215 in 3c3852e

    
           echo sprintf( "\n//# sourceURL=%s\n", rawurlencode( 'js-inline-concat-' . $concat ) );

The spec says this:

Note: is a URL as defined in RFC3986; in particular, characters outside the set permitted to appear in URIs must be percent-encoded.

And rawurlencode() is just the thing:

Encodes the given string according to » RFC 3986.

…into add/includes-inline-script-source-urls

westonruter · 2025-09-30T03:38:29Z

Note how the function now shows up in the coverage report:

…into add/includes-inline-script-source-urls

github-actions · 2025-10-04T04:42:15Z

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.

github-actions · 2025-10-04T04:49:18Z

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 westonruter, jonsurrell.

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

sirreal

I've tested several but not all of these cases. I have reviewed all the changes and they appear correct.

It's a very nice improvement when errors or logs come from these scripts 👍

sirreal · 2025-10-06T10:45:12Z

Have you or are you planning to create a PR for the case that comes from Gutenberg?

westonruter · 2025-10-07T00:41:01Z

Have you or are you planning to create a PR for the case that comes from Gutenberg?

@sirreal Thanks for the reminder: WordPress/gutenberg#72118

…lly constructed in `wp-includes`. This applies to tags constructed without `wp_get_inline_script_tag()`/`wp_print_inline_script_tag()`. Developed in #9955. Props westonruter, jonsurrell. See #63887. git-svn-id: https://develop.svn.wordpress.org/trunk@60909 602fd350-edb4-49c9-b593-d223f7449a82

westonruter · 2025-10-07T01:23:48Z

Committed in r60909 (8c2ec29)

…lly constructed in `wp-includes`. This applies to tags constructed without `wp_get_inline_script_tag()`/`wp_print_inline_script_tag()`. Developed in WordPress/wordpress-develop#9955. Props westonruter, jonsurrell. See #63887. Built from https://develop.svn.wordpress.org/trunk@60909 git-svn-id: http://core.svn.wordpress.org/trunk@60245 1a063a9b-81f0-0310-95a4-ce76da25c4cd

…lly constructed in `wp-includes`. This applies to tags constructed without `wp_get_inline_script_tag()`/`wp_print_inline_script_tag()`. Developed in WordPress/wordpress-develop#9955. Props westonruter, jonsurrell. See #63887. Built from https://develop.svn.wordpress.org/trunk@60909 git-svn-id: https://core.svn.wordpress.org/trunk@60245 1a063a9b-81f0-0310-95a4-ce76da25c4cd

Add sourceURL comments for directly constructed inline scripts in wp-…

868d746

…includes

westonruter commented Sep 19, 2025

View reviewed changes

src/wp-includes/class-wp-customize-manager.php Outdated Show resolved Hide resolved

westonruter commented Sep 19, 2025

View reviewed changes

src/wp-includes/formatting.php Outdated Show resolved Hide resolved

westonruter requested a review from sirreal September 19, 2025 00:58

sirreal reviewed Sep 23, 2025

View reviewed changes

westonruter mentioned this pull request Sep 26, 2025

Fix: Update Raw <script> tags with wp_inline_script_tag() for bundled themes. #9416

Closed

westonruter added 2 commits September 29, 2025 20:31

Merge branch 'trunk' of https://github.com/WordPress/wordpress-develop …

0af98ca

…into add/includes-inline-script-source-urls

Add rawurlencode() to __FUNCTION__ and __METHOD__ for sourceURL comments

faa2f46

Add rawurlencode() to remaining instances

edc5315

westonruter mentioned this pull request Sep 30, 2025

Use script module for emoji-loader with settings exported via JSON #9531

Closed

westonruter added 2 commits October 3, 2025 21:21

Merge branch 'trunk' of https://github.com/WordPress/wordpress-develop …

d240ccf

…into add/includes-inline-script-source-urls

Revert change to block which will come from Gutenberg

8ef058f

westonruter marked this pull request as ready for review October 4, 2025 04:49

westonruter requested a review from sirreal October 4, 2025 04:49

sirreal approved these changes Oct 6, 2025

View reviewed changes

westonruter mentioned this pull request Oct 7, 2025

Categories block: Improve and harden JavaScript used when displayed as dropdown WordPress/gutenberg#72118

Merged

westonruter closed this Oct 7, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add sourceURL comments for directly constructed inline scripts in wp-includes #9955

Add sourceURL comments for directly constructed inline scripts in wp-includes #9955

Uh oh!

westonruter commented Sep 19, 2025 •

edited

Loading

Uh oh!

westonruter Sep 19, 2025

Uh oh!

westonruter Oct 7, 2025

Uh oh!

Uh oh!

Uh oh!

sirreal left a comment

Uh oh!

westonruter commented Sep 30, 2025

Uh oh!

github-actions bot commented Oct 4, 2025

Uh oh!

github-actions bot commented Oct 4, 2025

Uh oh!

sirreal left a comment

Uh oh!

sirreal commented Oct 6, 2025

Uh oh!

westonruter commented Oct 7, 2025

Uh oh!

westonruter commented Oct 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Add sourceURL comments for directly constructed inline scripts in wp-includes #9955

Add sourceURL comments for directly constructed inline scripts in wp-includes #9955

Uh oh!

Conversation

westonruter commented Sep 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

westonruter Sep 19, 2025

Choose a reason for hiding this comment

Uh oh!

westonruter Oct 7, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

sirreal left a comment

Choose a reason for hiding this comment

Uh oh!

westonruter commented Sep 30, 2025

Uh oh!

github-actions bot commented Oct 4, 2025

Test using WordPress Playground

Some things to be aware of

Uh oh!

github-actions bot commented Oct 4, 2025

Uh oh!

sirreal left a comment

Choose a reason for hiding this comment

Uh oh!

sirreal commented Oct 6, 2025

Uh oh!

westonruter commented Oct 7, 2025

Uh oh!

westonruter commented Oct 7, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

westonruter commented Sep 19, 2025 •

edited

Loading