<!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>[34838] trunk: Customizer: Ensure `WP_Customize_Setting::update()` returns boolean value.</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/34838">34838</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/34838","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>2015-10-05 21:57:32 +0000 (Mon, 05 Oct 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: Ensure `WP_Customize_Setting::update()` returns boolean value.
Adds unit tests for `WP_Customize_Setting::save()` (and `WP_Customize_Setting::update()`), along with the actions `customize_update_{$type}`, and `customize_save_{$id_base}` which they trigger.
Fixes <a href="https://core.trac.wordpress.org/ticket/34140">#34140</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-10-05 21:35:18 UTC (rev 34837)
+++ trunk/src/wp-includes/class-wp-customize-setting.php 2015-10-05 21:57:32 UTC (rev 34838)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -304,12 +304,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value The value to update.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return mixed The result of saving the value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool The result of saving the value.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function update( $value ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- switch( $this->type ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ switch ( $this->type ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> case 'theme_mod' :
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return $this->_update_theme_mod( $value );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->_update_theme_mod( $value );
+ return true;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> case 'option' :
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->_update_option( $value );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -327,7 +328,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Value of the setting.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Customize_Setting $this WP_Customize_Setting instance.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return do_action( 'customize_update_' . $this->type, $value, $this );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ do_action( "customize_update_{$this->type}", $value, $this );
+
+ return has_action( "customize_update_{$this->type}" );
</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="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-10-05 21:35:18 UTC (rev 34837)
+++ trunk/tests/phpunit/tests/customize/setting.php 2015-10-05 21:57:32 UTC (rev 34838)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -367,6 +367,64 @@
</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"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Test setting save method for custom type.
+ *
+ * @see WP_Customize_Setting::save()
+ * @see WP_Customize_Setting::update()
+ */
+ function test_update_custom_type() {
+ $type = 'custom';
+ $name = 'foo';
+ $setting = new WP_Customize_Setting( $this->manager, $name, compact( 'type' ) );
+ $this->manager->add_setting( $setting );
+ add_action( 'customize_update_custom', array( $this, 'handle_customize_update_custom_foo_action' ), 10, 2 );
+ add_action( 'customize_save_foo', array( $this, 'handle_customize_save_custom_foo_action' ), 10, 2 );
+
+ // Try saving before value set.
+ $this->assertTrue( 0 === did_action( 'customize_update_custom' ) );
+ $this->assertTrue( 0 === did_action( 'customize_save_foo' ) );
+ $this->assertFalse( $setting->save() );
+ $this->assertTrue( 0 === did_action( 'customize_update_custom' ) );
+ $this->assertTrue( 0 === did_action( 'customize_save_foo' ) );
+
+ // Try setting post value without user as admin.
+ $this->manager->set_post_value( $setting->id, 'hello world' );
+ $this->assertFalse( $setting->save() );
+ $this->assertTrue( 0 === did_action( 'customize_update_custom' ) );
+ $this->assertTrue( 0 === did_action( 'customize_save_foo' ) );
+
+ // Satisfy all requirements for save to happen.
+ wp_set_current_user( $this->factory->user->create( array( 'role' => 'administrator' ) ) );
+ $this->assertTrue( false !== $setting->save() );
+ $this->assertTrue( 1 === did_action( 'customize_update_custom' ) );
+ $this->assertTrue( 1 === did_action( 'customize_save_foo' ) );
+ }
+
+ /**
+ * Check customize_update_custom action.
+ *
+ * @see Tests_WP_Customize_Setting::test_update_custom_type()
+ * @param mixed $value
+ * @param WP_Customize_Setting $setting
+ */
+ function handle_customize_update_custom_foo_action( $value, $setting = null ) {
+ $this->assertEquals( 'hello world', $value );
+ $this->assertInstanceOf( 'WP_Customize_Setting', $setting );
+ }
+
+ /**
+ * Check customize_save_foo action.
+ *
+ * @see Tests_WP_Customize_Setting::test_update_custom_type()
+ * @param WP_Customize_Setting $setting
+ */
+ function handle_customize_save_custom_foo_action( $setting ) {
+ $this->assertInstanceOf( 'WP_Customize_Setting', $setting );
+ $this->assertEquals( 'custom', $setting->type );
+ $this->assertEquals( 'foo', $setting->id );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Ensure that is_current_blog_previewed returns the expected values.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This is applicable to both single and multisite. This doesn't do switch_to_blog()
</span></span></pre>
</div>
</div>
</body>
</html>