Changeset 7334 for trunk/bp-members/bp-members-functions.php

Timestamp:

08/02/2013 06:29:06 PM (11 years ago)

Author:

boonebgorges

Message:

Introduces bp_*_user_last_activity() functions

User last activity data is currently stored as usermeta, with BuddyPress
making multiple calls directly to the usermeta table to get that data. These
new functions provide a central, standardized way to update and fetch
last_activity information. This makes it easier for plugins to update user
activity programatically in a future-compatible way.

Having this set of functions will facilitate any changes associated with #5128,
whose goal is to move last_activity data out of usermeta altogether.

File:

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

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

@@ -806 +806 @@
     // Return the inverse of active
     return !bp_is_user_active( $user_id );
+}
+
+/**
+ * Update a user's last activity
+ *
+ * @since BuddyPress (1.9)
+ * @param int $user_id ID of the user being updated
+ * @param string $time Time of last activity, in 'Y-m-d H:i:s' format
+ * @return bool True on success
+ */
+function bp_update_user_last_activity( $user_id = 0, $time = '' ) {
+    // Fall back on current user
+    if ( empty( $user_id ) ) {
+        $user_id = bp_loggedin_user_id();
+    }
+
+    // Bail if the user id is 0, as there's nothing to update
+    if ( empty( $user_id ) ) {
+        return false;
+    }
+
+    // Fall back on current time
+    if ( empty( $time ) ) {
+        $time = bp_core_current_time();
+    }
+
+    return bp_update_user_meta( $user_id, 'last_activity', $time );
+}
+
+/**
+ * Get the last activity for a given user
+ *
+ * @param int $user_id The ID of the user
+ * @return string Time of last activity, in 'Y-m-d H:i:s' format, or an empty
+ *   string if none is found
+ */
+function bp_get_user_last_activity( $user_id = 0 ) {
+    // Fall back on current user
+    if ( empty( $user_id ) ) {
+        $user_id = bp_loggedin_user_id();
+    }
+
+    $activity = bp_get_user_meta( $user_id, 'last_activity', true );
+
+    return apply_filters( 'bp_get_user_last_activity', $activity, $user_id );
 }
 
@@ -1514 +1559 @@
     add_action( 'login_head', 'wp_shake_js', 12 );
 }
-add_action( 'login_form_bp-spam', 'bp_live_spammer_login_error' ); 
+add_action( 'login_form_bp-spam', 'bp_live_spammer_login_error' );