<!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>[33771] trunk: Improve the efficiency of `is_user_member_of_blog()` by removing its use of `get_blogs_of_user()`.</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/33771">33771</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/33771","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>2015-08-27 20:01:37 +0000 (Thu, 27 Aug 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'>Improve the efficiency of `is_user_member_of_blog()` by removing its use of `get_blogs_of_user()`. Adds additional tests.
Fixes <a href="https://core.trac.wordpress.org/ticket/32472">#32472</a>
Props BinaryKitten, sammybeats, johnbillion</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesuserfunctionsphp">trunk/src/wp-includes/user-functions.php</a></li>
<li><a href="#trunktestsphpunittestsusermultisitephp">trunk/tests/phpunit/tests/user/multisite.php</a></li>
<li><a href="#trunktestsphpunittestsuserphp">trunk/tests/phpunit/tests/user.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesuserfunctionsphp"></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-functions.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/user-functions.php 2015-08-27 17:25:15 UTC (rev 33770)
+++ trunk/src/wp-includes/user-functions.php 2015-08-27 20:01:37 UTC (rev 33771)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -583,17 +583,58 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function is_user_member_of_blog( $user_id = 0, $blog_id = 0 ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $wpdb;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $user_id = (int) $user_id;
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_id = (int) $blog_id;
</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( $user_id ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $user_id ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $user_id = get_current_user_id();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><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( $blog_id ) )
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Technically not needed, but does save calls to get_blog_details and get_user_meta
+ // in the event that the function is called when a user isn't logged in
+ if ( empty( $user_id ) ) {
+ return false;
+ } else {
+ $user = get_userdata( $user_id );
+ if ( ! $user instanceof WP_User ) {
+ return false;
+ }
+ }
+
+ if ( ! is_multisite() ) {
+ return true;
+ }
+
+ if ( empty( $blog_id ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $blog_id = get_current_blog_id();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $blogs = get_blogs_of_user( $user_id );
- return array_key_exists( $blog_id, $blogs );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $blog = get_blog_details( $blog_id );
+
+ if ( ! $blog || ! isset( $blog->domain ) || $blog->archived || $blog->spam || $blog->deleted ) {
+ return false;
+ }
+
+ $keys = get_user_meta( $user_id );
+ if ( empty( $keys ) ) {
+ return false;
+ }
+
+ // no underscore before capabilities in $base_capabilities_key
+ $base_capabilities_key = $wpdb->base_prefix . 'capabilities';
+ $site_capabilities_key = $wpdb->base_prefix . $blog_id . '_capabilities';
+
+ if ( isset( $keys[ $base_capabilities_key ] ) && $blog_id == 1 ) {
+ return true;
+ }
+
+ if ( isset( $keys[ $site_capabilities_key ] ) ) {
+ return true;
+ }
+
+ return false;
</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>
<a id="trunktestsphpunittestsusermultisitephp"></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/multisite.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user/multisite.php 2015-08-27 17:25:15 UTC (rev 33770)
+++ trunk/tests/phpunit/tests/user/multisite.php 2015-08-27 20:01:37 UTC (rev 33771)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,8 +141,15 @@
</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"> $user1_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user2_id = $this->factory->user->create( array( 'role' => 'administrator' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $old_current = get_current_user_id();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $this->assertSame( 0, $old_current );
+
+ // test for "get current user" when not logged in
+ $this->assertFalse( is_user_member_of_blog() );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( $user1_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( is_user_member_of_blog() );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -154,15 +161,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $blog_ids = $this->factory->blog->create_many( 5 );
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $blog_ids as $blog_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertInternalType( 'int', $blog_id );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Current user gets added to new blogs
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( is_user_member_of_blog( $user1_id, $blog_id ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Other users should not
+ $this->assertFalse( is_user_member_of_blog( $user2_id, $blog_id ) );
+
+ switch_to_blog( $blog_id );
+
+ $this->assertTrue( is_user_member_of_blog( $user1_id ) );
+ $this->assertFalse( is_user_member_of_blog( $user2_id ) );
+
+ // Remove user 1 from blog
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( remove_user_from_blog( $user1_id, $blog_id ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Add user 2 to blog
+ $this->assertTrue( add_user_to_blog( $blog_id, $user2_id, 'subscriber' ) );
+
+ $this->assertFalse( is_user_member_of_blog( $user1_id ) );
+ $this->assertTrue( is_user_member_of_blog( $user2_id ) );
+
+ restore_current_blog();
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertFalse( is_user_member_of_blog( $user1_id, $blog_id ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertTrue( is_user_member_of_blog( $user2_id, $blog_id ) );
</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"> wpmu_delete_user( $user1_id );
</span><span class="cx" style="display: block; padding: 0 10px"> $user = new WP_User( $user1_id );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertFalse( $user->exists(), 'WP_User->exists' );
- $this->assertFalse( is_user_member_of_blog( $user1_id ), 'is_user_member_of_blog' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertFalse( $user->exists() );
+ $this->assertFalse( is_user_member_of_blog( $user1_id ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( $old_current );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsuserphp"></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.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/user.php 2015-08-27 17:25:15 UTC (rev 33770)
+++ trunk/tests/phpunit/tests/user.php 2015-08-27 20:01:37 UTC (rev 33771)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -366,6 +366,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function test_is_user_member_of_blog() {
</span><span class="cx" style="display: block; padding: 0 10px"> $old_current = get_current_user_id();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertSame( 0, $old_current );
+
+ // test for "get current user" when not logged in
+ $this->assertFalse( is_user_member_of_blog() );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $user_id = $this->factory->user->create( array( 'role' => 'subscriber' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_set_current_user( $user_id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre>
</div>
</div>
</body>
</html>