bp_activity_do_heartbeat

Filters whether the heartbeat feature in the activity stream should be active.

Description

apply_filters( 'bp_activity_do_heartbeat', (bool) $retval ); 

Parameters (1)

0. $retval (bool)
Whether or not activity heartbeat is active.

Usage

To run the hook, copy the example below.
  1. $retval = apply_filters( 'bp_activity_do_heartbeat', $retval ); 
  2.  
  3. if ( !empty( $retval ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the bp_activity_do_heartbeat callback 
  2. function filter_bp_activity_do_heartbeat( $retval ) { 
  3. // make filter magic happen here... 
  4. return $retval
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'bp_activity_do_heartbeat', 'filter_bp_activity_do_heartbeat', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'bp_activity_do_heartbeat', 'filter_bp_activity_do_heartbeat', 10, 1 ); 

Defined (1)

The filter is defined in the following location(s).

/bp-activity/bp-activity-functions.php  
  1. return (bool) apply_filters( 'bp_activity_do_heartbeat', $retval );