<!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>[BuddyPress][8532] trunk: Use `get_user_by()` for `bp_core_get_userid_from_nicename()` and `bp_core_get_userid()`</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">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/8532">8532</a></dd>
<dt>Author</dt> <dd>r-a-y</dd>
<dt>Date</dt> <dd>2014-06-15 20:07:22 +0000 (Sun, 15 Jun 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Use `get_user_by()` for `bp_core_get_userid_from_nicename()` and `bp_core_get_userid()`
Previously, these functions used direct DB queries to grab the user ID when
a `user_nicename` or `user_login` was passed.
This commit switches these direct DB queries to use `get_user_by()`, which
caches the query when a persistent object cache is enabled.
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/5696">#5696</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpmembersbpmembersfunctionsphp">trunk/src/bp-members/bp-members-functions.php</a></li>
<li><a href="#trunktestsphpunittestcasesmembersfunctionsphp">trunk/tests/phpunit/testcases/members/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpmembersbpmembersfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/src/bp-members/bp-members-functions.php (8531 => 8532)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/src/bp-members/bp-members-functions.php 2014-06-15 20:00:53 UTC (rev 8531)
+++ trunk/src/bp-members/bp-members-functions.php 2014-06-15 20:07:22 UTC (rev 8532)
</span><span class="lines">@@ -195,37 +195,39 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Return the user_id for a user based on their user_login.
</del><ins>+ * Return the user ID based on a user's user_login.
</ins><span class="cx"> *
</span><del>- * @todo Refactor to check relevant WP caches, or to use get_user_by()
</del><ins>+ * @since BuddyPress (1.0.0)
</ins><span class="cx"> *
</span><del>- * @param string $username Username to check.
- * @return int|bool The ID of the matched user, or false.
</del><ins>+ * @param string $username user_login to check.
+ * @return int|null The ID of the matched user on success, null on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_get_userid( $username ) {
</span><del>- global $wpdb;
-
- if ( empty( $username ) )
</del><ins>+ if ( empty( $username ) ) {
</ins><span class="cx"> return false;
</span><ins>+ }
</ins><span class="cx">
</span><del>- return apply_filters( 'bp_core_get_userid', $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM {$wpdb->users} WHERE user_login = %s", $username ) ), $username );
</del><ins>+ $user = get_user_by( 'login', $username );
+
+ return apply_filters( 'bp_core_get_userid', ! empty( $user->ID ) ? $user->ID : NULL, $username );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Returns the user_id for a user based on their user_nicename.
</del><ins>+ * Return the user ID based on a user's user_nicename.
</ins><span class="cx"> *
</span><del>- * @todo Refactor to check relevant WP caches, or to use get_user_by()
</del><ins>+ * @since BuddyPress (1.2.3)
</ins><span class="cx"> *
</span><del>- * @param string $username Username to check.
- * @return int|bool The ID of the matched user, or false.
</del><ins>+ * @param string $user_nicename user_nicename to check.
+ * @return int|null The ID of the matched user on success, null on failure.
</ins><span class="cx"> */
</span><span class="cx"> function bp_core_get_userid_from_nicename( $user_nicename ) {
</span><del>- global $wpdb;
-
- if ( empty( $user_nicename ) )
</del><ins>+ if ( empty( $user_nicename ) ) {
</ins><span class="cx"> return false;
</span><ins>+ }
</ins><span class="cx">
</span><del>- return apply_filters( 'bp_core_get_userid_from_nicename', $wpdb->get_var( $wpdb->prepare( "SELECT ID FROM {$wpdb->users} WHERE user_nicename = %s", $user_nicename ) ), $user_nicename );
</del><ins>+ $user = get_user_by( 'slug', $user_nicename );
+
+ return apply_filters( 'bp_core_get_userid_from_nicename', ! empty( $user->ID ) ? $user->ID : NULL, $user_nicename );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre></div>
<a id="trunktestsphpunittestcasesmembersfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/tests/phpunit/testcases/members/functions.php (8531 => 8532)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/tests/phpunit/testcases/members/functions.php 2014-06-15 20:00:53 UTC (rev 8531)
+++ trunk/tests/phpunit/testcases/members/functions.php 2014-06-15 20:07:22 UTC (rev 8532)
</span><span class="lines">@@ -399,4 +399,11 @@
</span><span class="cx">
</span><span class="cx"> $this->assertSame( $expected, $found );
</span><span class="cx"> }
</span><ins>+
+ /**
+ * @group bp_core_get_userid_from_nicename
+ */
+ public function test_bp_core_get_userid_from_nicename_failure() {
+ $this->assertSame( NULL, bp_core_get_userid_from_nicename( 'non_existent_user' ) );
+ }
</ins><span class="cx"> }
</span></span></pre>
</div>
</div>
</body>
</html>