<!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>[41138] trunk: Users: Ensure that users with no role on a site are taken into consideration when listing users on Multisite.</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/41138">41138</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/41138","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-07-25 00:23:44 +0000 (Tue, 25 Jul 2017)</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: Ensure that users with no role on a site are taken into consideration when listing users on Multisite.
This ensures that users who are a member of a site but have no role are correctly listed on the Users screen and can be filtered from the 'None' role filter.
Props tobi823, flixos90, scottlee
Fixes <a href="https://core.trac.wordpress.org/ticket/36196">#36196</a></pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpuserslisttablephp">trunk/src/wp-admin/includes/class-wp-users-list-table.php</a></li>
<li><a href="#trunksrcwpincludesuserphp">trunk/src/wp-includes/user.php</a></li>
<li><a href="#trunktestsphpunittestsusercountUsersphp">trunk/tests/phpunit/tests/user/countUsers.php</a></li>
<li><a href="#trunktestsphpunittestsuserwpGetUsersWithNoRolephp">trunk/tests/phpunit/tests/user/wpGetUsersWithNoRole.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpuserslisttablephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-users-list-table.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-users-list-table.php 2017-07-24 23:26:36 UTC (rev 41137)
+++ trunk/src/wp-admin/includes/class-wp-users-list-table.php 2017-07-25 00:23:44 UTC (rev 41138)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -98,7 +98,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $args = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'number' => $users_per_page,
</span><span class="cx" style="display: block; padding: 0 10px"> 'offset' => ( $paged-1 ) * $users_per_page,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'include' => wp_get_users_with_no_role(),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'include' => wp_get_users_with_no_role( $this->site_id ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'search' => $usersearch,
</span><span class="cx" style="display: block; padding: 0 10px"> 'fields' => 'all_with_meta'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -177,7 +177,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $this->is_site_users ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $url = 'site-users.php?id=' . $this->site_id;
</span><span class="cx" style="display: block; padding: 0 10px"> switch_to_blog( $this->site_id );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $users_of_blog = count_users();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $users_of_blog = count_users( 'time', $this->site_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> restore_current_blog();
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $url = 'users.php';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -369,9 +369,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $post_counts = count_many_users_posts( array_keys( $this->items ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $this->items as $userid => $user_object ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( is_multisite() && empty( $user_object->allcaps ) )
- continue;
-
</del><span class="cx" style="display: block; padding: 0 10px"> echo "\n\t" . $this->single_row( $user_object, '', '', isset( $post_counts ) ? $post_counts[ $userid ] : 0 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<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 2017-07-24 23:26:36 UTC (rev 41137)
+++ trunk/src/wp-includes/user.php 2017-07-25 00:23:44 UTC (rev 41138)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -838,18 +838,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 3.0.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0 The number of users with no role is now included in the `none` element.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.9.0 The `$site_id` parameter was added to support multisite.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @global wpdb $wpdb WordPress database abstraction object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $strategy 'time' or 'memory'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $strategy Optional. The computational strategy to use when counting the users.
+ * Accepts either 'time' or 'memory'. Default 'time'.
+ * @param int|null $site_id Optional. The site ID to count users for. Defaults to the current site.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Includes a grand total and an array of counts indexed by role strings.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function count_users($strategy = 'time') {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function count_users( $strategy = 'time', $site_id = null ) {
</ins><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"> // Initialize
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $id = get_current_blog_id();
- $blog_prefix = $wpdb->get_blog_prefix($id);
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $site_id ) {
+ $site_id = get_current_blog_id();
+ }
+ $blog_prefix = $wpdb->get_blog_prefix( $site_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> $result = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'time' == $strategy ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -920,10 +925,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $result['avail_roles'] =& $avail_roles;
</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 ( is_multisite() ) {
- $result['avail_roles']['none'] = 0;
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> return $result;
</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">@@ -2483,20 +2484,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Get the user IDs of all users with no role on this site.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This function returns an empty array when used on Multisite.
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.9.0 The `$site_id` parameter was added to support multisite.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param int|null $site_id Optional. The site ID to get users with no role for. Defaults to the current site.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return array Array of user IDs.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-function wp_get_users_with_no_role() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+function wp_get_users_with_no_role( $site_id = null ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> global $wpdb;
</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 ( is_multisite() ) {
- return array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! $site_id ) {
+ $site_id = get_current_blog_id();
</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">- $prefix = $wpdb->get_blog_prefix();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $prefix = $wpdb->get_blog_prefix( $site_id );
</ins><span class="cx" style="display: block; padding: 0 10px"> $regex = implode( '|', array_keys( wp_roles()->get_names() ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $regex = preg_replace( '/[^a-zA-Z_\|-]/', '', $regex );
</span><span class="cx" style="display: block; padding: 0 10px"> $users = $wpdb->get_col( $wpdb->prepare( "
</span></span></pre></div>
<a id="trunktestsphpunittestsusercountUsersphp"></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/countUsers.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user/countUsers.php 2017-07-24 23:26:36 UTC (rev 41137)
+++ trunk/tests/phpunit/tests/user/countUsers.php 2017-07-25 00:23:44 UTC (rev 41138)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -52,6 +52,7 @@
</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"> * @ticket 22993
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 36196
</ins><span class="cx" style="display: block; padding: 0 10px"> * @group multisite
</span><span class="cx" style="display: block; padding: 0 10px"> * @group ms-required
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -103,7 +104,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'author' => 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'contributor' => 1,
</span><span class="cx" style="display: block; padding: 0 10px"> 'subscriber' => 1,
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'none' => 0,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'none' => 2,
</ins><span class="cx" style="display: block; padding: 0 10px"> ), $count['avail_roles'] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Test users counts on blog 1
</span></span></pre></div>
<a id="trunktestsphpunittestsuserwpGetUsersWithNoRolephp"></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/wpGetUsersWithNoRole.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user/wpGetUsersWithNoRole.php 2017-07-24 23:26:36 UTC (rev 41137)
+++ trunk/tests/phpunit/tests/user/wpGetUsersWithNoRole.php 2017-07-25 00:23:44 UTC (rev 41138)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -36,6 +36,7 @@
</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"> * @ticket 22993
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 36196
</ins><span class="cx" style="display: block; padding: 0 10px"> * @group multisite
</span><span class="cx" style="display: block; padding: 0 10px"> * @group ms-required
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,21 +57,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'user_id' => $editor,
</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">- // Add users to blogs
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Add editor to blog 1
</ins><span class="cx" style="display: block; padding: 0 10px"> add_user_to_blog( $blog_1, $editor, 'editor' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Test users on root site
</span><span class="cx" style="display: block; padding: 0 10px"> $users = wp_get_users_with_no_role();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertSame( array(), $users );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( array(
+ "{$nobody}",
+ ), $users );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Test users counts on blog 1
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- switch_to_blog( $blog_1 );
- $users = wp_get_users_with_no_role();
- restore_current_blog();
-
- // Test users on root site
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $users = wp_get_users_with_no_role( $blog_1 );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( array(), $users );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Add admin to blog 1 with no role
+ add_user_to_blog( $blog_1, $admin, '' );
+
+ // Re-test users counts on blog 1
+ $users = wp_get_users_with_no_role( $blog_1 );
+ $this->assertSame( array(
+ "{$admin}",
+ ), $users );
</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>