Changeset 57341

Timestamp:

01/23/2024 05:54:25 PM (11 months ago)

Author:

westonruter

Message:

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 #56313.

Props westonruter, flixos90, mukesh27, dmsnell.
See #56313.
Fixes #60320.

Location:

trunk

Files:

• src/wp-includes/script-loader.php (modified) (1 diff)
• tests/phpunit/tests/dependencies/wpInlineScriptTag.php (modified) (2 diffs)

trunk/src/wp-includes/script-loader.php

@@ -2880 +2880 @@
      * @see https://www.w3.org/TR/xhtml1/#h-4.8
      */
-    if ( ! $is_html5 ) {
+    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' )
+        )
+    ) {
         /*
          * If the string `]]>` exists within the JavaScript it would break

trunk/tests/phpunit/tests/dependencies/wpInlineScriptTag.php

@@ -11 +11 @@
 class Tests_Functions_wpInlineScriptTag extends WP_UnitTestCase {
 
+    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();
+    }
+
     private $event_handler = <<<'JS'
 document.addEventListener( 'DOMContentLoaded', function () {
@@ -134 +148 @@
         );
     }
+
+    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 );
+    }
 }