<!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>[53327] trunk: Users: Validate `WP_User_Query`'s `fields` argument.</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/53327">53327</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/53327","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>peterwilsoncc</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-05-02 00:11:48 +0000 (Mon, 02 May 2022)</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'>Users: Validate `WP_User_Query`'s `fields` argument.
Improve validation of `WP_User_Query`'s `fields` argument when passed as an array to ensure it only accepts permitted values. This prevents the invalid values being included in the generated database query.
Expand unit tests to include passing invalid values as part of an array, the lower case value `id`. Correct earlier unit tests to limit database query to one result.
Follow up to <a href="https://core.trac.wordpress.org/changeset/53255">[53255]</a>.
Props felipeelia.
Fixes <a href="https://core.trac.wordpress.org/ticket/53177">#53177</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpuserqueryphp">trunk/src/wp-includes/class-wp-user-query.php</a></li>
<li><a href="#trunktestsphpunittestsuserqueryphp">trunk/tests/phpunit/tests/user/query.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpuserqueryphp"></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-user-query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-user-query.php 2022-05-02 00:11:35 UTC (rev 53326)
+++ trunk/src/wp-includes/class-wp-user-query.php 2022-05-02 00:11:48 UTC (rev 53327)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -285,8 +285,12 @@
</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"> if ( is_array( $qv['fields'] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $qv['fields'] = array_unique( $qv['fields'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $qv['fields'] = array_intersect( array_unique( $qv['fields'] ), $allowed_fields );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $qv['fields'] ) ) {
+ $qv['fields'] = array( 'ID' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->query_fields = array();
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $qv['fields'] as $field ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $field = 'ID' === $field ? 'ID' : sanitize_key( $field );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -293,8 +297,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->query_fields[] = "$wpdb->users.$field";
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $this->query_fields = implode( ',', $this->query_fields );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( 'all' === $qv['fields'] ) {
+ $this->query_fields = "$wpdb->users.*";
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( ! in_array( $qv['fields'], $allowed_fields, true ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->query_fields = "$wpdb->users.*";
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->query_fields = "$wpdb->users.ID";
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $field = 'ID' === $qv['fields'] ? 'ID' : sanitize_key( $qv['fields'] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->query_fields = "$wpdb->users.$field";
</span></span></pre></div>
<a id="trunktestsphpunittestsuserqueryphp"></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/user/query.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user/query.php 2022-05-02 00:11:35 UTC (rev 53326)
+++ trunk/tests/phpunit/tests/user/query.php 2022-05-02 00:11:48 UTC (rev 53327)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1982,8 +1982,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_returning_fields( $field, $expected_values ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $q = new WP_User_Query(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'fields' => $field,
- 'include ' => array( self::$admin_ids[0] ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'fields' => $field,
+ 'include' => array( '1' ),
</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"> $results = $q->get_results();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2007,68 +2007,94 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> public function data_returning_fields() {
</span><span class="cx" style="display: block; padding: 0 10px"> return array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'all' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'all' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'field' => 'all',
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'ID' => '1',
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_login' => 'admin',
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_nicename' => 'admin',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'user_email' => 'admin@example.org',
- 'user_url' => 'http://example.org',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user_email' => WP_TESTS_EMAIL,
+ 'user_url' => wp_guess_url(),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'user_activation_key' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_status' => '0',
</span><span class="cx" style="display: block; padding: 0 10px"> 'display_name' => 'admin',
</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">- 'all_with_meta' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'all_with_meta' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'field' => 'all_with_meta',
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'ID' => '1',
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_login' => 'admin',
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_nicename' => 'admin',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'user_email' => 'admin@example.org',
- 'user_url' => 'http://example.org',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user_email' => WP_TESTS_EMAIL,
+ 'user_url' => wp_guess_url(),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'user_activation_key' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_status' => '0',
</span><span class="cx" style="display: block; padding: 0 10px"> 'display_name' => 'admin',
</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">- 'ID' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'ID' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'field' => 'ID',
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'ID' => '1',
</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">- 'display_name' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'id' => array(
+ 'field' => 'id',
+ 'expected' => array(
+ 'ID' => '1',
+ ),
+ ),
+ 'display_name' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'field' => 'display_name',
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'display_name' => 'admin',
</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">- 'user_login' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user_login' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'field' => 'user_login',
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_login' => 'admin',
</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">- 'user_nicename' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user_nicename' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'field' => 'user_nicename',
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_nicename' => 'admin',
</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">- 'user_email' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user_email' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'field' => 'user_email',
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'user_email' => 'admin@example.org',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'user_email' => WP_TESTS_EMAIL,
</ins><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">- 'invalid_field' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'invalid_field' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'field' => 'invalid_field',
</span><span class="cx" style="display: block; padding: 0 10px"> 'expected' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> '0' => '1',
</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">+ 'valid_array' => array(
+ 'field' => array( 'ID', 'display_name' ),
+ 'expected' => array(
+ 'ID' => '1',
+ 'display_name' => 'admin',
+ ),
+ ),
+ 'semivalid_array' => array(
+ 'field' => array( 'ID', 'display_name', 'invalid_field' ),
+ 'expected' => array(
+ 'ID' => '1',
+ 'display_name' => 'admin',
+ ),
+ ),
+ 'invalid_array' => array(
+ 'field' => array( 'invalid_field' ),
+ 'expected' => array(
+ 'ID' => '1',
+ ),
+ ),
</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>