<!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>[55553] trunk: Widgets: Defer register inline script in `WP_Widget_Custom_HTML` and `WP_Widget_Text`.</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/55553">55553</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/55553","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>spacedmonkey</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-03-15 11:36:52 +0000 (Wed, 15 Mar 2023)</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'>Widgets: Defer register inline script in `WP_Widget_Custom_HTML` and `WP_Widget_Text`.
In <a href="https://core.trac.wordpress.org/changeset/41376">[41376]</a> an inline script was added to push `idBases` for the custom html and text widgets. However, this script is not used unless the widget script is output in the widget screen / customizer. Deferring registering this script until it is needed, results in a faster server response times.
Props spacedmonkey, sakibmd, flixos90, westonruter.
Fixes <a href="https://core.trac.wordpress.org/ticket/57864">#57864</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkpackagelockjson">trunk/package-lock.json</a></li>
<li><a href="#trunksrcwpincludeswidgetsclasswpwidgetcustomhtmlphp">trunk/src/wp-includes/widgets/class-wp-widget-custom-html.php</a></li>
<li><a href="#trunksrcwpincludeswidgetsclasswpwidgettextphp">trunk/src/wp-includes/widgets/class-wp-widget-text.php</a></li>
<li><a href="#trunktestsphpunittestswidgetswpWidgetCustomHtmlphp">trunk/tests/phpunit/tests/widgets/wpWidgetCustomHtml.php</a></li>
<li><a href="#trunktestsphpunittestswidgetswpWidgetTextphp">trunk/tests/phpunit/tests/widgets/wpWidgetText.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkpackagelockjson"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/package-lock.json</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/package-lock.json 2023-03-15 09:03:17 UTC (rev 55552)
+++ trunk/package-lock.json 2023-03-15 11:36:52 UTC (rev 55553)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -11941,7 +11941,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "from2-string": {
</span><span class="cx" style="display: block; padding: 0 10px"> "version": "1.1.0",
</span><span class="cx" style="display: block; padding: 0 10px"> "resolved": "https://registry.npmjs.org/from2-string/-/from2-string-1.1.0.tgz",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "integrity": "sha512-m8vCh+KnXXXBtfF2VUbiYlQ+nczLcntB0BrtNgpmLkHylhObe9WF1b2LZjBBzrZzA6P4mkEla6ZYQoOUTG8cYA==",
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "integrity": "sha1-GCgrJ9CKJnyzAwzSuLSw8hKvdSo=",
</ins><span class="cx" style="display: block; padding: 0 10px"> "requires": {
</span><span class="cx" style="display: block; padding: 0 10px"> "from2": "^2.0.3"
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -21099,7 +21099,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "promise-polyfill": {
</span><span class="cx" style="display: block; padding: 0 10px"> "version": "1.1.6",
</span><span class="cx" style="display: block; padding: 0 10px"> "resolved": "https://registry.npmjs.org/promise-polyfill/-/promise-polyfill-1.1.6.tgz",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "integrity": "sha512-7rrONfyLkDEc7OJ5QBkqa4KI4EBhCd340xRuIUPGCfu13znS+vx+VDdrT9ODAJHlXm7w4lbxN3DRjyv58EuzDg=="
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "integrity": "sha1-zQTv9G9clcOn0EVZHXm14+AfEtc="
</ins><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> "prompts": {
</span><span class="cx" style="display: block; padding: 0 10px"> "version": "2.4.2",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23238,7 +23238,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "stream-from-promise": {
</span><span class="cx" style="display: block; padding: 0 10px"> "version": "1.0.0",
</span><span class="cx" style="display: block; padding: 0 10px"> "resolved": "https://registry.npmjs.org/stream-from-promise/-/stream-from-promise-1.0.0.tgz",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "integrity": "sha512-j84KLkudt+gr8KJ21RB02btPLx61uGbrLnewsWz6QKmsz8/c4ZFqXw6mJh5+G4oRN7DgDxdbjPxnpySpg1mUig=="
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "integrity": "sha1-djaH9913fkyJT2QIMz/Gs/yKYbs="
</ins><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> "stream-to-string": {
</span><span class="cx" style="display: block; padding: 0 10px"> "version": "1.2.0",
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -24506,7 +24506,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> "toposort": {
</span><span class="cx" style="display: block; padding: 0 10px"> "version": "2.0.2",
</span><span class="cx" style="display: block; padding: 0 10px"> "resolved": "https://registry.npmjs.org/toposort/-/toposort-2.0.2.tgz",
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- "integrity": "sha512-0a5EOkAUp8D4moMi2W8ZF8jcga7BgZd91O/yabJCFY8az+XSzeGyTKs0Aoo897iV1Nj6guFq8orWDS96z91oGg=="
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ "integrity": "sha1-riF2gXXRVZ1IvvNUILL0li8JwzA="
</ins><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px"> "totalist": {
</span><span class="cx" style="display: block; padding: 0 10px"> "version": "1.1.0",
</span></span></pre></div>
<a id="trunksrcwpincludeswidgetsclasswpwidgetcustomhtmlphp"></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/widgets/class-wp-widget-custom-html.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/widgets/class-wp-widget-custom-html.php 2023-03-15 09:03:17 UTC (rev 55552)
+++ trunk/src/wp-includes/widgets/class-wp-widget-custom-html.php 2023-03-15 11:36:52 UTC (rev 55553)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -69,8 +69,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $this->registered = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_add_inline_script( 'custom-html-widgets', sprintf( 'wp.customHtmlWidgets.idBases.push( %s );', wp_json_encode( $this->id_base ) ) );
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Note that the widgets component in the customizer will also do
</span><span class="cx" style="display: block; padding: 0 10px"> // the 'admin_print_scripts-widgets.php' action in WP_Customize_Widgets::print_scripts().
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'admin_print_scripts-widgets.php', array( $this, 'enqueue_admin_scripts' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -216,6 +214,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_script( 'custom-html-widgets' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_add_inline_script( 'custom-html-widgets', sprintf( 'wp.customHtmlWidgets.idBases.push( %s );', wp_json_encode( $this->id_base ) ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $settings ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $settings = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'disabled' => true,
</span></span></pre></div>
<a id="trunksrcwpincludeswidgetsclasswpwidgettextphp"></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/widgets/class-wp-widget-text.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/widgets/class-wp-widget-text.php 2023-03-15 09:03:17 UTC (rev 55552)
+++ trunk/src/wp-includes/widgets/class-wp-widget-text.php 2023-03-15 11:36:52 UTC (rev 55553)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,8 +56,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $this->registered = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- wp_add_inline_script( 'text-widgets', sprintf( 'wp.textWidgets.idBases.push( %s );', wp_json_encode( $this->id_base ) ) );
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( $this->is_preview() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_preview_scripts' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -436,6 +434,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_editor();
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_media();
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_script( 'text-widgets' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ wp_add_inline_script( 'text-widgets', sprintf( 'wp.textWidgets.idBases.push( %s );', wp_json_encode( $this->id_base ) ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_add_inline_script( 'text-widgets', 'wp.textWidgets.init();', 'after' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestswidgetswpWidgetCustomHtmlphp"></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/widgets/wpWidgetCustomHtml.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/widgets/wpWidgetCustomHtml.php 2023-03-15 09:03:17 UTC (rev 55552)
+++ trunk/tests/phpunit/tests/widgets/wpWidgetCustomHtml.php 2023-03-15 11:36:52 UTC (rev 55553)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -67,7 +67,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 10, has_action( 'admin_print_scripts-widgets.php', array( $widget, 'enqueue_admin_scripts' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 10, has_action( 'admin_footer-widgets.php', array( 'WP_Widget_Custom_HTML', 'render_control_template_scripts' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 10, has_action( 'admin_head-widgets.php', array( 'WP_Widget_Custom_HTML', 'add_help_text' ) ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertContains( 'wp.customHtmlWidgets.idBases.push( "custom_html" );', wp_scripts()->registered['custom-html-widgets']->extra['after'] );
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestswidgetswpWidgetTextphp"></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/widgets/wpWidgetText.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/widgets/wpWidgetText.php 2023-03-15 09:03:17 UTC (rev 55552)
+++ trunk/tests/phpunit/tests/widgets/wpWidgetText.php 2023-03-15 11:36:52 UTC (rev 55553)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -67,7 +67,6 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 10, has_action( 'admin_print_scripts-widgets.php', array( $widget, 'enqueue_admin_scripts' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( 10, has_action( 'admin_footer-widgets.php', array( 'WP_Widget_Text', 'render_control_template_scripts' ) ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertContains( 'wp.textWidgets.idBases.push( "text" );', wp_scripts()->registered['text-widgets']->extra['after'] );
</del><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( has_action( 'wp_enqueue_scripts', array( $widget, 'enqueue_preview_scripts' ) ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>