Changeset 12754 for trunk/src/bp-members/bp-members-functions.php

Timestamp:

10/15/2020 06:33:17 PM (4 years ago)

Author:

imath

Message:

Members: stop mirroring user last_activity data to user metadata

The primary storage location for user last_activity is the activity table. For backward compatibility reasons, we used to mirror that data into user metadata.

Backward compatibility user last_activity metadata mirroring is now only done if the legacy user query is enabled. This can be achieved by forcing the bp_use_legacy_user_query filter to return true.

Props boonebgorges, r-a-y

Fixes #7882

File:

• trunk/src/bp-members/bp-members-functions.php (modified) (3 diffs)

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

@@ -127 +127 @@
     ), 'core_get_users' );
 
-    // For legacy users. Use of BP_Core_User::get_users() is deprecated.
-    if ( apply_filters( 'bp_use_legacy_user_query', false, __FUNCTION__, $r ) ) {
+    /**
+     * For legacy users. Use of BP_Core_User::get_users() is deprecated.
+     *
+     * Forcing this filter to true will use the legacy user query. As of
+     * BuddyPress 7.0.0, mirroring of the 'last_activity' value to usermeta
+     * is also disabled if true. See bp_update_user_last_activity().
+     *
+     * @since 2.0.0
+     *
+     * @param bool   $retval   Defaults to false.
+     * @param string $function Current function name.
+     * @param array  $r        User query arguments.
+     */
+    $use_legacy_query = apply_filters( 'bp_use_legacy_user_query', false, __FUNCTION__, $r );
+
+    if ( $use_legacy_query ) {
         $retval = BP_Core_User::get_users(
             $r['type'],
@@ -1049 +1063 @@
  *
  * @since 1.9.0
+ * @since 7.0.0 Backward compatibility usermeta mirroring is only allowed if the
+ *              legacy user query is enabled.
  *
  * @param int    $user_id ID of the user being updated.
@@ -1071 +1087 @@
     }
 
-    // As of BuddyPress 2.0, last_activity is no longer stored in usermeta.
-    // However, we mirror it there for backward compatibility. Do not use!
-    // Remove our warning and re-add.
-    remove_filter( 'update_user_metadata', '_bp_update_user_meta_last_activity_warning', 10 );
-    remove_filter( 'get_user_metadata', '_bp_get_user_meta_last_activity_warning', 10 );
-    bp_update_user_meta( $user_id, 'last_activity', $time );
-    add_filter( 'update_user_metadata', '_bp_update_user_meta_last_activity_warning', 10, 4 );
-    add_filter( 'get_user_metadata', '_bp_get_user_meta_last_activity_warning', 10, 4 );
+    /** This filter is documented in bp_core_get_users() */
+    $use_legacy_query = apply_filters( 'bp_use_legacy_user_query', false, __FUNCTION__, [ 'user_id' => $user_id ] );
+
+    /*
+     * As of BuddyPress 2.0, last_activity is no longer stored in usermeta.
+     * However, we mirror it there for backward compatibility. Do not use!
+     *
+     * As of BuddyPress 7.0, mirroring is only allowed if the legacy user
+     * query is enabled.
+     */
+    if ( $use_legacy_query ) {
+        remove_filter( 'update_user_metadata', '_bp_update_user_meta_last_activity_warning', 10 );
+        remove_filter( 'get_user_metadata', '_bp_get_user_meta_last_activity_warning', 10 );
+        bp_update_user_meta( $user_id, 'last_activity', $time );
+        add_filter( 'update_user_metadata', '_bp_update_user_meta_last_activity_warning', 10, 4 );
+        add_filter( 'get_user_metadata', '_bp_get_user_meta_last_activity_warning', 10, 4 );
+    }
 
     return BP_Core_User::update_last_activity( $user_id, $time );