<!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>[36407] trunk/src: Customizer: Improve parity between JS Setting models in preview with JS Setting models in pane.</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/36407">36407</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/36407","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>2016-01-26 23:51:17 +0000 (Tue, 26 Jan 2016)</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'>Customizer: Improve parity between JS Setting models in preview with JS Setting models in pane.
* Ensure that Setting `Value` objects in preview get initial `_dirty` flag set if values among POST data.
* Upon `saved` event, send `saved` message to preview with the `response` to trigger `saved` event there.
* Reset `_dirty` flag for all setting `Value` objects in preview upon `saved`.
* Continue to create settings synced from pane even after initial bootstrap, and create them as dirty.
* Ensure that `id` property is set for setting `Value` objects in preview.
See <a href="https://core.trac.wordpress.org/ticket/27355">#27355</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/35616">#35616</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminjscustomizecontrolsjs">trunk/src/wp-admin/js/customize-controls.js</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizemanagerphp">trunk/src/wp-includes/class-wp-customize-manager.php</a></li>
<li><a href="#trunksrcwpincludesjscustomizepreviewjs">trunk/src/wp-includes/js/customize-preview.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminjscustomizecontrolsjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/js/customize-controls.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/js/customize-controls.js 2016-01-26 22:37:41 UTC (rev 36406)
+++ trunk/src/wp-admin/js/customize-controls.js 2016-01-26 23:51:17 UTC (rev 36407)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3345,6 +3345,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> value._dirty = false;
</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">+ api.previewer.send( 'saved', response );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> api.trigger( 'saved', response );
</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="trunksrcwpincludesclasswpcustomizemanagerphp"></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/class-wp-customize-manager.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-manager.php 2016-01-26 22:37:41 UTC (rev 36406)
+++ trunk/src/wp-includes/class-wp-customize-manager.php 2016-01-26 23:51:17 UTC (rev 36407)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -805,6 +805,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'activePanels' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'activeSections' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'activeControls' => array(),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '_dirty' => array_keys( $this->unsanitized_post_values() ),
</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"> if ( 2 == $this->nonce_tick ) {
</span></span></pre></div>
<a id="trunksrcwpincludesjscustomizepreviewjs"></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/js/customize-preview.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/customize-preview.js 2016-01-26 22:37:41 UTC (rev 36406)
+++ trunk/src/wp-includes/js/customize-preview.js 2016-01-26 23:51:17 UTC (rev 36407)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -84,35 +84,58 @@
</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"> $( function() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var bg, setValue;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> api.settings = window._wpCustomizeSettings;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! api.settings )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! api.settings ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var bg;
-
</del><span class="cx" style="display: block; padding: 0 10px"> api.preview = new api.Preview({
</span><span class="cx" style="display: block; padding: 0 10px"> url: window.location.href,
</span><span class="cx" style="display: block; padding: 0 10px"> channel: api.settings.channel
</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">+ /**
+ * Create/update a setting value.
+ *
+ * @param {string} id - Setting ID.
+ * @param {*} value - Setting value.
+ * @param {boolean} [createDirty] - Whether to create a setting as dirty. Defaults to false.
+ */
+ setValue = function( id, value, createDirty ) {
+ var setting = api( id );
+ if ( setting ) {
+ setting.set( value );
+ } else {
+ createDirty = createDirty || false;
+ setting = api.create( id, value, {
+ id: id
+ } );
+
+ // Mark dynamically-created settings as dirty so they will get posted.
+ if ( createDirty ) {
+ setting._dirty = true;
+ }
+ }
+ };
+
</ins><span class="cx" style="display: block; padding: 0 10px"> api.preview.bind( 'settings', function( values ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $.each( values, function( id, value ) {
- if ( api.has( id ) )
- api( id ).set( value );
- else
- api.create( id, value );
- });
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $.each( values, setValue );
</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"> api.preview.trigger( 'settings', api.settings.values );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $.each( api.settings._dirty, function( i, id ) {
+ var setting = api( id );
+ if ( setting ) {
+ setting._dirty = true;
+ }
+ } );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> api.preview.bind( 'setting', function( args ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var value;
-
- args = args.slice();
-
- if ( value = api( args.shift() ) )
- value.set.apply( value, args );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var createDirty = true;
+ setValue.apply( null, args.concat( createDirty ) );
</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"> api.preview.bind( 'sync', function( events ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -130,6 +153,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> api.preview.send( 'documentTitle', document.title );
</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">+ api.preview.bind( 'saved', function( response ) {
+ api.trigger( 'saved', response );
+ } );
+
+ api.bind( 'saved', function() {
+ api.each( function( setting ) {
+ setting._dirty = false;
+ } );
+ } );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /*
</span><span class="cx" style="display: block; padding: 0 10px"> * Send a message to the parent customize frame with a list of which
</span><span class="cx" style="display: block; padding: 0 10px"> * containers and controls are active.
</span></span></pre>
</div>
</div>
</body>
</html>