<!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][3784] trunk/bp-users/bp-users-functions.php: Introduce bp_users_get_user_nicename function to fix long-standing issue with usernames having spaces or other non-standard characters in them</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, #logmsg > ol { margin-left: 0; 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>3784</dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2011-01-21 07:42:34 +0000 (Fri, 21 Jan 2011)</dd>
</dl>
<h3>Log Message</h3>
<pre>Introduce bp_users_get_user_nicename function to fix long-standing issue with usernames having spaces or other non-standard characters in them</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpusersbpusersfunctionsphp">trunk/bp-users/bp-users-functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpusersbpusersfunctionsphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-users/bp-users-functions.php (3783 => 3784)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-users/bp-users-functions.php 2011-01-21 01:31:27 UTC (rev 3783)
+++ trunk/bp-users/bp-users-functions.php 2011-01-21 07:42:34 UTC (rev 3784)
</span><span class="lines">@@ -192,38 +192,122 @@
</span><span class="cx"> global $bp;
</span><span class="cx">
</span><span class="cx"> if ( !$username = wp_cache_get( 'bp_user_username_' . $user_id, 'bp' ) ) {
</span><ins>+ // Cache not found so prepare to update it
+ $update_cache = true;
+
+ // Nicename and login were not passed
</ins><span class="cx"> if ( empty( $user_nicename ) && empty( $user_login ) ) {
</span><del>- $ud = false;
</del><span class="cx">
</span><del>- if ( isset( $bp->loggedin_user->id ) && $bp->loggedin_user->id == $user_id )
- $ud = &$bp->loggedin_user->userdata;
</del><ins>+ // User ID matches logged in user
+ if ( isset( $bp->loggedin_user->id ) && $bp->loggedin_user->id == $user_id ) {
+ $userdata = &$bp->loggedin_user->userdata;
</ins><span class="cx">
</span><del>- if ( isset( $bp->displayed_user->id ) && $bp->displayed_user->id == $user_id )
- $ud = &$bp->displayed_user->userdata;
</del><ins>+ // User ID matches displayed in user
+ } elseif ( isset( $bp->displayed_user->id ) && $bp->displayed_user->id == $user_id ) {
+ $userdata = &$bp->displayed_user->userdata;
</ins><span class="cx">
</span><del>- if ( empty( $ud ) ) {
- if ( !$ud = bp_core_get_core_userdata( $user_id ) )
</del><ins>+ // No user ID match
+ } else {
+ $userdata = false;
+ }
+
+ // No match so go dig
+ if ( empty( $userdata ) ) {
+
+ // User not found so return false
+ if ( !$userdata = bp_core_get_core_userdata( $user_id ) ) {
</ins><span class="cx"> return false;
</span><ins>+ }
</ins><span class="cx"> }
</span><span class="cx">
</span><del>- $user_nicename = $ud->user_nicename;
- $user_login = $ud->user_login;
</del><ins>+ // Update the $user_id for later
+ $user_id = $userdata->ID;
+
+ // Two possible options
+ $user_nicename = $userdata->user_nicename;
+ $user_login = $userdata->user_login;
</ins><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Pull an audible and use the login over the nicename
</ins><span class="cx"> if ( defined( 'BP_ENABLE_USERNAME_COMPATIBILITY_MODE' ) )
</span><span class="cx"> $username = $user_login;
</span><span class="cx"> else
</span><span class="cx"> $username = $user_nicename;
</span><ins>+
+ // Username found in cache so don't update it again
+ } else {
+ $update_cache = false;
</ins><span class="cx"> }
</span><span class="cx">
</span><ins>+ // Check $username for empty spaces and default to nicename if found
+ if ( strstr( $username, ' ' ) )
+ $username = bp_users_get_user_nicename( $user_id );
+
</ins><span class="cx"> // Add this to cache
</span><del>- if ( !empty( $username ) )
</del><ins>+ if ( ( true == $update_cache ) && !empty( $username ) )
</ins><span class="cx"> wp_cache_set( 'bp_user_username_' . $user_id, $username, 'bp' );
</span><span class="cx">
</span><span class="cx"> return apply_filters( 'bp_core_get_username', $username );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * Returns the user_nicename for a user based on their user_id. This should be
+ * used for linking to user profiles and anywhere else a sanitized and unique
+ * slug to a user is needed.
+ *
+ * @since BuddyPress (1.3)
+ *
+ * @package BuddyPress Core
+ * @param $uid int User ID to check.
+ * @global $userdata WordPress user data for the current logged in user.
+ * @uses get_userdata() WordPress function to fetch the userdata for a user ID
+ * @return false on no match
+ * @return str the username of the matched user.
+ */
+function bp_users_get_user_nicename( $user_id ) {
+ global $bp;
+
+ if ( !$user_nicename = wp_cache_get( 'bp_users_user_nicename_' . $user_id, 'bp' ) ) {
+ $update_cache = true;
+
+ // User ID matches logged in user
+ if ( isset( $bp->loggedin_user->id ) && $bp->loggedin_user->id == $user_id ) {
+ $userdata = &$bp->loggedin_user->userdata;
+
+ // User ID matches displayed in user
+ } elseif ( isset( $bp->displayed_user->id ) && $bp->displayed_user->id == $user_id ) {
+ $userdata = &$bp->displayed_user->userdata;
+
+ // No user ID match
+ } else {
+ $userdata = false;
+ }
+
+ // No match so go dig
+ if ( empty( $userdata ) ) {
+
+ // User not found so return false
+ if ( !$userdata = bp_core_get_core_userdata( $user_id ) ) {
+ return false;
+ }
+ }
+
+ // User nicename found
+ $user_nicename = $userdata->user_nicename;
+
+ // Nicename found in cache so don't update it again
+ } else {
+ $update_cache = false;
+ }
+
+ // Add this to cache
+ if ( true == $update_cache && !empty( $user_nicename ) )
+ wp_cache_set( 'bp_users_user_nicename_' . $user_id, $user_nicename, 'bp' );
+
+ return apply_filters( 'bp_users_get_user_nicename', $user_nicename );
+}
+
+/**
</ins><span class="cx"> * Returns the email address for the user based on user ID
</span><span class="cx"> *
</span><span class="cx"> * @package BuddyPress Core
</span></span></pre>
</div>
</div>
</body>
</html>