<!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>[34804] trunk: Ensure that `WP_User_Query` vars are filled after 'pre_get_users'.</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/34804">34804</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/34804","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>boonebgorges</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-10-03 18:44:40 +0000 (Sat, 03 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'>Ensure that `WP_User_Query` vars are filled after 'pre_get_users'.
This prevents notices from being thrown when a 'pre_get_users' callback
removes required values from the list of `query_vars`.
For backward compatibility with previous uses of 'pre_get_users', default
values are parsed both before and after the action is fired.
Fixes <a href="https://core.trac.wordpress.org/ticket/33449">#33449</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 2015-10-03 18:35:58 UTC (rev 34803)
+++ trunk/src/wp-includes/class-wp-user-query.php 2015-10-03 18:44:40 UTC (rev 34804)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -76,6 +76,40 @@
</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">+ * Fills in missing query variables with default values.
+ *
+ * @since 4.4.0
+ * @access public
+ *
+ * @param array $args Query vars, as passed to `WP_User_Query`.
+ * @return array Complete query variables with undefined ones filled in with defaults.
+ */
+ public static function fill_query_vars( $args ) {
+ $defaults = array(
+ 'blog_id' => $GLOBALS['blog_id'],
+ 'role' => '',
+ 'meta_key' => '',
+ 'meta_value' => '',
+ 'meta_compare' => '',
+ 'include' => array(),
+ 'exclude' => array(),
+ 'search' => '',
+ 'search_columns' => array(),
+ 'orderby' => 'login',
+ 'order' => 'ASC',
+ 'offset' => '',
+ 'number' => '',
+ 'paged' => 1,
+ 'count_total' => true,
+ 'fields' => 'all',
+ 'who' => '',
+ 'has_published_posts' => null,
+ );
+
+ return wp_parse_args( $args, $defaults );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Prepare the query variables.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.1.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -146,26 +180,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $this->query_vars ) || ! empty( $query ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->query_limit = null;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->query_vars = wp_parse_args( $query, array(
- 'blog_id' => $GLOBALS['blog_id'],
- 'role' => '',
- 'meta_key' => '',
- 'meta_value' => '',
- 'meta_compare' => '',
- 'include' => array(),
- 'exclude' => array(),
- 'search' => '',
- 'search_columns' => array(),
- 'orderby' => 'login',
- 'order' => 'ASC',
- 'offset' => '',
- 'number' => '',
- 'paged' => 1,
- 'count_total' => true,
- 'fields' => 'all',
- 'who' => '',
- 'has_published_posts' => null,
- ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->query_vars = $this->fill_query_vars( $query );
</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 class="lines" style="display: block; padding: 0 10px; color: #888">@@ -181,7 +196,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'pre_get_users', $this );
</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 query vars are filled after 'pre_get_users'.
</ins><span class="cx" style="display: block; padding: 0 10px"> $qv =& $this->query_vars;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $qv = $this->fill_query_vars( $qv );
</ins><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><span class="cx" style="display: block; padding: 0 10px"> $qv['fields'] = array_unique( $qv['fields'] );
</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 2015-10-03 18:35:58 UTC (rev 34803)
+++ trunk/tests/phpunit/tests/user/query.php 2015-10-03 18:44:40 UTC (rev 34804)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -874,4 +874,26 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertEquals( array( $users[2], $users[1] ), $q->results );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * @ticket 33449
+ */
+ public function test_query_vars_should_be_filled_in_after_pre_get_users() {
+ $query_vars = array( 'blog_id', 'role', 'meta_key', 'meta_value', 'meta_compare', 'include', 'exclude', 'search', 'search_columns', 'orderby', 'order', 'offset', 'number', 'paged', 'count_total', 'fields', 'who', 'has_published_posts' );
+
+ add_action( 'pre_get_users', array( $this, 'filter_pre_get_users_args' ) );
+ $q = new WP_User_Query( array_fill_keys( $query_vars, '1' ) );
+ remove_action( 'pre_get_users', array( $this, 'filter_pre_get_users_args' ) );
+
+ foreach ( $query_vars as $query_var ) {
+ $this->assertTrue( array_key_exists( $query_var, $q->query_vars ), "$query_var does not exist." );
+ }
+
+ }
+
+ public function filter_pre_get_users_args( $q ) {
+ foreach ( $q->query_vars as $k => $v ) {
+ unset( $q->query_vars[ $k ] );
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>