Changeset 7952 for trunk/bp-core/bp-core-options.php

Timestamp:

02/21/2014 02:49:33 PM (12 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-core/bp-core-options.php (modified) (2 diffs)

trunk/bp-core/bp-core-options.php

@@ -76 +76 @@
         // Users from all sites can post
         '_bp_enable_akismet'              => true,
+
+        /** Activity HeartBeat ************************************************/
+
+        // HeartBeat is on to refresh activities
+        '_bp_enable_heartbeat_refresh'    => true,
 
         /** BuddyBar **********************************************************/
@@ -587 +592 @@
 
 /**
+ * Check whether Activity Heartbeat refresh is enabled.
+ *
+ * @since BuddyPress (2.0.0)
+ *
+ * @uses bp_get_option() To get the Heartbeat option.
+ *
+ * @param bool $default Optional. Fallback value if not found in the database.
+ *        Default: true.
+ * @return bool True if Heartbeat refresh is enabled, otherwise false.
+ */
+function bp_is_activity_heartbeat_active( $default = true ) {
+    return (bool) apply_filters( 'bp_is_activity_heartbeat_active', (bool) bp_get_option( '_bp_enable_heartbeat_refresh', $default ) );
+}
+
+/**
  * Get the current theme package ID.
  *