<!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>[37942] trunk: Customize: Reverse order of setting sanitization/validation, validating prior to sanitizing.</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/37942">37942</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/37942","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-07-02 18:38:07 +0000 (Sat, 02 Jul 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'>Customize: Reverse order of setting sanitization/validation, validating prior to sanitizing.
Reverses order where sanitization was being applied before validation originally in accordance with REST API logic.
Props westonruter, schlessera.
See <a href="https://core.trac.wordpress.org/ticket/34893">#34893</a>.
See <a href="https://core.trac.wordpress.org/ticket/37192">#37192</a>.
Fixes <a href="https://core.trac.wordpress.org/ticket/37247">#37247</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpcustomizemanagerphp">trunk/src/wp-includes/class-wp-customize-manager.php</a></li>
<li><a href="#trunktestsphpunittestscustomizemanagerphp">trunk/tests/phpunit/tests/customize/manager.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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-07-01 15:06:54 UTC (rev 37941)
+++ trunk/src/wp-includes/class-wp-customize-manager.php 2016-07-02 18:38:07 UTC (rev 37942)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -670,14 +670,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! array_key_exists( $setting->id, $post_values ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $default;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $value = $setting->sanitize( $post_values[ $setting->id ] );
- if ( is_null( $value ) || is_wp_error( $value ) ) {
- return $default;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $value = $post_values[ $setting->id ];
</ins><span class="cx" style="display: block; padding: 0 10px"> $valid = $setting->validate( $value );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $valid ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $default;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $value = $setting->sanitize( $value );
+ if ( is_null( $value ) || is_wp_error( $value ) ) {
+ return $default;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> return $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">@@ -1007,8 +1008,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $setting || is_null( $unsanitized_value ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $validity = $setting->validate( $setting->sanitize( $unsanitized_value ) );
- if ( false === $validity || null === $validity ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $validity = $setting->validate( $unsanitized_value );
+ if ( ! is_wp_error( $validity ) ) {
+ $value = $setting->sanitize( $unsanitized_value );
+ if ( is_null( $value ) ) {
+ $validity = false;
+ } elseif ( is_wp_error( $value ) ) {
+ $validity = $value;
+ }
+ }
+ if ( false === $validity ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $validity = new WP_Error( 'invalid_value', __( 'Invalid value.' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $validities[ $setting_id ] = $validity;
</span></span></pre></div>
<a id="trunktestsphpunittestscustomizemanagerphp"></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/manager.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/customize/manager.php 2016-07-01 15:06:54 UTC (rev 37941)
+++ trunk/tests/phpunit/tests/customize/manager.php 2016-07-02 18:38:07 UTC (rev 37942)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -191,6 +191,50 @@
</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 the WP_Customize_Manager::post_value() method to make sure that the validation and sanitization are done in the right order.
+ *
+ * @ticket 37247
+ */
+ function test_post_value_validation_sanitization_order() {
+ $default_value = '0';
+ $setting = $this->manager->add_setting( 'numeric', array(
+ 'validate_callback' => array( $this, 'filter_customize_validate_numeric' ),
+ 'sanitize_callback' => array( $this, 'filter_customize_sanitize_numeric' ),
+ ) );
+ $this->assertEquals( $default_value, $this->manager->post_value( $setting, $default_value ) );
+ $this->assertEquals( $default_value, $setting->post_value( $default_value ) );
+
+ $post_value = '42';
+ $this->manager->set_post_value( 'numeric', $post_value );
+ $this->assertEquals( $post_value, $this->manager->post_value( $setting, $default_value ) );
+ $this->assertEquals( $post_value, $setting->post_value( $default_value ) );
+ }
+
+ /**
+ * Filter customize_validate callback for a numeric value.
+ *
+ * @param mixed $value Value.
+ * @return string|WP_Error
+ */
+ function filter_customize_sanitize_numeric( $value ) {
+ return absint( $value );
+ }
+
+ /**
+ * Filter customize_validate callback for a numeric value.
+ *
+ * @param WP_Error $validity Validity.
+ * @param mixed $value Value.
+ * @return WP_Error
+ */
+ function filter_customize_validate_numeric( $validity, $value ) {
+ if ( ! is_string( $value ) || ! is_numeric( $value ) ) {
+ $validity->add( 'invalid_value_in_validate', __( 'Invalid value.' ), array( 'source' => 'filter_customize_validate_numeric' ) );
+ }
+ return $validity;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test WP_Customize_Manager::validate_setting_values().
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Customize_Manager::validate_setting_values()
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -235,6 +279,23 @@
</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 the WP_Customize_Manager::validate_setting_values() method to make sure that the validation and sanitization are done in the right order.
+ *
+ * @ticket 37247
+ */
+ function test_validate_setting_values_validation_sanitization_order() {
+ $setting = $this->manager->add_setting( 'numeric', array(
+ 'validate_callback' => array( $this, 'filter_customize_validate_numeric' ),
+ 'sanitize_callback' => array( $this, 'filter_customize_sanitize_numeric' ),
+ ) );
+ $post_value = '42';
+ $this->manager->set_post_value( 'numeric', $post_value );
+ $validities = $this->manager->validate_setting_values( $this->manager->unsanitized_post_values() );
+ $this->assertCount( 1, $validities );
+ $this->assertEquals( array( 'numeric' => true ), $validities );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Test WP_Customize_Manager::prepare_setting_validity_for_js().
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @see WP_Customize_Manager::prepare_setting_validity_for_js()
</span></span></pre>
</div>
</div>
</body>
</html>