<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[57341] trunk: Script Loader: Only emit CDATA wrapper comments in `wp_get_inline_script_tag()` for JavaScript.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/57341">57341</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/57341","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-01-23 17:54:25 +0000 (Tue, 23 Jan 2024)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Script Loader: Only emit CDATA wrapper comments in `wp_get_inline_script_tag()` for JavaScript.
This avoids erroneously adding CDATA wrapper comments for non-JavaScript scripts, including those for JSON such as the `importmap` for script modules in <a href="https://core.trac.wordpress.org/ticket/56313">#56313</a>.
Props westonruter, flixos90, mukesh27, dmsnell.
See <a href="https://core.trac.wordpress.org/ticket/56313">#56313</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/60320">#60320</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesscriptloaderphp">trunk/src/wp-includes/script-loader.php</a></li>
<li><a href="#trunktestsphpunittestsdependencieswpInlineScriptTagphp">trunk/tests/phpunit/tests/dependencies/wpInlineScriptTag.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesscriptloaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/script-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/script-loader.php 2024-01-23 17:09:23 UTC (rev 57340)
+++ trunk/src/wp-includes/script-loader.php 2024-01-23 17:54:25 UTC (rev 57341)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2879,7 +2879,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see https://www.w3.org/TR/xhtml1/#h-4.8
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! $is_html5 ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if (
+ ! $is_html5 &&
+ (
+ ! isset( $attributes['type'] ) ||
+ 'module' === $attributes['type'] ||
+ str_contains( $attributes['type'], 'javascript' ) ||
+ str_contains( $attributes['type'], 'ecmascript' ) ||
+ str_contains( $attributes['type'], 'jscript' ) ||
+ str_contains( $attributes['type'], 'livescript' )
+ )
+ ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * If the string `]]>` exists within the JavaScript it would break
</span><span class="cx" style="display: block; padding: 0 10px"> * out of any wrapping CDATA section added here, so to start, it's
</span></span></pre></div>
<a id="trunktestsphpunittestsdependencieswpInlineScriptTagphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/dependencies/wpInlineScriptTag.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/dependencies/wpInlineScriptTag.php 2024-01-23 17:09:23 UTC (rev 57340)
+++ trunk/tests/phpunit/tests/dependencies/wpInlineScriptTag.php 2024-01-23 17:54:25 UTC (rev 57341)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -10,6 +10,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> class Tests_Functions_wpInlineScriptTag extends WP_UnitTestCase {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ private $original_theme_features = array();
+
+ public function set_up() {
+ global $_wp_theme_features;
+ parent::set_up();
+ $this->original_theme_features = $_wp_theme_features;
+ }
+
+ public function tear_down() {
+ global $_wp_theme_features;
+ $_wp_theme_features = $this->original_theme_features;
+ parent::tear_down();
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> private $event_handler = <<<'JS'
</span><span class="cx" style="display: block; padding: 0 10px"> document.addEventListener( 'DOMContentLoaded', function () {
</span><span class="cx" style="display: block; padding: 0 10px"> document.getElementById( 'elementID' )
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -133,4 +147,74 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_get_inline_script_tag( "/* <![CDATA[ */ console.log( 'Hello World!' ); /* ]]> */" )
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ public function data_provider_to_test_cdata_wrapper_omitted_for_non_javascript_scripts() {
+ return array(
+ 'no-type' => array(
+ 'type' => null,
+ 'data' => 'alert("hello")',
+ 'expected_cdata' => true,
+ ),
+ 'js-type' => array(
+ 'type' => 'text/javascript',
+ 'data' => 'alert("hello")',
+ 'expected_cdata' => true,
+ ),
+ 'js-alt-type' => array(
+ 'type' => 'application/javascript',
+ 'data' => 'alert("hello")',
+ 'expected_cdata' => true,
+ ),
+ 'module' => array(
+ 'type' => 'module',
+ 'data' => 'alert("hello")',
+ 'expected_cdata' => true,
+ ),
+ 'importmap' => array(
+ 'type' => 'importmap',
+ 'data' => '{"imports":{"bar":"http:\/\/localhost:10023\/bar.js?ver=6.5-alpha-57321"}}',
+ 'expected_cdata' => false,
+ ),
+ 'html' => array(
+ 'type' => 'text/html',
+ 'data' => '<div>template code</div>',
+ 'expected_cdata' => false,
+ ),
+ 'json' => array(
+ 'type' => 'application/json',
+ 'data' => '{}',
+ 'expected_cdata' => false,
+ ),
+ 'ld' => array(
+ 'type' => 'application/ld+json',
+ 'data' => '{}',
+ 'expected_cdata' => false,
+ ),
+ 'specrules' => array(
+ 'type' => 'speculationrules',
+ 'data' => '{}',
+ 'expected_cdata' => false,
+ ),
+ );
+ }
+
+ /**
+ * Tests that CDATA wrapper is not added for non-JavaScript scripts.
+ *
+ * @ticket 60320
+ *
+ * @dataProvider data_provider_to_test_cdata_wrapper_omitted_for_non_javascript_scripts
+ */
+ public function test_cdata_wrapper_omitted_for_non_javascript_scripts( $type, $data, $expected_cdata ) {
+ remove_theme_support( 'html5' );
+
+ $attrs = array();
+ if ( $type ) {
+ $attrs['type'] = $type;
+ }
+ $script = wp_get_inline_script_tag( $data, $attrs );
+ $this->assertSame( $expected_cdata, str_contains( $script, '/* <![CDATA[ */' ) );
+ $this->assertSame( $expected_cdata, str_contains( $script, '/* ]]> */' ) );
+ $this->assertStringContainsString( $data, $script );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>