<!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>[31705] trunk: Customizer: Fix previewing and applying widgets when previewing another theme.</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/31705">31705</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/31705","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>ocean90</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-03-10 22:38:30 +0000 (Tue, 10 Mar 2015)</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: Fix previewing and applying widgets when previewing another theme.
* Unset `wp_get_sidebars_widgets()`' non-admin cache var `$_wp_sidebars_widgets` in Customize theme preview.
* Add `WP_Customize_Setting::$dirty` so that settings can be initially-dirty when the Customizer loads.
* Mark `old_sidebars_widgets_data` setting initially-dirty.
* Mark all `sidebars_widgets` settings as initially-dirty during theme switch.
props westonruter.
see <a href="https://core.trac.wordpress.org/ticket/31484">#31484</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadmincustomizephp">trunk/src/wp-admin/customize.php</a></li>
<li><a href="#trunksrcwpadminjscustomizecontrolsjs">trunk/src/wp-admin/js/customize-controls.js</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizesettingphp">trunk/src/wp-includes/class-wp-customize-setting.php</a></li>
<li><a href="#trunksrcwpincludesclasswpcustomizewidgetsphp">trunk/src/wp-includes/class-wp-customize-widgets.php</a></li>
<li><a href="#trunktestsphpunittestscustomizesettingphp">trunk/tests/phpunit/tests/customize/setting.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadmincustomizephp"></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/customize.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/customize.php 2015-03-10 21:19:14 UTC (rev 31704)
+++ trunk/src/wp-admin/customize.php 2015-03-10 22:38:30 UTC (rev 31705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -250,6 +250,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $settings['settings'][ $id ] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'value' => $setting->js_value(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'transport' => $setting->transport,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'dirty' => $setting->dirty,
</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">
</span></span></pre></div>
<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 2015-03-10 21:19:14 UTC (rev 31704)
+++ trunk/src/wp-admin/js/customize-controls.js 2015-03-10 22:38:30 UTC (rev 31705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -17,6 +17,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> this.id = id;
</span><span class="cx" style="display: block; padding: 0 10px"> this.transport = this.transport || 'refresh';
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ this._dirty = options.dirty || false;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> this.bind( this.preview );
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2516,7 +2517,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $.each( api.settings.settings, function( id, data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> api.create( id, id, data.value, {
</span><span class="cx" style="display: block; padding: 0 10px"> transport: data.transport,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- previewer: api.previewer
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ previewer: api.previewer,
+ dirty: !! data.dirty
</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">
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpcustomizesettingphp"></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-setting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-setting.php 2015-03-10 21:19:14 UTC (rev 31704)
+++ trunk/src/wp-includes/class-wp-customize-setting.php 2015-03-10 22:38:30 UTC (rev 31705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -60,6 +60,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public $sanitize_callback = '';
</span><span class="cx" style="display: block; padding: 0 10px"> public $sanitize_js_callback = '';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Whether or not the setting is initially dirty when created.
+ *
+ * This is used to ensure that a setting will be sent from the pane to the
+ * preview when loading the Customizer. Normally a setting only is synced to
+ * the preview if it has been changed. This allows the setting to be sent
+ * from the start.
+ *
+ * @since 4.2.0
+ * @access public
+ * @var bool
+ */
+ public $dirty = false;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> protected $id_data = array();
</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="trunksrcwpincludesclasswpcustomizewidgetsphp"></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-widgets.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-customize-widgets.php 2015-03-10 21:19:14 UTC (rev 31704)
+++ trunk/src/wp-includes/class-wp-customize-widgets.php 2015-03-10 22:38:30 UTC (rev 31705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -216,6 +216,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebars_widgets = $this->old_sidebars_widgets;
</span><span class="cx" style="display: block; padding: 0 10px"> $sidebars_widgets = retrieve_widgets( 'customize' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'option_sidebars_widgets', array( $this, 'filter_option_sidebars_widgets_for_theme_switch' ), 1 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $GLOBALS['_wp_sidebars_widgets'] ); // reset global cache var used by wp_get_sidebars_widgets()
</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"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -332,6 +333,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $setting_id = 'old_sidebars_widgets_data';
</span><span class="cx" style="display: block; padding: 0 10px"> $setting_args = $this->get_setting_args( $setting_id, array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'global_variable',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'dirty' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->manager->add_setting( $setting_id, $setting_args );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -356,6 +358,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $setting_id = sprintf( 'sidebars_widgets[%s]', $sidebar_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $setting_args = $this->get_setting_args( $setting_id );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $this->manager->get_setting( $setting_id ) ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $this->manager->is_theme_active() ) {
+ $setting_args['dirty'] = true;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->manager->add_setting( $setting_id, $setting_args );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $new_setting_ids[] = $setting_id;
</span></span></pre></div>
<a id="trunktestsphpunittestscustomizesettingphp"></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/customize/setting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/customize/setting.php 2015-03-10 21:19:14 UTC (rev 31704)
+++ trunk/tests/phpunit/tests/customize/setting.php 2015-03-10 22:38:30 UTC (rev 31705)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -44,6 +44,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( '', $setting->sanitize_js_callback );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( has_filter( "customize_sanitize_{$setting->id}" ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( has_filter( "customize_sanitize_js_{$setting->id}" ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( false, $setting->dirty );
</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"> function test_constructor_with_args() {
</span></span></pre>
</div>
</div>
</body>
</html>