<!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>[52294] trunk: Options, Meta APIs: Improve error handling in `sanitize_option()`.</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 { white-space: pre-line; 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/52294">52294</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/52294","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-11-30 21:00:32 +0000 (Tue, 30 Nov 2021)</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'>Options, Meta APIs: Improve error handling in `sanitize_option()`.
To prevent potential false negatives, set `$error` to `null` initially, so we can better tell if it was ever changed during the sanitization and be able to better react if an empty string is added to it.
Additionally, and mainly for the sake of the Settings API at this point, add error messages to some `WP_Error` objects returned from `wpdb` methods that were previously causing the issues here.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/32791">[32791]</a>.
Props iCaleb, audrasjb, hellofromTonya, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/53986">#53986</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.php</a></li>
<li><a href="#trunksrcwpincludeswpdbphp">trunk/src/wp-includes/wp-db.php</a></li>
<li><a href="#trunktestsphpunittestsoptionsanitizeoptionphp">trunk/tests/phpunit/tests/option/sanitize-option.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesformattingphp"></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/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/formatting.php 2021-11-30 20:59:18 UTC (rev 52293)
+++ trunk/src/wp-includes/formatting.php 2021-11-30 21:00:32 UTC (rev 52294)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4711,7 +4711,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $original_value = $value;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $error = '';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $error = null;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( $option ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'admin_email':
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4919,7 +4919,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $value = str_replace( 'http://', '', $value );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( 'permalink_structure' === $option && '' !== $value && ! preg_match( '/%[^\/%]+%/', $value ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( 'permalink_structure' === $option && null === $error
+ && '' !== $value && ! preg_match( '/%[^\/%]+%/', $value )
+ ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $error = sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: Documentation URL. */
</span><span class="cx" style="display: block; padding: 0 10px"> __( 'A structure tag is required when using custom permalinks. <a href="%s">Learn more</a>' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4948,7 +4950,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! empty( $error ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( null !== $error ) {
+ if ( '' === $error && is_wp_error( $value ) ) {
+ /* translators: 1: Option name, 2: Error code. */
+ $error = sprintf( __( 'Could not sanitize the %1$s option. Error code: %2$s' ), $option, $value->get_error_code() );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $value = get_option( $option );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( function_exists( 'add_settings_error' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> add_settings_error( $option, "invalid_{$option}", $error );
</span></span></pre></div>
<a id="trunksrcwpincludeswpdbphp"></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/wp-db.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/wp-db.php 2021-11-30 20:59:18 UTC (rev 52293)
+++ trunk/src/wp-includes/wp-db.php 2021-11-30 21:00:32 UTC (rev 52294)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2885,7 +2885,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $table = '`' . implode( '`.`', $table_parts ) . '`';
</span><span class="cx" style="display: block; padding: 0 10px"> $results = $this->get_results( "SHOW FULL COLUMNS FROM $table" );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $results ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Error( 'wpdb_get_table_charset_failure' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return new WP_Error( 'wpdb_get_table_charset_failure', __( 'Could not retrieve table charset.' ) );
</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"> foreach ( $results as $column ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -3327,7 +3327,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->check_current_query = false;
</span><span class="cx" style="display: block; padding: 0 10px"> $row = $this->get_row( 'SELECT ' . implode( ', ', $sql ), ARRAY_A );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $row ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return new WP_Error( 'wpdb_strip_invalid_text_failure' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return new WP_Error( 'wpdb_strip_invalid_text_failure', __( 'Could not strip invalid text.' ) );
</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"> foreach ( array_keys( $data ) as $column ) {
</span></span></pre></div>
<a id="trunktestsphpunittestsoptionsanitizeoptionphp"></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/option/sanitize-option.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/option/sanitize-option.php 2021-11-30 20:59:18 UTC (rev 52293)
+++ trunk/tests/phpunit/tests/option/sanitize-option.php 2021-11-30 21:00:32 UTC (rev 52294)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -155,6 +155,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> array( '/%postname%/', '/%postname%/', true ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( '/%year%/%monthnum%/%day%/%postname%/', '/%year%/%monthnum%/%day%/%postname%/', true ),
</span><span class="cx" style="display: block; padding: 0 10px"> array( '/%year/%postname%/', '/%year/%postname%/', true ),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ array( new WP_Error( 'wpdb_get_table_charset_failure' ), false, false ), // ticket 53986
</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>
</div>
</body>
</html>