<!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>[41095] branches/4.8: Widgets: Improve Text widget's reliability in syncing Visual tab's contents with Text tab and with hidden sync inputs.</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 { 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/41095">41095</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/41095","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>westonruter</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-07-19 20:50:48 +0000 (Wed, 19 Jul 2017)</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: Improve Text widget's reliability in syncing Visual tab's contents with Text tab and with hidden sync inputs.
Merges <a href="https://core.trac.wordpress.org/changeset/41094">[41094]</a> onto 4.8 branch.
Amends <a href="https://core.trac.wordpress.org/changeset/40631">[40631]</a>.
Props azaozz, westonruter, rinkuyadav999 for testing.
See <a href="https://core.trac.wordpress.org/ticket/35243">#35243</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/40974">#40974</a> for 4.8.1.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#branches48srcwpadminjswidgetstextwidgetsjs">branches/4.8/src/wp-admin/js/widgets/text-widgets.js</a></li>
</ul>
<h3>Property Changed</h3>
<ul>
<li><a href="#branches48">branches/4.8/</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<span class="cx" style="display: block; padding: 0 10px">Index: branches/4.8
</span><span class="cx" style="display: block; padding: 0 10px">===================================================================
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">--- branches/4.8 2017-07-19 20:48:28 UTC (rev 41094)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+++ branches/4.8 2017-07-19 20:50:48 UTC (rev 41095)
</ins><a id="branches48"></a>
<div class="propset"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Property changes: branches/4.8</h4>
<pre class="diff"><span>
</span></pre></div>
<a id="svnmergeinfo"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: svn:mergeinfo</h4></div>
<span class="cx" style="display: block; padding: 0 10px"> /branches/3.1:18031
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.3:20543
</span><span class="cx" style="display: block; padding: 0 10px"> /branches/3.4:21757
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-/trunk:18512,40872-40873,40879,40881,40883,40885,40892-40893,40896-40897,40901,40926-40927,40939,40941,40961,40990-40991,40995,41000,41009,41020,41022,41028,41035,41037,41043,41045-41047,41050,41070,41072,41086,41088
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/trunk:18512,40872-40873,40879,40881,40883,40885,40892-40893,40896-40897,40901,40926-40927,40939,40941,40961,40990-40991,40995,41000,41009,41020,41022,41028,41035,41037,41043,41045-41047,41050,41070,41072,41086,41088,41094
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="branches48srcwpadminjswidgetstextwidgetsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: branches/4.8/src/wp-admin/js/widgets/text-widgets.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- branches/4.8/src/wp-admin/js/widgets/text-widgets.js 2017-07-19 20:48:28 UTC (rev 41094)
+++ branches/4.8/src/wp-admin/js/widgets/text-widgets.js 2017-07-19 20:50:48 UTC (rev 41095)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -81,8 +81,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> _.each( control.fields, function( fieldInput, fieldName ) {
</span><span class="cx" style="display: block; padding: 0 10px"> fieldInput.on( 'input change', function updateSyncField() {
</span><span class="cx" style="display: block; padding: 0 10px"> var syncInput = control.syncContainer.find( 'input[type=hidden].' + fieldName );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( syncInput.val() !== $( this ).val() ) {
- syncInput.val( $( this ).val() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( syncInput.val() !== fieldInput.val() ) {
+ syncInput.val( fieldInput.val() );
</ins><span class="cx" style="display: block; padding: 0 10px"> syncInput.trigger( 'change' );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -164,17 +164,62 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @returns {void}
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> initializeEditor: function initializeEditor() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var control = this, changeDebounceDelay = 1000, id, textarea, restoreTextMode = false;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var control = this, changeDebounceDelay = 1000, id, textarea, triggerChangeIfDirty, restoreTextMode = false, needsTextareaChangeTrigger = false;
</ins><span class="cx" style="display: block; padding: 0 10px"> textarea = control.fields.text;
</span><span class="cx" style="display: block; padding: 0 10px"> id = textarea.attr( 'id' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Trigger change if dirty.
+ *
+ * @returns {void}
+ */
+ triggerChangeIfDirty = function() {
+ var updateWidgetBuffer = 300; // See wp.customize.Widgets.WidgetControl._setupUpdateUI() which uses 250ms for updateWidgetDebounced.
+ if ( control.editor.isDirty() ) {
+
+ /*
+ * Account for race condition in customizer where user clicks Save & Publish while
+ * focus was just previously given to to the editor. Since updates to the editor
+ * are debounced at 1 second and since widget input changes are only synced to
+ * settings after 250ms, the customizer needs to be put into the processing
+ * state during the time between the change event is triggered and updateWidget
+ * logic starts. Note that the debounced update-widget request should be able
+ * to be removed with the removal of the update-widget request entirely once
+ * widgets are able to mutate their own instance props directly in JS without
+ * having to make server round-trips to call the respective WP_Widget::update()
+ * callbacks. See <https://core.trac.wordpress.org/ticket/33507>.
+ */
+ if ( wp.customize && wp.customize.state ) {
+ wp.customize.state( 'processing' ).set( wp.customize.state( 'processing' ).get() + 1 );
+ _.delay( function() {
+ wp.customize.state( 'processing' ).set( wp.customize.state( 'processing' ).get() - 1 );
+ }, updateWidgetBuffer );
+ }
+
+ if ( ! control.editor.isHidden() ) {
+ control.editor.save();
+ }
+ }
+
+ // Trigger change on textarea when it is dirty for sake of widgets in the Customizer needing to sync form inputs to setting models.
+ if ( needsTextareaChangeTrigger ) {
+ textarea.trigger( 'change' );
+ needsTextareaChangeTrigger = false;
+ }
+ };
+
+ // Just-in-time force-update the hidden input fields.
+ control.syncContainer.closest( '.widget' ).find( '[name=savewidget]:first' ).on( 'click', function onClickSaveButton() {
+ triggerChangeIfDirty();
+ });
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Build (or re-build) the visual editor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @returns {void}
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function buildEditor() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var editor, triggerChangeIfDirty, onInit, showPointerElement;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var editor, onInit, showPointerElement;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Abort building if the textarea is gone, likely due to the widget having been deleted entirely.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! document.getElementById( id ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -230,7 +275,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If a prior mce instance was replaced, and it was in text mode, toggle to text mode.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( restoreTextMode ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- switchEditors.go( id, 'toggle' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ switchEditors.go( id, 'html' );
</ins><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"> // Show the pointer.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -269,38 +314,19 @@
</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"> control.editorFocused = false;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- triggerChangeIfDirty = function() {
- var updateWidgetBuffer = 300; // See wp.customize.Widgets.WidgetControl._setupUpdateUI() which uses 250ms for updateWidgetDebounced.
- if ( editor.isDirty() ) {
</del><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Account for race condition in customizer where user clicks Save & Publish while
- * focus was just previously given to to the editor. Since updates to the editor
- * are debounced at 1 second and since widget input changes are only synced to
- * settings after 250ms, the customizer needs to be put into the processing
- * state during the time between the change event is triggered and updateWidget
- * logic starts. Note that the debounced update-widget request should be able
- * to be removed with the removal of the update-widget request entirely once
- * widgets are able to mutate their own instance props directly in JS without
- * having to make server round-trips to call the respective WP_Widget::update()
- * callbacks. See <https://core.trac.wordpress.org/ticket/33507>.
- */
- if ( wp.customize && wp.customize.state ) {
- wp.customize.state( 'processing' ).set( wp.customize.state( 'processing' ).get() + 1 );
- _.delay( function() {
- wp.customize.state( 'processing' ).set( wp.customize.state( 'processing' ).get() - 1 );
- }, updateWidgetBuffer );
- }
-
- editor.save();
- textarea.trigger( 'change' );
- }
- };
- editor.on( 'focus', function() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ editor.on( 'focus', function onEditorFocus() {
</ins><span class="cx" style="display: block; padding: 0 10px"> control.editorFocused = true;
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ editor.on( 'paste', function onEditorPaste() {
+ editor.setDirty( true ); // Because pasting doesn't currently set the dirty state.
+ triggerChangeIfDirty();
+ });
+ editor.on( 'NodeChange', function onNodeChange() {
+ needsTextareaChangeTrigger = true;
+ });
</ins><span class="cx" style="display: block; padding: 0 10px"> editor.on( 'NodeChange', _.debounce( triggerChangeIfDirty, changeDebounceDelay ) );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- editor.on( 'blur', function() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ editor.on( 'blur hide', function onEditorBlur() {
</ins><span class="cx" style="display: block; padding: 0 10px"> control.editorFocused = false;
</span><span class="cx" style="display: block; padding: 0 10px"> triggerChangeIfDirty();
</span><span class="cx" style="display: block; padding: 0 10px"> });
</span></span></pre>
</div>
</div>
</body>
</html>