<!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>[31707] trunk: Customizer: Return the original value when filtering theme mods/options and the current blog has changed.</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/31707">31707</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/31707","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 23:04:12 +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: Return the original value when filtering theme mods/options and the current blog has changed.
props westonruter.
fixes <a href="https://core.trac.wordpress.org/ticket/31428">#31428</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpcustomizesettingphp">trunk/src/wp-includes/class-wp-customize-setting.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="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 22:44:25 UTC (rev 31706)
+++ trunk/src/wp-includes/class-wp-customize-setting.php 2015-03-10 23:04:12 UTC (rev 31707)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -114,6 +114,34 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( "customize_sanitize_js_{$this->id}", $this->sanitize_js_callback, 10, 2 );
</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">+ /**
+ * The ID for the current blog when the preview() method was called.
+ *
+ * @since 4.2.0
+ * @var int
+ */
+ protected $_previewed_blog_id;
+
+ /**
+ * Return true if the current blog is not the same as the previewed blog.
+ *
+ * @since 4.2.0
+ * @return bool|null Returns null if preview() has not been called yet.
+ */
+ public function is_current_blog_previewed() {
+ if ( ! isset( $this->_previewed_blog_id ) ) {
+ return null;
+ }
+ return ( get_current_blog_id() === $this->_previewed_blog_id );
+ }
+
+ /**
+ * Original non-previewed value stored by the preview method.
+ *
+ * @see WP_Customize_Setting::preview()
+ * @since 4.1.1
+ * @var mixed
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> protected $_original_value;
</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">@@ -125,6 +153,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $this->_original_value ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->_original_value = $this->value();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! isset( $this->_previewed_blog_id ) ) {
+ $this->_previewed_blog_id = get_current_blog_id();
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> switch( $this->type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'theme_mod' :
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -169,6 +200,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Callback function to filter the theme mods and options.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If switch_to_blog() was called after the preview() method, and the current
+ * blog is now not the same blog, then this method does a no-op and returns
+ * the original value.
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @uses WP_Customize_Setting::multidimensional_replace()
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -176,6 +211,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return mixed New or old value.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function _preview_filter( $original ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $this->is_current_blog_previewed() ) {
+ return $original;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $undefined = new stdClass(); // symbol hack
</span><span class="cx" style="display: block; padding: 0 10px"> $post_value = $this->post_value( $undefined );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $undefined === $post_value ) {
</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 22:44:25 UTC (rev 31706)
+++ trunk/tests/phpunit/tests/customize/setting.php 2015-03-10 23:04:12 UTC (rev 31707)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -365,5 +365,54 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $default, get_option( $name, $this->undefined ), sprintf( 'Expected get_option(%s) to return setting default: %s.', $name, $default ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( $default, $setting->value() );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Ensure that is_current_blog_previewed returns the expected values.
+ *
+ * This is applicable to both single and multisite. This doesn't do switch_to_blog()
+ *
+ * @ticket 31428
+ */
+ function test_is_current_blog_previewed() {
+ $type = 'option';
+ $name = 'blogname';
+ $post_value = rand_str();
+ $this->manager->set_post_value( $name, $post_value );
+ $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type' ) );
+ $this->assertNull( $setting->is_current_blog_previewed() );
+ $setting->preview();
+ $this->assertTrue( $setting->is_current_blog_previewed() );
+
+ $this->assertEquals( $post_value, $setting->value() );
+ $this->assertEquals( $post_value, get_option( $name ) );
+ }
+
+ /**
+ * Ensure that previewing a setting is disabled when the current blog is switched.
+ *
+ * @ticket 31428
+ * @group multisite
+ */
+ function test_previewing_with_switch_to_blog() {
+ if ( ! is_multisite() ) {
+ $this->markTestSkipped( 'Cannot test WP_Customize_Setting::is_current_blog_previewed() with switch_to_blog() if not on multisite.' );
+ }
+
+ $type = 'option';
+ $name = 'blogdescription';
+ $post_value = rand_str();
+ $this->manager->set_post_value( $name, $post_value );
+ $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type' ) );
+ $this->assertNull( $setting->is_current_blog_previewed() );
+ $setting->preview();
+ $this->assertTrue( $setting->is_current_blog_previewed() );
+
+ $blog_id = $this->factory->blog->create();
+ switch_to_blog( $blog_id );
+ $this->assertFalse( $setting->is_current_blog_previewed() );
+ $this->assertNotEquals( $post_value, $setting->value() );
+ $this->assertNotEquals( $post_value, get_option( $name ) );
+ restore_current_blog();
+ }
</ins><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>