Changeset 7952 for trunk/bp-activity/bp-activity-functions.php

Timestamp:

02/21/2014 02:49:33 PM (11 years ago)

Author:

boonebgorges

Message:

Automatically check for newly created items when viewing the Activity Stream.

Leveraging WP's Heartbeat API, this new functionality performs periodic checks
to see whether new activity items matching the current filter have been posted
since the page was originally loaded. If new items are found, a Load Newest
link is inserted into the top of the stream, which will insert the new items.

A filter is included, bp_activity_heartbeat_pulse, that allows site owners to
set a specific interval for these checks. The default value is 15 seconds, or
whatever your global Heartbeat interval is.

To disable the feature, there is a new setting "Automatically check for new
activity items when viewing the activity stream".

Fixes #5328

Props imath, boonebgorges

File:

• trunk/bp-activity/bp-activity-functions.php (modified) (1 diff)

trunk/bp-activity/bp-activity-functions.php

@@ -1850 +1850 @@
     bp_activity_update_meta( $id, $cachekey, $cache );
 }
+
+/**
+ * Should we use Heartbeat to refresh activities?
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @uses bp_is_activity_heartbeat_active() to check if heatbeat setting is on.
+ * @uses bp_is_activity_directory() to check if the current page is the activity
+ *       directory.
+ * @uses bp_is_active() to check if the group component is active.
+ * @uses bp_is_group_activity() to check if on a single group, the current page
+ *       is the group activities.
+ * @uses bp_is_group_home() to check if the current page is a single group home
+ *       page.
+ *
+ * @return bool True if activity heartbeat is enabled, otherwise false.
+ */
+function bp_activity_do_heartbeat() {
+    $retval = false;
+
+    if ( ! bp_is_activity_heartbeat_active() ) {
+        return $retval;
+    }
+
+    if ( bp_is_activity_directory() ) {
+        $retval = true;
+    }
+
+    if ( bp_is_active( 'groups') ) {
+        // If no custom front, then activities are loaded in group's home
+        $has_custom_front = bp_locate_template( array( 'groups/single/front.php' ), false, true );
+
+        if ( bp_is_group_activity() || ( ! $has_custom_front && bp_is_group_home() ) ) {
+            $retval = true;
+        }
+    }
+
+    return $retval;
+}