bp_is_activity_heartbeat_active( bool $default = true )

Check whether Activity Heartbeat refresh is enabled.

Description

Parameters

$default

(Optional) Fallback value if not found in the database. Default: true.

Default value: true

Return

(bool) True if Heartbeat refresh is enabled, otherwise false.

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 BuddyPress 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 ) );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.0.0	Introduced.

Uses

Uses
Uses	Description
bp-core/bp-core-options.php: bp_is_activity_heartbeat_active	Filters whether or not Activity Heartbeat refresh is enabled.
bp-core/bp-core-options.php: bp_get_option()	Retrieve an option.

Used By
Used By	Description
bp-core/classes/class-bp-rest-settings-endpoint.php: BP_REST_Settings_Endpoint::get_buddyboss_platform_settings()	Get BuddyBoss Platform Settings.
bp-core/classes/class-bp-rest-settings-endpoint.php: BP_REST_Settings_Endpoint::get_buddypress_settings()	Get BuddyPress settings.
bp-core/admin/bp-core-admin-settings.php: bp_admin_setting_callback_heartbeat()	Allow Heartbeat to refresh activity stream.
bp-activity/bp-activity-functions.php: bp_activity_do_heartbeat()	Should we use Heartbeat to refresh activities?

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents