Changeset 7334

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.

Location:

trunk

Files:

• bp-core/bp-core-classes.php (modified) (1 diff)
• bp-core/bp-core-functions.php (modified) (2 diffs)
• bp-members/bp-members-functions.php (modified) (2 diffs)
• bp-members/bp-members-template.php (modified) (1 diff)
• bp-messages/bp-messages-classes.php (modified) (1 diff)
• tests/includes/testcase.php (modified) (1 diff)

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

@@ -778 +778 @@
         $this->avatar_thumb = bp_core_fetch_avatar( array( 'item_id' => $this->id, 'type' => 'thumb', 'alt' => sprintf( __( 'Avatar of %s', 'buddypress' ), $this->fullname ) ) );
         $this->avatar_mini  = bp_core_fetch_avatar( array( 'item_id' => $this->id, 'type' => 'thumb', 'alt' => sprintf( __( 'Avatar of %s', 'buddypress' ), $this->fullname ), 'width' => 30, 'height' => 30 ) );
-        $this->last_active  = bp_core_get_last_activity( bp_get_user_meta( $this->id, 'last_activity', true ), __( 'active %s', 'buddypress' ) );
+        $this->last_active  = bp_core_get_last_activity( bp_get_user_last_activity( $this->id ), __( 'active %s', 'buddypress' ) );
     }
 

trunk/bp-core/bp-core-functions.php

@@ -835 +835 @@
         return false;
 
-    $activity = bp_get_user_meta( $user_id, 'last_activity', true );
+    $activity = bp_get_user_last_activity( $user_id );
 
     if ( !is_numeric( $activity ) )
@@ -848 +848 @@
     }
 
-    if ( empty( $activity ) || strtotime( $current_time ) >= strtotime( '+5 minutes', $activity ) )
-        bp_update_user_meta( $user_id, 'last_activity', $current_time );
+    if ( empty( $activity ) || strtotime( $current_time ) >= strtotime( '+5 minutes', $activity ) ) {
+        bp_update_user_last_activity( $user_id, $current_time );
+    }
 }
 add_action( 'wp_head', 'bp_core_record_activity' );

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' );

trunk/bp-members/bp-members-template.php

@@ -869 +869 @@
             $user_id = bp_displayed_user_id();
 
-        $last_activity = bp_core_get_last_activity( bp_get_user_meta( $user_id, 'last_activity', true ), __('active %s', 'buddypress') );
+        $last_activity = bp_core_get_last_activity( bp_get_user_last_activity( $user_id ), __('active %s', 'buddypress') );
 
         return apply_filters( 'bp_get_last_activity', $last_activity );

trunk/bp-messages/bp-messages-classes.php

@@ -479 +479 @@
         $wpdb->query( $wpdb->prepare( "UPDATE {$bp->messages->table_name_notices} SET is_active = 0 WHERE id != %d", $id ) );
 
-        bp_update_user_meta( bp_loggedin_user_id(), 'last_activity', bp_core_current_time() );
+        bp_update_user_last_activity( bp_loggedin_user_id(), bp_core_current_time() );
 
         do_action_ref_array( 'messages_notice_after_save', array( &$this ) );

trunk/tests/includes/testcase.php

@@ -214 +214 @@
         $user_id = $this->factory->user->create( $args );
 
-        update_user_meta( $user_id, 'last_activity', $last_activity );
+        bp_update_user_last_activity( $user_id, $last_activity );
 
         if ( bp_is_active( 'xprofile' ) ) {