Changeset 11316 for trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

Timestamp:

12/21/2016 02:42:05 AM (9 years ago)

Author:

boonebgorges

Message:

XProfile: More consistent cache behavior when fetching user data.

• Inside of a profile group loop (BP_XProfile_Group::get()), don't fetch user data when pulling up BP_XProfile_Field objects. In the absence of finer-grained information about users, fetching a field object grabs the data associated with the logged-in user. But in many cases, the logged-in user is irrelevant to the fields being looped over, so there's no benefit to pulling up this data. (When necessary - fetch_data - the data is queried separately, later in the get() method.)
• When caching database misses for a data query (because the specifed user doesn't have anything filled in for the given field), store the field_id and user_id properties on the cached object. This ensures that values are properly associated with their fields when being displayed.

These changes resolve an issue where cached data for the logged-in user
can be shown erroneously on another user's profile, when the other user
doesn't have a value for a given field.

Props m_uysl, r-a-y.
See #6091. Fixes #7401.

File:

• trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php (modified) (2 diffs)

trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

@@ -228 +228 @@
      *
      * @since 2.4.0
+     * @since 2.8.0 Added `$user_id` and `$get_data` parameters.
      *
      * @static
      *
-     * @param int $field_id ID of the field.
+     * @param int  $field_id ID of the field.
+     * @param int  $user_id  Optional. ID of the user associated with the field.
+     *                       Ignored if `$get_data` is false. If `$get_data` is
+     *                       true, but no `$user_id` is provided, defaults to
+     *                       logged-in user ID.
+     * @param bool $get_data Whether to fetch data for the specified `$user_id`.
      * @return BP_XProfile_Field|false Field object if found, otherwise false.
      */
-    public static function get_instance( $field_id ) {
+    public static function get_instance( $field_id, $user_id = null, $get_data = true ) {
         global $wpdb;
 
@@ -242 +248 @@
         }
 
-        return new self( $field_id );
+        return new self( $field_id, $user_id, $get_data );
     }