Changeset 7846

Timestamp:

02/11/2014 03:19:01 PM (11 years ago)

Author:

boonebgorges

Message:

Add 'active_format' parameter to bp_get_member_last_active()

This new param allows theme authors to specify whether they'd like the current
user's last activity string in the format "Active 5 minutes ago" vs the simpler
"5 minutes ago".

Fixes #5387

Props lenasterg

Location:

trunk

Files:

• bp-members/bp-members-template.php (modified) (1 diff)
• tests/testcases/members/template.php (modified) (1 diff)

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

@@ -587 +587 @@
     add_filter( 'bp_get_member_name', 'esc_html'       );
 
-function bp_member_last_active() {
-    echo bp_get_member_last_active();
-}
-    function bp_get_member_last_active() {
-        global $members_template;
-
-        if ( isset( $members_template->member->last_activity ) )
-            $last_activity = bp_core_get_last_activity( $members_template->member->last_activity, __( 'active %s', 'buddypress' ) );
-        else
+/**
+ * Output the current member's last active time.
+ *
+ * @param array $args See {@link bp_get_member_last_active()}.
+ */
+function bp_member_last_active( $args = array() ) {
+    echo bp_get_member_last_active( $args );
+}
+    /**
+     * Return the current member's last active time.
+     *
+     * @param array $args {
+     *     Array of optional arguments.
+     *     @type bool $active_format If true, formatted "Active 5 minutes
+     *           ago". If false, formatted "5 minutes ago". Default: true.
+     * }
+     * @return string
+     */
+    function bp_get_member_last_active( $args = array() ) {
+        global $members_template;
+
+        $r = wp_parse_args( $args, array(
+            'active_format' => true,
+        ) );
+
+        if ( isset( $members_template->member->last_activity ) ) {
+            if ( ! empty( $r['active_format'] ) ) {
+                $last_activity = bp_core_get_last_activity( $members_template->member->last_activity, __( 'active %s', 'buddypress' ) );
+            } else {
+                $last_activity = bp_core_time_since( $members_template->member->last_activity );
+            }
+        } else {
             $last_activity = __( 'Never active', 'buddypress' );
+        }
 
         return apply_filters( 'bp_member_last_active', $last_activity );

trunk/tests/testcases/members/template.php

@@ -98 +98 @@
     }
 
+    /**
+     * @group bp_get_member_last_active
+     */
+    public function test_bp_get_member_last_active_default_params() {
+        // Fake the global
+        global $members_template;
+
+        $time = date( 'Y-m-d h:i:s', time() - 24*60*60 );
+        $members_template = new stdClass;
+        $members_template->member = new stdClass;
+        $members_template->member->last_activity = $time;
+
+        $this->assertEquals( bp_core_get_last_activity( $time, __( 'active %s', 'buddypress' ) ), bp_get_member_last_active() );
+    }
+
+    /**
+     * @group bp_get_member_last_active
+     */
+    public function test_bp_get_member_last_active_active_format_true() {
+        // Fake the global
+        global $members_template;
+
+        $time = date( 'Y-m-d h:i:s', time() - 24*60*60 );
+        $members_template = new stdClass;
+        $members_template->member = new stdClass;
+        $members_template->member->last_activity = $time;
+
+        $this->assertEquals( bp_core_get_last_activity( $time, __( 'active %s', 'buddypress' ) ), bp_get_member_last_active( array( 'active_format' => true, ) ) );
+    }
+
+    /**
+     * @group bp_get_member_last_active
+     */
+    public function test_bp_get_member_last_active_active_format_false() {
+        // Fake the global
+        global $members_template;
+
+        $time = date( 'Y-m-d h:i:s', time() - 24*60*60 );
+        $members_template = new stdClass;
+        $members_template->member = new stdClass;
+        $members_template->member->last_activity = $time;
+
+        $this->assertEquals( bp_core_time_since( $time ), bp_get_member_last_active( array( 'active_format' => false, ) ) );
+    }
 }