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

Timestamp:

01/27/2024 01:02:35 AM (10 months ago)

Author:

westonruter

Message:

Script Loader: Clarify in docs that wp_get_inline_script_tag() and wp_print_inline_script_tag() can take non-JS data.

Props vladimiraus.
Fixes #60331.

File:

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

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

@@ -2835 +2835 @@
 
 /**
- * Wraps inline JavaScript in `<script>` tag.
+ * Constructs an inline script tag.
  *
  * It is possible to inject attributes in the `<script>` tag via the  {@see 'wp_script_attributes'}  filter.
@@ -2842 +2842 @@
  * @since 5.7.0
  *
- * @param string $javascript Inline JavaScript code.
+ * @param string $data       Data for script tag: JavaScript, importmap, speculationrules, etc.
  * @param array  $attributes Optional. Key-value pairs representing `<script>` tag attributes.
  * @return string String containing inline JavaScript code wrapped around `<script>` tag.
  */
-function wp_get_inline_script_tag( $javascript, $attributes = array() ) {
+function wp_get_inline_script_tag( $data, $attributes = array() ) {
     $is_html5 = current_theme_supports( 'html5', 'script' ) || is_admin();
     if ( ! isset( $attributes['type'] ) && ! $is_html5 ) {
@@ -2900 +2900 @@
          * an additional `<![CDATA[` leaves the contents unchanged.
          */
-        $javascript = str_replace( ']]>', ']]]]><![CDATA[>', $javascript );
+        $data = str_replace( ']]>', ']]]]><![CDATA[>', $data );
 
         // Wrap the entire escaped script inside a CDATA section.
-        $javascript = sprintf( "/* <![CDATA[ */\n%s\n/* ]]> */", $javascript );
-    }
-
-    $javascript = "\n" . trim( $javascript, "\n\r " ) . "\n";
+        $data = sprintf( "/* <![CDATA[ */\n%s\n/* ]]> */", $data );
+    }
+
+    $data = "\n" . trim( $data, "\n\r " ) . "\n";
 
     /**
@@ -2916 +2916 @@
      *                           Only the attribute name is added to the `<script>` tag for
      *                           entries with a boolean value, and that are true.
-     * @param string $javascript Inline JavaScript code.
+     * @param string $data       Inline data.
      */
-    $attributes = apply_filters( 'wp_inline_script_attributes', $attributes, $javascript );
-
-    return sprintf( "<script%s>%s</script>\n", wp_sanitize_script_attributes( $attributes ), $javascript );
-}
-
-/**
- * Prints inline JavaScript wrapped in `<script>` tag.
+    $attributes = apply_filters( 'wp_inline_script_attributes', $attributes, $data );
+
+    return sprintf( "<script%s>%s</script>\n", wp_sanitize_script_attributes( $attributes ), $data );
+}
+
+/**
+ * Prints an inline script tag.
  *
  * It is possible to inject attributes in the `<script>` tag via the  {@see 'wp_script_attributes'}  filter.
@@ -2931 +2931 @@
  * @since 5.7.0
  *
- * @param string $javascript Inline JavaScript code.
+ * @param string $data       Data for script tag: JavaScript, importmap, speculationrules, etc.
  * @param array  $attributes Optional. Key-value pairs representing `<script>` tag attributes.
  */
-function wp_print_inline_script_tag( $javascript, $attributes = array() ) {
-    echo wp_get_inline_script_tag( $javascript, $attributes );
+function wp_print_inline_script_tag( $data, $attributes = array() ) {
+    echo wp_get_inline_script_tag( $data, $attributes );
 }