Changeset 11008 for trunk/src/bp-members/bp-members-template.php

Timestamp:

08/10/2016 12:55:49 PM (10 years ago)

Author:

djpaul

Message:

Fix inaccurate timestamps caused by page caching.

If any template with a timestamp is statically cached, then the timestamps quickly become inaccurate.
The change adds livestamp.js and moment.js to dynamically update timestamps with the real relative time.

A consequence is that the labels surrounding the timestamps, notably in our widgets, have slightly changed.
We're going to keep an eye on this for the remainder of the 2.7 development cycle, and may make further adjustments as testing proves necessary.

Fixes #5757

Props r-a-y, imath, DJPaul

File:

• trunk/src/bp-members/bp-members-template.php (modified) (7 diffs)

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

@@ -934 +934 @@
  * @since 1.2.0
  *
- * @param array $args See {@link bp_get_member_last_active()}.
+ * @param array $args {@see bp_get_member_last_active()}.
  */
 function bp_member_last_active( $args = array() ) {
@@ -943 +943 @@
          *
          * @since 1.2.0
+         * @since 2.7.0 Added 'relative' as a parameter to $args.
          *
          * @param array $args {
          *     Array of optional arguments.
-         *     @type mixed $active_format If true, formatted "active 5 minutes
-         *                                ago". If false, formatted "5 minutes ago".
-         *                                If string, should be sprintf'able like
-         *                                'last seen %s ago'.
+         *     @type mixed $active_format If true, formatted "active 5 minutes ago". If false, formatted "5 minutes
+         *                                ago". If string, should be sprintf'able like 'last seen %s ago'.
+         *     @type bool  $relative      If true, will return relative time "5 minutes ago". If false, will return
+         *                                date from database. Default: true.
          * }
          * @return string
@@ -958 +959 @@
                 // Parse the activity format.
                 $r = bp_parse_args( $args, array(
-                        'active_format' => true
+                        'active_format' => true,
+                        'relative'      => true,
                 ) );
 
@@ -968 +970 @@
                 // Member has logged in at least one time.
                 if ( isset( $members_template->member->last_activity ) ) {
+                        // We do not want relative time, so return now.
+                        // @todo Should the 'bp_member_last_active' filter be applied here?
+                        if ( ! $r['relative'] ) {
+                                return esc_attr( $members_template->member->last_activity );
+                        }
 
                         // Backwards compatibility for pre 1.5 'ago' strings.
@@ -974 +981 @@
                                 : bp_core_time_since( $members_template->member->last_activity );
 
-                        // Member has never logged in or been active.
+                // Member has never logged in or been active.
                 } else {
                         $last_activity = __( 'Never active', 'buddypress' );
@@ -1152 +1159 @@
  *
  * @since 1.2.0
- */
-function bp_member_registered() {
-        echo bp_get_member_registered();
+ * @since 2.7.0 Added $args as a parameter.
+ *
+ * @param array $args Optional. {@see bp_get_member_registered()}
+ */
+function bp_member_registered( $args = array() ) {
+        echo bp_get_member_registered( $args );
 }
         /**
@@ -1160 +1170 @@
          *
          * @since 1.2.0
-         *
-         * @return string
-         */
-        function bp_get_member_registered() {
+         * @since 2.7.0 Added $args as a parameter.
+         *
+         * @param array $args {
+         *     Array of optional parameters.
+         *
+         *     @type bool $relative Optional. If true, returns relative registered date. eg. registered 5 months ago.
+         *                          If false, returns registered date value from database.
+         * }
+         *
+         * @return string
+         */
+        function bp_get_member_registered( $args = array() ) {
                 global $members_template;
+
+                $r = wp_parse_args( $args, array(
+                        'relative' => true,
+                ) );
+
+                // We do not want relative time, so return now.
+                // @todo Should the 'bp_member_registered' filter be applied here?
+                if ( ! $r['relative'] ) {
+                        return esc_attr( $members_template->member->user_registered );
+                }
 
                 $registered = esc_attr( bp_core_get_last_activity( $members_template->member->user_registered, _x( 'registered %s', 'Records the timestamp that the user registered into the activity stream', 'buddypress' ) ) );