Changeset 11008 for trunk/src/bp-groups/bp-groups-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-groups/bp-groups-template.php (modified) (7 diffs)

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

@@ -685 +685 @@
  *
  * @since 1.0.0
- *
- * @param object|bool $group Optional. Group object.
- *                           Default: current group in loop.
- */
-function bp_group_last_active( $group = false ) {
-        echo bp_get_group_last_active( $group );
+ * @since 2.7.0 Added $args as a parameter.
+ *
+ * @param object|bool  $group Optional. Group object. Default: current group in loop.
+ * @param array|string $args Optional. {@see bp_get_group_last_active()}.
+ */
+function bp_group_last_active( $group = false, $args = array() ) {
+        echo bp_get_group_last_active( $group, $args );
 }
         /**
@@ -696 +697 @@
          *
          * @since 1.0.0
-         *
-         * @param object|bool $group Optional. Group object.
-         *                           Default: current group in loop.
+         * @since 2.7.0 Added $args as a parameter.
+         *
+         * @param object|bool  $group Optional. Group object. Default: current group in loop.
+         * @param array|string $args {
+         *     Array of optional parameters.
+         *
+         *     @type bool $relative Optional. If true, returns relative activity date. eg. active 5 months ago.
+         *                          If false, returns active date value from database. Default: true.
+         * }
          * @return string
          */
-        function bp_get_group_last_active( $group = false ) {
+        function bp_get_group_last_active( $group = false, $args = array() ) {
                 global $groups_template;
 
@@ -708 +715 @@
                 }
 
+                $r = wp_parse_args( $args, array(
+                        'relative' => true,
+                ) );
+
                 $last_active = $group->last_activity;
-
-                if ( !$last_active ) {
+                if ( ! $last_active ) {
                         $last_active = groups_get_groupmeta( $group->id, 'last_activity' );
+                }
+
+                // We do not want relative time, so return now.
+                // @todo Should the 'bp_get_group_last_active' filter be applied here?
+                if ( ! $r['relative'] ) {
+                        return esc_attr( $last_active );
                 }
 
@@ -719 +735 @@
 
                         /**
-                         * Filters the 'last active' string for the current gorup in the loop.
+                         * Filters the 'last active' string for the current group in the loop.
                          *
                          * @since 1.0.0
@@ -1053 +1069 @@
  *
  * @since 1.0.0
- *
- * @param object|bool $group Optional. Group object.
- *                           Default: current group in loop.
- */
-function bp_group_date_created( $group = false ) {
-        echo bp_get_group_date_created( $group );
+ * @since 2.7.0 Added $args as a parameter.
+ *
+ * @param object|bool  $group Optional. Group object. Default: current group in loop.
+ * @param array|string $args  {@see bp_get_group_date_created()}.
+ */
+function bp_group_date_created( $group = false, $args = array() ) {
+        echo bp_get_group_date_created( $group, $args );
 }
         /**
@@ -1064 +1081 @@
          *
          * @since 1.0.0
-         *
-         * @param object|bool $group Optional. Group object.
-         *                           Default: current group in loop.
+         * @since 2.7.0 Added $args as a parameter.
+         *
+         * @param object|bool  $group Optional. Group object. Default: current group in loop.
+         * @param array|string $args {
+         *     Array of optional parameters.
+         *
+         *     @type bool $relative Optional. If true, returns relative created date. eg. active 5 months ago.
+         *                          If false, returns created date value from database. Default: true.
+         * }
          * @return string
          */
-        function bp_get_group_date_created( $group = false ) {
+        function bp_get_group_date_created( $group = false, $args = array() ) {
                 global $groups_template;
+
+                $r = wp_parse_args( $args, array(
+                        'relative' => true,
+                ) );
 
                 if ( empty( $group ) ) {
                         $group =& $groups_template->group;
+                }
+
+                // We do not want relative time, so return now.
+                // @todo Should the 'bp_get_group_date_created' filter be applied here?
+                if ( ! $r['relative'] ) {
+                        return esc_attr( $group->date_created );
                 }
 
@@ -3971 +4004 @@
 
 /**
- * @since 1.0.0
- */
-function bp_group_member_joined_since() {
-        echo bp_get_group_member_joined_since();
-}
-
-        /**
+ * Output the joined date for the current member in the group member loop.
+ *
+ * @since 1.0.0
+ * @since 2.7.0 Added $args as a parameter.
+ *
+ * @param array|string $args {@see bp_get_group_member_joined_since()}
+ * @return string
+ */
+function bp_group_member_joined_since( $args = array() ) {
+        echo bp_get_group_member_joined_since( $args );
+}
+        /**
+         * Return the joined date for the current member in the group member loop.
+         *
          * @since 1.0.0
-         *
-         * @return mixed|void
-         */
-        function bp_get_group_member_joined_since() {
+         * @since 2.7.0 Added $args as a parameter.
+         *
+         * @param array|string $args {
+         *     Array of optional parameters.
+         *
+         *     @type bool $relative Optional. If true, returns relative joined date. eg. joined 5 months ago.
+         *                          If false, returns joined date value from database. Default: true.
+         * }
+         * @return string
+         */
+        function bp_get_group_member_joined_since( $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_get_group_member_joined_since' filter be applied here?
+                if ( ! $r['relative'] ) {
+                        return esc_attr( $members_template->member->date_modified );
+                }
 
                 /**