Changeset 9824

Timestamp:

04/30/2015 06:42:58 PM (11 years ago)

Author:

johnjamesjacoby

Message:

Activity: Introduce comment_date_recorded_raw() functions for retrieving an unformatted date_recorded value for an activity stream comment. Adjusts phpdoc for existing date_recorded() functions to note that they are formatted.

File:

• trunk/src/bp-activity/bp-activity-template.php (modified) (3 diffs)

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

@@ -2480 +2480 @@
 
 /**
- * Output the date_recorded of the activity comment currently being displayed.
+ * Output the formatted date_recorded of the activity comment currently being displayed.
  *
  * @since BuddyPress (1.5.0)
@@ -2491 +2491 @@
 
         /**
+         * Return the formatted date_recorded for the activity comment currently being displayed.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @uses bp_core_time_since()
+         * @uses apply_filters() To call the 'bp_activity_comment_date_recorded' hook
+         *
+         * @return string|bool $date_recorded Time since the activity was recorded,
+         *         in the form "%s ago". False on failure.
+         */
+        function bp_get_activity_comment_date_recorded() {
+
+                /**
+                 * Filters the recorded date of the activity comment currently being displayed.
+                 *
+                 * @since BuddyPress (1.5.0)
+                 *
+                 * @param string|bool Date for the activity comment currently being displayed.
+                 */
+                return apply_filters( 'bp_activity_comment_date_recorded', bp_core_time_since( bp_get_activity_comment_date_recorded_raw() ) );
+        }
+
+/**
+ * Output the date_recorded of the activity comment currently being displayed.
+ *
+ * @since BuddyPress (2.3.0)
+ *
+ * @uses bp_get_activity_comment_date_recorded()
+ */
+function bp_activity_comment_date_recorded_raw() {
+        echo bp_get_activity_comment_date_recorded_raw();
+}
+
+        /**
          * Return the date_recorded for the activity comment currently being displayed.
          *
-         * @since BuddyPress (1.5.0)
+         * @since BuddyPress (2.3.0)
          *
          * @global object $activities_template {@link BP_Activity_Template}
@@ -2502 +2536 @@
          *         in the form "%s ago". False on failure.
          */
-        function bp_get_activity_comment_date_recorded() {
+        function bp_get_activity_comment_date_recorded_raw() {
                 global $activities_template;
 
-                if ( empty( $activities_template->activity->current_comment->date_recorded ) ) {
-                        return false;
-                }
-
-                $date_recorded = bp_core_time_since( $activities_template->activity->current_comment->date_recorded );
-
-                /**
-                 * Filters the recorded date of the activity comment currently being displayed.
-                 *
-                 * @since BuddyPress (1.5.0)
-                 *
-                 * @param string|bool Date for the activity comment currently being displayed.
-                 */
-                return apply_filters( 'bp_activity_comment_date_recorded', $date_recorded );
+                /**
+                 * Filters the raw recorded date of the activity comment currently being displayed.
+                 *
+                 * @since BuddyPress (2.3.0)
+                 *
+                 * @param string|bool Raw date for the activity comment currently being displayed.
+                 */
+                return apply_filters( 'bp_activity_comment_date_recorded', $activities_template->activity->current_comment->date_recorded );
         }