<!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>[38651] trunk: Allow 'role' parameters to be passed to `wp_dropdown_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/38651">38651</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/38651","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>2016-09-25 17:44:24 +0000 (Sun, 25 Sep 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'>Allow 'role' parameters to be passed to `wp_dropdown_users()`.
`wp_dropdown_users()` contains a whitelist of function params that are
passed through to `get_users()`. `role`, `role__in`, and `role__not_in`
have now been added to this whitelist.
Props sillybean.
Fixes <a href="https://core.trac.wordpress.org/ticket/38135">#38135</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
<li><a href="#trunktestsphpunittestsuserwpDropdownUsersphp">trunk/tests/phpunit/tests/user/wpDropdownUsers.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesuserphp"></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/user.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user.php 2016-09-25 17:32:37 UTC (rev 38650)
+++ trunk/src/wp-includes/user.php 2016-09-25 17:44:24 UTC (rev 38651)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -964,6 +964,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.3.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.5.0 Added the 'display_name_with_login' value for 'show'.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0 Added the `$role`, `$role__in`, and `$role__not_in` parameters.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array|string $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * Optional. Array or string of arguments to generate a drop-down of users.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1004,6 +1005,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @type int $blog_id ID of blog (Multisite only). Default is ID of the current blog.
</span><span class="cx" style="display: block; padding: 0 10px"> * @type string $who Which type of users to query. Accepts only an empty string or
</span><span class="cx" style="display: block; padding: 0 10px"> * 'authors'. Default empty.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string|array $role An array or a comma-separated list of role names that users must
+ * match to be included in results. Note that this is an inclusive
+ * list: users must match *each* role. Default empty.
+ * @type array $role__in An array of role names. Matched users must have at least one of
+ * these roles. Default empty array.
+ * @type array $role__not_in An array of role names to exclude. Users matching one or more of
+ * these roles will not be included in results. Default empty array.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string String of HTML content.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1015,14 +1023,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'show' => 'display_name', 'echo' => 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'selected' => 0, 'name' => 'user', 'class' => '', 'id' => '',
</span><span class="cx" style="display: block; padding: 0 10px"> 'blog_id' => get_current_blog_id(), 'who' => '', 'include_selected' => false,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'option_none_value' => -1
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'option_none_value' => -1,
+ 'role' => '',
+ 'role__in' => array(),
+ 'role__not_in' => array(),
</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"> $defaults['selected'] = is_author() ? get_query_var( 'author' ) : 0;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $r = wp_parse_args( $args, $defaults );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $query_args = wp_array_slice_assoc( $r, array( 'blog_id', 'include', 'exclude', 'orderby', 'order', 'who', 'role', 'role__in', 'role__not_in' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $fields = array( 'ID', 'user_login' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunittestsuserwpDropdownUsersphp"></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/wpDropdownUsers.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user/wpDropdownUsers.php 2016-09-25 17:32:37 UTC (rev 38650)
+++ trunk/tests/phpunit/tests/user/wpDropdownUsers.php 2016-09-25 17:44:24 UTC (rev 38651)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -110,4 +110,55 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $user1 = get_userdata( $users[1] );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertContains( $user1->user_login, $found );
</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 38135
+ */
+ public function test_role() {
+ $u1 = self::factory()->user->create_and_get( array( 'role' => 'subscriber' ) );
+ $u2 = self::factory()->user->create_and_get( array( 'role' => 'author' ) );
+
+ $found = wp_dropdown_users( array(
+ 'echo' => false,
+ 'role' => 'author',
+ 'show' => 'user_login',
+ ) );
+
+ $this->assertNotContains( $u1->user_login, $found );
+ $this->assertContains( $u2->user_login, $found );
+ }
+
+ /**
+ * @ticket 38135
+ */
+ public function test_role__in() {
+ $u1 = self::factory()->user->create_and_get( array( 'role' => 'subscriber' ) );
+ $u2 = self::factory()->user->create_and_get( array( 'role' => 'author' ) );
+
+ $found = wp_dropdown_users( array(
+ 'echo' => false,
+ 'role__in' => array( 'author', 'editor' ),
+ 'show' => 'user_login',
+ ) );
+
+ $this->assertNotContains( $u1->user_login, $found );
+ $this->assertContains( $u2->user_login, $found );
+ }
+
+ /**
+ * @ticket 38135
+ */
+ public function test_role__not_in() {
+ $u1 = self::factory()->user->create_and_get( array( 'role' => 'subscriber' ) );
+ $u2 = self::factory()->user->create_and_get( array( 'role' => 'author' ) );
+
+ $found = wp_dropdown_users( array(
+ 'echo' => false,
+ 'role__not_in' => array( 'subscriber', 'editor' ),
+ 'show' => 'user_login',
+ ) );
+
+ $this->assertNotContains( $u1->user_login, $found );
+ $this->assertContains( $u2->user_login, $found );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>