Changeset 56687 for trunk/src/wp-includes/script-loader.php

Timestamp:

09/25/2023 09:03:19 PM (13 months ago)

Author:

westonruter

Message:

Script Loader: Use wp_get_script_tag() and wp_get_inline_script_tag()/wp_print_inline_script_tag() helper functions to output scripts on the frontend and login screen.

Using script tag helper functions allows plugins to employ the wp_script_attributes and wp_inline_script_attributes filters to inject the nonce attribute to apply Content Security Policy (e.g. Strict CSP). Use of helper functions also simplifies logic in WP_Scripts.

• Update wp_get_inline_script_tag() to wrap inline script in CDATA blocks for XHTML-compatibility when not using HTML5.
• Ensure the type attribute is printed first in wp_get_inline_script_tag() for back-compat.
• Wrap existing <script> tags in output buffering to retain IDE supports.
• In wp_get_inline_script_tag(), append the newline to $javascript before it is passed into the wp_inline_script_attributes filter so that the CSP hash can be computed properly.
• In the_block_template_skip_link(), opt to enqueue the inline script rather than print it.
• Add ext-php to composer.json under suggest as previously it was an undeclared dependency for running PHPUnit tests.
• Update tests to rely on DOMDocument to compare script markup, normalizing unsemantic differences.

Props westonruter, spacedmonkey, flixos90, 10upsimon, dmsnell, mukesh27, joemcgill, swissspidy, azaozz.
Fixes #58664.
See #39941.

File:

• trunk/src/wp-includes/script-loader.php (modified) (3 diffs)

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

@@ -2788 +2788 @@
 function wp_get_script_tag( $attributes ) {
     if ( ! isset( $attributes['type'] ) && ! is_admin() && ! current_theme_supports( 'html5', 'script' ) ) {
-        $attributes['type'] = 'text/javascript';
+        // Keep the type attribute as the first for legacy reasons (it has always been this way in core).
+        $attributes = array_merge(
+            array( 'type' => 'text/javascript' ),
+            $attributes
+        );
     }
     /**
@@ -2831 +2835 @@
  */
 function wp_get_inline_script_tag( $javascript, $attributes = array() ) {
-    if ( ! isset( $attributes['type'] ) && ! is_admin() && ! current_theme_supports( 'html5', 'script' ) ) {
-        $attributes['type'] = 'text/javascript';
-    }
+    $is_html5 = current_theme_supports( 'html5', 'script' ) || is_admin();
+    if ( ! isset( $attributes['type'] ) && ! $is_html5 ) {
+        // Keep the type attribute as the first for legacy reasons (it has always been this way in core).
+        $attributes = array_merge(
+            array( 'type' => 'text/javascript' ),
+            $attributes
+        );
+    }
+
+    // Ensure markup is XHTML compatible if not HTML5.
+    if ( ! $is_html5 ) {
+        $javascript = str_replace( ']]>', ']]]]><![CDATA[>', $javascript ); // Escape any existing CDATA section.
+        $javascript = sprintf( "/* <![CDATA[ */\n%s\n/* ]]> */", $javascript );
+    }
+
+    $javascript = "\n" . trim( $javascript, "\n\r " ) . "\n";
+
     /**
      * Filters attributes to be added to a script tag.
@@ -2845 +2863 @@
      */
     $attributes = apply_filters( 'wp_inline_script_attributes', $attributes, $javascript );
-
-    $javascript = "\n" . trim( $javascript, "\n\r " ) . "\n";
 
     return sprintf( "<script%s>%s</script>\n", wp_sanitize_script_attributes( $attributes ), $javascript );