Changeset 7812

Timestamp:

02/06/2014 07:38:35 PM (11 years ago)

Author:

boonebgorges

Message:

Introduce bp_xprofile_fullname_field_id() and use in query building throughout BP

There are many places throughout BuddyPress where it's necessary to query for
user fullnames. When XProfile is active, part of this process involves
determining the ID of the fullname field. Historically, this has been done by
querying for the ID of a field corresponding to the 'name' bp_xprofile_fullname_field_name().
Creating a standalone function for this allows us to centralize persistent
caching for the field ID.

As a side note, the fact that we do this query at all is a little farcical.
The fullname field is essentially necessarily tied to field #1 (due to some
hardcoding in the xprofile schema definition as well as bp-xprofile-admin.php).
We rely on the Name setting only for historical reasons, which probably didn't
even make all that much sense at the time. At some point, a serious review
should be done, and references to the fullname field id standardized (either
all hardcoded, or all not hardcoded).

See #5362

Location:

trunk

Files:

• bp-core/bp-core-classes.php (modified) (1 diff)
• bp-xprofile/bp-xprofile-cache.php (modified) (1 diff)
• bp-xprofile/bp-xprofile-classes.php (modified) (1 diff)
• bp-xprofile/bp-xprofile-filters.php (modified) (1 diff)
• bp-xprofile/bp-xprofile-functions.php (modified) (3 diffs)
• tests/testcases/xprofile/functions.php (modified) (1 diff)

trunk/bp-core/bp-core-classes.php

@@ -302 +302 @@
                 // the xprofile table
                 } else {
-                    $fullname_field_id = $wpdb->get_var( $wpdb->prepare( "SELECT id FROM {$bp->profile->table_name_fields} WHERE name = %s", bp_xprofile_fullname_field_name() ) );
-
                     $this->uid_name = 'user_id';
                     $sql['select']  = "SELECT u.{$this->uid_name} as id FROM {$bp->profile->table_name_data} u";
-                    $sql['where'][] = "u.field_id = {$fullname_field_id}";
+                    $sql['where'][] = $wpdb->prepare( "u.field_id = %d", bp_xprofile_fullname_field_id() );
                     $sql['orderby'] = "ORDER BY u.value";
                     $sql['order']   = "ASC";

trunk/bp-xprofile/bp-xprofile-cache.php

@@ -59 +59 @@
 add_action( 'xprofile_data_after_delete', 'xprofile_clear_profiledata_object_cache' );
 
+/**
+ * Clear fullname_field_id cache when bp-xprofile-fullname-field-name is updated.
+ *
+ * Note for future developers: Dating from an early version of BuddyPress where
+ * the fullname field (field #1) did not have a title that was editable in the
+ * normal Profile Fields admin interface, we have the bp-xprofile-fullname-field-name
+ * option. In many places throughout BuddyPress, the ID of the fullname field
+ * is queried using this setting. However, this is no longer strictly necessary,
+ * because we essentially hardcode (in the xprofile admin save routine, as well
+ * as the xprofile schema definition) that the fullname field will be 1. The
+ * presence of the non-hardcoded versions (and thus this bit of cache
+ * invalidation) is thus for backward compatibility only.
+ *
+ * @since BuddyPress (2.0.0)
+ */
+function xprofile_clear_fullname_field_id_cache() {
+    wp_cache_delete( 'fullname_field_id', 'bp_xprofile' );
+}
+add_action( 'update_option_bp-xprofile-fullname-field-name', 'xprofile_clear_fullname_field_id_cache' );
+
 // List actions to clear super cached pages on, if super cache is installed
 add_action( 'xprofile_updated_profile', 'bp_core_clear_cache' );

trunk/bp-xprofile/bp-xprofile-classes.php

@@ -1492 +1492 @@
             $user_id = bp_displayed_user_id();
 
-        $field_name = bp_xprofile_fullname_field_name();
-        $data       = xprofile_get_field_data( $field_name, $user_id );
+        $data = xprofile_get_field_data( bp_xprofile_fullname_field_id(), $user_id );
 
         return $data[$field_name];

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

@@ -252 +252 @@
     }
 
-    $fullname_field_id = $wpdb->get_var( $wpdb->prepare( "SELECT id FROM {$bp->profile->table_name_fields} WHERE name = %s", bp_xprofile_fullname_field_name() ) );
-    $user_id_names     = BP_XProfile_ProfileData::get_value_byid( $fullname_field_id, $user_query->user_ids );
+    $user_id_names = BP_XProfile_ProfileData::get_value_byid( bp_xprofile_fullname_field_id(), $user_query->user_ids );
 
     // Loop through names and override each user's fullname

trunk/bp-xprofile/bp-xprofile-functions.php

@@ -438 +438 @@
         return false;
 
-    $fullname = xprofile_get_field_data( bp_xprofile_fullname_field_name(), $user_id );
+    $fullname = xprofile_get_field_data( bp_xprofile_fullname_field_id(), $user_id );
     $space    = strpos( $fullname, ' ' );
 
@@ -474 +474 @@
         return;
 
-    xprofile_set_field_data( bp_xprofile_fullname_field_name(), $user->ID, $user->display_name );
+    xprofile_set_field_data( bp_xprofile_fullname_field_id(), $user->ID, $user->display_name );
 }
 add_action( 'user_profile_update_errors', 'xprofile_sync_bp_profile', 10, 3 );
@@ -626 +626 @@
 
 /**
+ * Return the field ID for the Full Name xprofile field.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @return int Field ID.
+ */
+function bp_xprofile_fullname_field_id() {
+    $id = wp_cache_get( 'fullname_field_id', 'bp_xprofile' );
+
+    if ( false === $id ) {
+        global $wpdb;
+
+        $bp = buddypress();
+        $id = $wpdb->get_var( $wpdb->prepare( "SELECT id FROM {$bp->profile->table_name_fields} WHERE name = %s", bp_xprofile_fullname_field_name() ) );
+
+        wp_cache_set( 'fullname_field_id', $id, 'bp_xprofile' );
+    }
+
+    return absint( $id );
+}
+
+/**
  * Return the field name for the Full Name xprofile field
  *

trunk/tests/testcases/xprofile/functions.php

@@ -81 +81 @@
         $this->assertEquals( $meta_value, bp_xprofile_get_meta( $f->id, 'field', 'linebreak_field' ) );
     }
+
+    /**
+     * @group bp_xprofile_fullname_field_id
+     */
+    public function test_bp_xprofile_fullname_field_id_invalidation() {
+        // Prime the cache
+        $id = bp_xprofile_fullname_field_id();
+
+        bp_update_option( 'bp-xprofile-fullname-field-name', 'foo' );
+
+        $this->assertFalse( wp_cache_get( 'fullname_field_id', 'bp_xprofile' ) );
+    }
 }