summaryrefslogtreecommitdiffstatshomepage
path: root/src
diff options
context:
space:
mode:
authorWeston Ruter <westonruter@git.wordpress.org>2023-09-25 21:03:19 +0000
committerWeston Ruter <westonruter@git.wordpress.org>2023-09-25 21:03:19 +0000
commit4df5cd15a5c54c0c29e31b4cc68cd5483366b53e (patch)
treebe8386d4d212f1e6870f4438d05ed57623a10d66 /src
parent5c8b4c1b00d681abf3751ba0a8b009d5705acb02 (diff)
downloadwordpress-4df5cd15a5c54c0c29e31b4cc68cd5483366b53e.tar.gz
wordpress-4df5cd15a5c54c0c29e31b4cc68cd5483366b53e.zip
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. git-svn-id: https://develop.svn.wordpress.org/trunk@56687 602fd350-edb4-49c9-b593-d223f7449a82
Diffstat (limited to 'src')
-rw-r--r--src/wp-includes/class-wp-customize-manager.php14
-rw-r--r--src/wp-includes/class-wp-customize-nav-menus.php2
-rw-r--r--src/wp-includes/class-wp-customize-widgets.php9
-rw-r--r--src/wp-includes/class-wp-scripts.php59
-rw-r--r--src/wp-includes/comment-template.php2
-rw-r--r--src/wp-includes/customize/class-wp-customize-selective-refresh.php2
-rw-r--r--src/wp-includes/functions.php2
-rw-r--r--src/wp-includes/script-loader.php26
-rw-r--r--src/wp-includes/theme-templates.php8
-rw-r--r--src/wp-includes/theme.php5
-rw-r--r--src/wp-includes/widgets/class-wp-widget-archives.php8
-rw-r--r--src/wp-includes/widgets/class-wp-widget-categories.php7
-rw-r--r--src/wp-login.php33
13 files changed, 88 insertions, 89 deletions
diff --git a/src/wp-includes/class-wp-customize-manager.php b/src/wp-includes/class-wp-customize-manager.php
index 0bceee3454..aebcfeb892 100644
--- a/src/wp-includes/class-wp-customize-manager.php
+++ b/src/wp-includes/class-wp-customize-manager.php
@@ -464,6 +464,8 @@ final class WP_Customize_Manager {
),
'error' => $ajax_message,
);
+ $message .= ob_get_clean();
+ ob_start();
?>
<script>
( function( api, settings ) {
@@ -472,7 +474,7 @@ final class WP_Customize_Manager {
} )( wp.customize, <?php echo wp_json_encode( $settings ); ?> );
</script>
<?php
- $message .= ob_get_clean();
+ $message .= wp_get_inline_script_tag( str_replace( array( '<script>', '</script>' ), '', ob_get_clean() ) );
}
wp_die( $message );
@@ -2083,6 +2085,7 @@ final class WP_Customize_Manager {
if ( ! $this->messenger_channel ) {
return;
}
+ ob_start();
?>
<script>
( function() {
@@ -2106,6 +2109,7 @@ final class WP_Customize_Manager {
} )();
</script>
<?php
+ wp_print_inline_script_tag( str_replace( array( '<script>', '</script>' ), '', ob_get_clean() ) );
}
/**
@@ -2201,8 +2205,9 @@ final class WP_Customize_Manager {
}
}
+ ob_start();
?>
- <script type="text/javascript">
+ <script>
var _wpCustomizeSettings = <?php echo wp_json_encode( $settings ); ?>;
_wpCustomizeSettings.values = {};
(function( v ) {
@@ -2225,6 +2230,7 @@ final class WP_Customize_Manager {
})( _wpCustomizeSettings.values );
</script>
<?php
+ wp_print_inline_script_tag( str_replace( array( '<script>', '</script>' ), '', ob_get_clean() ) );
}
/**
@@ -4976,8 +4982,9 @@ final class WP_Customize_Manager {
}
}
+ ob_start();
?>
- <script type="text/javascript">
+ <script>
var _wpCustomizeSettings = <?php echo wp_json_encode( $settings ); ?>;
_wpCustomizeSettings.initialClientTimestamp = _.now();
_wpCustomizeSettings.controls = {};
@@ -5012,6 +5019,7 @@ final class WP_Customize_Manager {
?>
</script>
<?php
+ wp_print_inline_script_tag( str_replace( array( '<script>', '</script>' ), '', ob_get_clean() ) );
}
/**
diff --git a/src/wp-includes/class-wp-customize-nav-menus.php b/src/wp-includes/class-wp-customize-nav-menus.php
index bbda8b51b3..20f88f8440 100644
--- a/src/wp-includes/class-wp-customize-nav-menus.php
+++ b/src/wp-includes/class-wp-customize-nav-menus.php
@@ -1559,7 +1559,7 @@ final class WP_Customize_Nav_Menus {
$exports = array(
'navMenuInstanceArgs' => $this->preview_nav_menu_instance_args,
);
- printf( '<script>var _wpCustomizePreviewNavMenusExports = %s;</script>', wp_json_encode( $exports ) );
+ wp_print_inline_script_tag( sprintf( 'var _wpCustomizePreviewNavMenusExports = %s;', wp_json_encode( $exports ) ) );
}
/**
diff --git a/src/wp-includes/class-wp-customize-widgets.php b/src/wp-includes/class-wp-customize-widgets.php
index 93006ef916..c8a00c741f 100644
--- a/src/wp-includes/class-wp-customize-widgets.php
+++ b/src/wp-includes/class-wp-customize-widgets.php
@@ -1310,12 +1310,9 @@ final class WP_Customize_Widgets {
foreach ( $settings['registeredWidgets'] as &$registered_widget ) {
unset( $registered_widget['callback'] ); // May not be JSON-serializeable.
}
-
- ?>
- <script type="text/javascript">
- var _wpWidgetCustomizerPreviewSettings = <?php echo wp_json_encode( $settings ); ?>;
- </script>
- <?php
+ wp_print_inline_script_tag(
+ sprintf( 'var _wpWidgetCustomizerPreviewSettings = %s;', wp_json_encode( $settings ) )
+ );
}
/**
diff --git a/src/wp-includes/class-wp-scripts.php b/src/wp-includes/class-wp-scripts.php
index cf0259c3c4..a6a283f953 100644
--- a/src/wp-includes/class-wp-scripts.php
+++ b/src/wp-includes/class-wp-scripts.php
@@ -123,17 +123,6 @@ class WP_Scripts extends WP_Dependencies {
public $default_dirs;
/**
- * Holds a string which contains the type attribute for script tag.
- *
- * If the active theme does not declare HTML5 support for 'script',
- * then it initializes as `type='text/javascript'`.
- *
- * @since 5.3.0
- * @var string
- */
- private $type_attr = '';
-
- /**
* Holds a mapping of dependents (as handles) for a given script handle.
* Used to optimize recursive dependency tree checks.
*
@@ -167,14 +156,6 @@ class WP_Scripts extends WP_Dependencies {
* @since 3.4.0
*/
public function init() {
- if (
- function_exists( 'is_admin' ) && ! is_admin()
- &&
- function_exists( 'current_theme_supports' ) && ! current_theme_supports( 'html5', 'script' )
- ) {
- $this->type_attr = " type='text/javascript'";
- }
-
/**
* Fires when the WP_Scripts instance is initialized.
*
@@ -245,20 +226,7 @@ class WP_Scripts extends WP_Dependencies {
return $output;
}
- printf( "<script%s id='%s-js-extra'>\n", $this->type_attr, esc_attr( $handle ) );
-
- // CDATA is not needed for HTML 5.
- if ( $this->type_attr ) {
- echo "/* <![CDATA[ */\n";
- }
-
- echo "$output\n";
-
- if ( $this->type_attr ) {
- echo "/* ]]> */\n";
- }
-
- echo "</script>\n";
+ wp_print_inline_script_tag( $output, array( 'id' => "{$handle}-js-extra" ) );
return true;
}
@@ -335,7 +303,7 @@ class WP_Scripts extends WP_Dependencies {
$translations = $this->print_translations( $handle, false );
if ( $translations ) {
- $translations = sprintf( "<script%s id='%s-js-translations'>\n%s\n</script>\n", $this->type_attr, esc_attr( $handle ), $translations );
+ $translations = wp_get_inline_script_tag( $translations, array( 'id' => "{$handle}-js-translations" ) );
}
if ( $this->do_concat ) {
@@ -403,21 +371,24 @@ class WP_Scripts extends WP_Dependencies {
}
/** This filter is documented in wp-includes/class-wp-scripts.php */
- $src = esc_url( apply_filters( 'script_loader_src', $src, $handle ) );
+ $src = esc_url_raw( apply_filters( 'script_loader_src', $src, $handle ) );
if ( ! $src ) {
return true;
}
- $tag = $translations . $cond_before . $before_script;
- $tag .= sprintf(
- "<script%s src='%s' id='%s-js'%s%s></script>\n",
- $this->type_attr,
- $src, // Value is escaped above.
- esc_attr( $handle ),
- $strategy ? " {$strategy}" : '',
- $intended_strategy ? " data-wp-strategy='{$intended_strategy}'" : ''
+ $attr = array(
+ 'src' => $src,
+ 'id' => "{$handle}-js",
);
+ if ( $strategy ) {
+ $attr[ $strategy ] = true;
+ }
+ if ( $intended_strategy ) {
+ $attr['data-wp-strategy'] = $intended_strategy;
+ }
+ $tag = $translations . $cond_before . $before_script;
+ $tag .= wp_get_script_tag( $attr );
$tag .= $after_script . $cond_after;
/**
@@ -720,7 +691,7 @@ class WP_Scripts extends WP_Dependencies {
JS;
if ( $display ) {
- printf( "<script%s id='%s-js-translations'>\n%s\n</script>\n", $this->type_attr, esc_attr( $handle ), $output );
+ wp_print_inline_script_tag( $output, array( 'id' => "{$handle}-js-translations" ) );
}
return $output;
diff --git a/src/wp-includes/comment-template.php b/src/wp-includes/comment-template.php
index a80dc60e41..a1005d56e2 100644
--- a/src/wp-includes/comment-template.php
+++ b/src/wp-includes/comment-template.php
@@ -1366,7 +1366,7 @@ function wp_comment_form_unfiltered_html_nonce() {
if ( current_user_can( 'unfiltered_html' ) ) {
wp_nonce_field( 'unfiltered-html-comment_' . $post_id, '_wp_unfiltered_html_comment_disabled', false );
- echo "<script>(function(){if(window===window.parent){document.getElementById('_wp_unfiltered_html_comment_disabled').name='_wp_unfiltered_html_comment';}})();</script>\n";
+ wp_print_inline_script_tag( "(function(){if(window===window.parent){document.getElementById('_wp_unfiltered_html_comment_disabled').name='_wp_unfiltered_html_comment';}})();" );
}
}
diff --git a/src/wp-includes/customize/class-wp-customize-selective-refresh.php b/src/wp-includes/customize/class-wp-customize-selective-refresh.php
index f75baff3e4..d20e8ab0a7 100644
--- a/src/wp-includes/customize/class-wp-customize-selective-refresh.php
+++ b/src/wp-includes/customize/class-wp-customize-selective-refresh.php
@@ -193,7 +193,7 @@ final class WP_Customize_Selective_Refresh {
);
// Export data to JS.
- printf( '<script>var _customizePartialRefreshExports = %s;</script>', wp_json_encode( $exports ) );
+ wp_print_inline_script_tag( sprintf( 'var _customizePartialRefreshExports = %s;', wp_json_encode( $exports ) ) );
}
/**
diff --git a/src/wp-includes/functions.php b/src/wp-includes/functions.php
index ab49f8f405..a86d8eaa27 100644
--- a/src/wp-includes/functions.php
+++ b/src/wp-includes/functions.php
@@ -7655,6 +7655,7 @@ function wp_post_preview_js() {
// Has to match the window name used in post_submit_meta_box().
$name = 'wp-preview-' . (int) $post->ID;
+ ob_start();
?>
<script>
( function() {
@@ -7670,6 +7671,7 @@ function wp_post_preview_js() {
}());
</script>
<?php
+ wp_print_inline_script_tag( str_replace( array( '<script>', '</script>' ), '', ob_get_clean() ) );
}
/**
diff --git a/src/wp-includes/script-loader.php b/src/wp-includes/script-loader.php
index 041c828bf2..dfc84c7b2f 100644
--- a/src/wp-includes/script-loader.php
+++ b/src/wp-includes/script-loader.php
@@ -2787,7 +2787,11 @@ function wp_sanitize_script_attributes( $attributes ) {
*/
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
+ );
}
/**
* Filters attributes to be added to a script tag.
@@ -2830,9 +2834,23 @@ function wp_print_script_tag( $attributes ) {
* @return string String containing inline JavaScript code wrapped around `<script>` tag.
*/
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,8 +2863,6 @@ function wp_get_inline_script_tag( $javascript, $attributes = array() ) {
*/
$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 );
}
diff --git a/src/wp-includes/theme-templates.php b/src/wp-includes/theme-templates.php
index 3604dc6dbe..8f0ee9a69f 100644
--- a/src/wp-includes/theme-templates.php
+++ b/src/wp-includes/theme-templates.php
@@ -160,8 +160,9 @@ function the_block_template_skip_link() {
wp_enqueue_style( $handle );
/**
- * Print the skip-link script.
+ * Enqueue the skip-link script.
*/
+ ob_start();
?>
<script>
( function() {
@@ -204,6 +205,11 @@ function the_block_template_skip_link() {
}() );
</script>
<?php
+ $skip_link_script = str_replace( array( '<script>', '</script>' ), '', ob_get_clean() );
+ $script_handle = 'wp-block-template-skip-link';
+ wp_register_script( $script_handle, false );
+ wp_add_inline_script( $script_handle, $skip_link_script );
+ wp_enqueue_script( $script_handle );
}
/**
diff --git a/src/wp-includes/theme.php b/src/wp-includes/theme.php
index 6be2ad700a..ba88a83fde 100644
--- a/src/wp-includes/theme.php
+++ b/src/wp-includes/theme.php
@@ -3783,9 +3783,9 @@ function wp_customize_support_script() {
$admin_origin = parse_url( admin_url() );
$home_origin = parse_url( home_url() );
$cross_domain = ( strtolower( $admin_origin['host'] ) !== strtolower( $home_origin['host'] ) );
- $type_attr = current_theme_supports( 'html5', 'script' ) ? '' : ' type="text/javascript"';
+ ob_start();
?>
- <script<?php echo $type_attr; ?>>
+ <script>
(function() {
var request, b = document.body, c = 'className', cs = 'customize-support', rcs = new RegExp('(^|\\s+)(no-)?'+cs+'(\\s+|$)');
@@ -3801,6 +3801,7 @@ function wp_customize_support_script() {
}());
</script>
<?php
+ wp_print_inline_script_tag( str_replace( array( '<script>', '</script>' ), '', ob_get_clean() ) );
}
/**
diff --git a/src/wp-includes/widgets/class-wp-widget-archives.php b/src/wp-includes/widgets/class-wp-widget-archives.php
index f32aa9bbb0..21d3a7b672 100644
--- a/src/wp-includes/widgets/class-wp-widget-archives.php
+++ b/src/wp-includes/widgets/class-wp-widget-archives.php
@@ -100,8 +100,6 @@ class WP_Widget_Archives extends WP_Widget {
$label = __( 'Select Post' );
break;
}
-
- $type_attr = current_theme_supports( 'html5', 'script' ) ? '' : ' type="text/javascript"';
?>
<option value=""><?php echo esc_html( $label ); ?></option>
@@ -109,8 +107,8 @@ class WP_Widget_Archives extends WP_Widget {
</select>
-<script<?php echo $type_attr; ?>>
-/* <![CDATA[ */
+ <?php ob_start(); ?>
+<script>
(function() {
var dropdown = document.getElementById( "<?php echo esc_js( $dropdown_id ); ?>" );
function onSelectChange() {
@@ -120,9 +118,9 @@ class WP_Widget_Archives extends WP_Widget {
}
dropdown.onchange = onSelectChange;
})();
-/* ]]> */
</script>
<?php
+ wp_print_inline_script_tag( str_replace( array( '<script>', '</script>' ), '', ob_get_clean() ) );
} else {
$format = current_theme_supports( 'html5', 'navigation-widgets' ) ? 'html5' : 'xhtml';
diff --git a/src/wp-includes/widgets/class-wp-widget-categories.php b/src/wp-includes/widgets/class-wp-widget-categories.php
index 3c009709ba..e00ce7f960 100644
--- a/src/wp-includes/widgets/class-wp-widget-categories.php
+++ b/src/wp-includes/widgets/class-wp-widget-categories.php
@@ -92,11 +92,10 @@ class WP_Widget_Categories extends WP_Widget {
echo '</form>';
- $type_attr = current_theme_supports( 'html5', 'script' ) ? '' : ' type="text/javascript"';
+ ob_start();
?>
-<script<?php echo $type_attr; ?>>
-/* <![CDATA[ */
+<script>
(function() {
var dropdown = document.getElementById( "<?php echo esc_js( $dropdown_id ); ?>" );
function onCatChange() {
@@ -106,10 +105,10 @@ class WP_Widget_Categories extends WP_Widget {
}
dropdown.onchange = onCatChange;
})();
-/* ]]> */
</script>
<?php
+ wp_print_inline_script_tag( str_replace( array( '<script>', '</script>' ), '', ob_get_clean() ) );
} else {
$format = current_theme_supports( 'html5', 'navigation-widgets' ) ? 'html5' : 'xhtml';
diff --git a/src/wp-login.php b/src/wp-login.php
index 60877bdb70..80887f0420 100644
--- a/src/wp-login.php
+++ b/src/wp-login.php
@@ -101,9 +101,11 @@ function login_header( $title = 'Log In', $message = '', $wp_error = null ) {
* but maybe better if it's not removable by plugins.
*/
if ( 'loggedout' === $wp_error->get_error_code() ) {
+ ob_start();
?>
<script>if("sessionStorage" in window){try{for(var key in sessionStorage){if(key.indexOf("wp-autosave-")!=-1){sessionStorage.removeItem(key)}}}catch(e){}};</script>
<?php
+ wp_print_inline_script_tag( str_replace( array( '<script>', '</script>' ), '', ob_get_clean() ) );
}
/**
@@ -193,9 +195,10 @@ function login_header( $title = 'Log In', $message = '', $wp_error = null ) {
?>
</head>
<body class="login no-js <?php echo esc_attr( implode( ' ', $classes ) ); ?>">
- <script type="text/javascript">
- document.body.className = document.body.className.replace('no-js','js');
- </script>
+ <?php
+ wp_print_inline_script_tag( "document.body.className = document.body.className.replace('no-js','js');" );
+ ?>
+
<?php
/**
* Fires in the login page header after the body tag is opened.
@@ -414,12 +417,14 @@ function login_footer( $input_id = '' ) {
<?php
if ( ! empty( $input_id ) ) {
+ ob_start();
?>
- <script type="text/javascript">
+ <script>
try{document.getElementById('<?php echo $input_id; ?>').focus();}catch(e){}
if(typeof wpOnload==='function')wpOnload();
</script>
<?php
+ wp_print_inline_script_tag( str_replace( array( '<script>', '</script>' ), '', ob_get_clean() ) );
}
/**
@@ -441,11 +446,7 @@ function login_footer( $input_id = '' ) {
* @since 3.0.0
*/
function wp_shake_js() {
- ?>
- <script type="text/javascript">
- document.querySelector('form').classList.add('shake');
- </script>
- <?php
+ wp_print_inline_script_tag( "document.querySelector('form').classList.add('shake');" );
}
/**
@@ -1357,9 +1358,11 @@ switch ( $action ) {
do_action( 'login_footer' );
if ( $customize_login ) {
+ ob_start();
?>
- <script type="text/javascript">setTimeout( function(){ new wp.customize.Messenger({ url: '<?php echo wp_customize_url(); ?>', channel: 'login' }).send('login') }, 1000 );</script>
+ <script>setTimeout( function(){ new wp.customize.Messenger({ url: '<?php echo wp_customize_url(); ?>', channel: 'login' }).send('login') }, 1000 );</script>
<?php
+ wp_print_inline_script_tag( str_replace( array( '<script>', '</script>' ), '', ob_get_clean() ) );
}
?>
@@ -1605,15 +1608,12 @@ switch ( $action ) {
// Run `wpOnload()` if defined.
$login_script .= "if ( typeof wpOnload === 'function' ) { wpOnload() }";
- ?>
- <script type="text/javascript">
- <?php echo $login_script; ?>
- </script>
- <?php
+ wp_print_inline_script_tag( $login_script );
if ( $interim_login ) {
+ ob_start();
?>
- <script type="text/javascript">
+ <script>
( function() {
try {
var i, links = document.getElementsByTagName( 'a' );
@@ -1627,6 +1627,7 @@ switch ( $action ) {
}());
</script>
<?php
+ wp_print_inline_script_tag( str_replace( array( '<script>', '</script>' ), '', ob_get_clean() ) );
}
login_footer();