Changeset 8027

Timestamp:

03/03/2014 09:35:48 PM (11 years ago)

Author:

boonebgorges

Message:

Introduce bp_core_user_displaynames(), for quick, bulk displayname lookup

The technique BP uses for determining a user's displayname takes into
consideration whether the xprofile component is active, whether the user has a
WP display_name, and a number of other factors. Because the values are used so
often throughout BP, they are then cached in WP's object cache. However, there
are a number of places throughout BuddyPress where displaynames are fetched
in a way that is inconsistent with the "canonical" workflow (ie, by querying
the xprofile tables correctly). This causes inconsistent results, and also can
result in performance degradation when the persistent cache is skipped.
Moreover, the singular nature of bp_core_get_user_displayname() meant that
doing it the "right" way meant introducing large numbers of queries to a given
page load.

This changeset introduces bp_core_get_user_displaynames(), which contains all
the critical logic of bp_core_get_user_displayname() - including fallbacks for
various setups and support for the object cache - but allows for fetching large
numbers of displaynames without multiple queries. bp_core_get_user_displayname()
is now a wrapper for the more general function.

The function has been swapped in throughout BuddyPress as appropriate.

See #5445

Location:

trunk

Files:

• bp-activity/bp-activity-classes.php (modified) (1 diff)
• bp-members/bp-members-functions.php (modified) (2 diffs)
• bp-xprofile/bp-xprofile-filters.php (modified) (2 diffs)
• tests/testcases/members/functions.php (modified) (1 diff)

trunk/bp-activity/bp-activity-classes.php

@@ -545 +545 @@
 
             if ( ! empty( $activity_user_ids ) ) {
-                $names = BP_XProfile_ProfileData::get_value_byid( 1, $activity_user_ids );
-                if ( ! empty( $names ) ) {
-
-                    $tmp_names = array();
-
-                    foreach ( (array) $names as $name ) {
-                        $tmp_names[ $name->user_id ] = $name->value;
-                    }
-
+                $fullnames = bp_core_get_user_displaynames( $activity_user_ids );
+                if ( ! empty( $fullnames ) ) {
                     foreach ( (array) $activities as $i => $activity ) {
-                        if ( ! empty( $tmp_names[ $activity->user_id ] ) ) {
-                            $activities[ $i ]->user_fullname = $tmp_names[ $activity->user_id ];
+                        if ( ! empty( $fullnames[ $activity->user_id ] ) ) {
+                            $activities[ $i ]->user_fullname = $fullnames[ $activity->user_id ];
                         }
                     }
-
-                    unset( $names );
-                    unset( $tmp_names );
                 }
             }

trunk/bp-members/bp-members-functions.php

@@ -390 +390 @@
 }
 
-
-/**
- * Fetch the display name for a user. This will use the "Name" field in xprofile if it is installed.
- * Otherwise, it will fall back to the normal WP display_name, or user_nicename, depending on what has been set.
- *
- * @package BuddyPress Core
- * @global BuddyPress $bp The one true BuddyPress instance
- * @uses wp_cache_get() Will try and fetch the value from the cache, rather than querying the DB again.
- * @uses get_userdata() Fetches the WP userdata for a specific user.
- * @uses xprofile_set_field_data() Will update the field data for a user based on field name and user id.
- * @uses wp_cache_set() Adds a value to the cache.
- * @return string|bool The display name for the user in question, or false if user not found.
+/**
+ * Fetch the display name for a group of users.
+ *
+ * Uses the 'Name' field in xprofile if available. Falls back on WP
+ * display_name, and then user_nicename.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @param array $user_ids
+ */
+function bp_core_get_user_displaynames( $user_ids ) {
+
+    // Sanitize
+    $user_ids = wp_parse_id_list( $user_ids );
+
+    // Remove dupes and empties
+    $user_ids = array_unique( array_filter( $user_ids ) );
+
+    if ( empty( $user_ids ) ) {
+        return array();
+    }
+
+    $uncached_ids = array();
+    foreach ( $user_ids as $user_id ) {
+        if ( false === wp_cache_get( 'bp_user_fullname_' . $user_id, 'bp' ) ) {
+            $uncached_ids[] = $user_id;
+        }
+    }
+
+    // Prime caches
+    if ( ! empty( $uncached_ids ) ) {
+        if ( bp_is_active( 'xprofile' ) ) {
+            $fullname_data = BP_XProfile_ProfileData::get_value_byid( 1, $uncached_ids );
+
+            // Key by user_id
+            $fullnames = array();
+            foreach ( $fullname_data as $fd ) {
+                if ( ! empty( $fd->value ) ) {
+                    $fullnames[ intval( $fd->user_id ) ] = $fd->value;
+                }
+            }
+
+            // If xprofiledata is not found for any users,  we'll look
+            // them up separately
+            $no_xprofile_ids = array_diff( $uncached_ids, array_keys( $fullnames ) );
+        } else {
+            $fullnames = array();
+            $no_xprofile_ids = $user_ids;
+        }
+
+        if ( ! empty( $no_xprofile_ids ) ) {
+            // Use WP_User_Query because we don't need BP information
+            $query = new WP_User_Query( array(
+                'include'     => $no_xprofile_ids,
+                'fields'      => array( 'ID', 'user_nicename', 'display_name', ),
+                'count_total' => false,
+                'blog_id'     => 0,
+            ) );
+
+            foreach ( $query->results as $qr ) {
+                $fullnames[ $qr->ID ] = ! empty( $qr->display_name ) ? $qr->display_name : $qr->user_nicename;
+
+                // If xprofile is active, set this value as the
+                // xprofile display name as well
+                if ( bp_is_active( 'xprofile' ) ) {
+                    xprofile_set_field_data( 1, $qr->ID, $fullnames[ $qr->ID ] );
+                }
+            }
+        }
+
+        foreach ( $fullnames as $fuser_id => $fname ) {
+            wp_cache_set( 'bp_user_fullname_' . $fuser_id, $fname, 'bp' );
+        }
+    }
+
+    $retval = array();
+    foreach ( $user_ids as $user_id ) {
+        $retval[ $user_id ] = wp_cache_get( 'bp_user_fullname_' . $user_id, 'bp' );
+    }
+
+    return $retval;
+}
+
+/**
+ * Fetch the display name for a user.
+ *
+ * @param int|string $user_id_or_username User ID or username.
+ * @return string|bool The display name for the user in question, or false if
+ *         user not found.
  */
 function bp_core_get_user_displayname( $user_id_or_username ) {
@@ -408 +485 @@
     $fullname = '';
 
-    if ( !$user_id_or_username )
-        return false;
-
-    if ( !is_numeric( $user_id_or_username ) )
+    if ( empty( $user_id_or_username ) ) {
+        return false;
+    }
+
+    if ( ! is_numeric( $user_id_or_username ) ) {
         $user_id = bp_core_get_userid( $user_id_or_username );
-    else
+    } else {
         $user_id = $user_id_or_username;
-
-    if ( !$user_id )
-        return false;
-
-    if ( !$fullname = wp_cache_get( 'bp_user_fullname_' . $user_id, 'bp' ) ) {
-        if ( bp_is_active( 'xprofile' ) ) {
-            $fullname = xprofile_get_field_data( 1, $user_id );
-
-            if ( empty($fullname) ) {
-                $ud = bp_core_get_core_userdata( $user_id );
-
-                if ( !empty( $ud->display_name ) )
-                    $fullname = $ud->display_name;
-                elseif ( !empty( $ud->user_nicename ) )
-                    $fullname = $ud->user_nicename;
-
-                xprofile_set_field_data( 1, $user_id, $fullname );
-            }
-        } else {
-            $ud = bp_core_get_core_userdata($user_id);
-
-            if ( !empty( $ud->display_name ) )
-                $fullname = $ud->display_name;
-            elseif ( !empty( $ud->user_nicename ) )
-                $fullname = $ud->user_nicename;
-        }
-
-        if ( !empty( $fullname ) )
-            wp_cache_set( 'bp_user_fullname_' . $user_id, $fullname, 'bp' );
+    }
+
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+
+    $display_names = bp_core_get_user_displaynames( array( $user_id ) );
+
+    if ( ! isset( $display_names[ $user_id ] ) ) {
+        $fullname = false;
+    } else {
+        $fullname = $display_names[ $user_id ];
     }
 

trunk/bp-xprofile/bp-xprofile-filters.php

@@ -216 +216 @@
 
     // Pull up the xprofile fullname of each commenter
-    if ( $fullnames = BP_XProfile_ProfileData::get_value_byid( 1, $user_ids ) ) {
-        foreach( (array) $fullnames as $user ) {
-            $users[ $user->user_id ] = trim( stripslashes( $user->value ) );
+    if ( $fullnames = bp_core_get_user_displaynames( $user_ids ) ) {
+        foreach( (array) $fullnames as $user_id => $user_fullname ) {
+            $users[ $user_id ] = trim( stripslashes( $user_fullname ) );
         }
     }
@@ -252 +252 @@
     }
 
-    $user_id_names = BP_XProfile_ProfileData::get_value_byid( bp_xprofile_fullname_field_id(), $user_query->user_ids );
+    $user_id_names = bp_core_get_user_displaynames( $user_query->user_ids );
 
     // Loop through names and override each user's fullname
-    foreach ( $user_id_names as $user ) {
-        if ( isset( $user_query->results[ $user->user_id ] ) ) {
-            $user_query->results[ $user->user_id ]->fullname = $user->value;
+    foreach ( $user_id_names as $user_id => $user_fullname ) {
+        if ( isset( $user_query->results[ $user_id ] ) ) {
+            $user_query->results[ $user_id ]->fullname = $user_fullname;
         }
     }

trunk/tests/testcases/members/functions.php

@@ -210 +210 @@
         }
     }
+
+    /**
+     * @group bp_core_get_user_displaynames
+     */
+    public function test_bp_core_get_user_displayname_arrays_all_bad_entries() {
+        $this->assertSame( array(), bp_core_get_user_displaynames( array( 0, 'foo', ) ) );
+    }
+
+    /**
+     * @group bp_core_get_user_displaynames
+     */
+    public function test_bp_core_get_user_displaynames_all_uncached() {
+        $u1 = $this->create_user();
+        $u2 = $this->create_user();
+
+        xprofile_set_field_data( 1, $u1, 'Foo' );
+        xprofile_set_field_data( 1, $u2, 'Bar' );
+
+        $expected = array(
+            $u1 => 'Foo',
+            $u2 => 'Bar',
+        );
+
+        $this->assertSame( $expected, bp_core_get_user_displaynames( array( $u1, $u2, ) ) );
+    }
+
+    /**
+     * @group bp_core_get_user_displaynames
+     */
+    public function test_bp_core_get_user_displaynames_one_not_in_xprofile() {
+        $u1 = $this->create_user();
+        $u2 = $this->create_user( array(
+            'display_name' => 'Bar',
+        ) );
+
+        xprofile_set_field_data( 1, $u1, 'Foo' );
+
+        // Delete directly because BP won't let you delete a required
+        // field through the API
+        global $wpdb, $bp;
+        $wpdb->query( $wpdb->prepare( "DELETE FROM {$bp->profile->table_name_data} WHERE user_id = %d AND field_id = 1", $u2 ) );
+        wp_cache_delete( 'bp_user_fullname_' . $u2, 'bp' );
+        wp_cache_delete( 1, 'bp_xprofile_data_' . $u2, 'bp' );
+
+        $expected = array(
+            $u1 => 'Foo',
+            $u2 => 'Bar',
+        );
+
+        $this->assertSame( $expected, bp_core_get_user_displaynames( array( $u1, $u2, ) ) );
+    }
+
+    /**
+     * @group bp_core_get_user_displaynames
+     */
+    public function test_bp_core_get_user_displaynames_one_in_cache() {
+        $u1 = $this->create_user();
+        xprofile_set_field_data( 1, $u1, 'Foo' );
+
+        // Fake the cache for $u2
+        $u2 = 123;
+        wp_cache_set( 'bp_user_fullname_' . $u2, 'Bar', 'bp' );
+
+        $expected = array(
+            $u1 => 'Foo',
+            $u2 => 'Bar',
+        );
+
+        $this->assertSame( $expected, bp_core_get_user_displaynames( array( $u1, $u2, ) ) );
+    }
 }