bp_is_activity_heartbeat_active

Filters whether or not Activity Heartbeat refresh is enabled.

Description

apply_filters( 'bp_is_activity_heartbeat_active', (bool) $bool_bp_get_option_bp_enable_heartbeat_refresh_default ); 

Parameters (1)

0. $bool_bp_get_option_bp_enable_heartbeat_refresh_default (bool) => (bool) bp_get_option( '_bp_enable_heartbeat_refresh', $default )
The bool bp get option bp enable heartbeat refresh default.

Usage

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

Defined (1)

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

/bp-core/bp-core-options.php  
  1. return (bool) apply_filters( 'bp_is_activity_heartbeat_active', (bool) bp_get_option( '_bp_enable_heartbeat_refresh', $default ) );