bp_is_activity_heartbeat_active( bool $default = true )
Check whether Activity Heartbeat refresh is enabled.
Description Description
Parameters Parameters
- $default
-
(Optional) Fallback value if not found in the database. Default: true.
Default value: true
Return Return
(bool) True if Heartbeat refresh is enabled, otherwise false.
Source Source
File: bp-core/bp-core-options.php
function bp_is_activity_heartbeat_active( $default = true ) {
/**
* Filters whether or not Activity Heartbeat refresh is enabled.
*
* @since 2.0.0
*
* @param bool $value Whether or not Activity Heartbeat refresh is enabled.
*/
return (bool) apply_filters( 'bp_is_activity_heartbeat_active', (bool) bp_get_option( '_bp_enable_heartbeat_refresh', $default ) );
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |