bp_activity_do_heartbeat()

Should we use Heartbeat to refresh activities?

Description

Return

(bool) True if activity heartbeat is enabled, otherwise false.

Source

File: bp-activity/bp-activity-functions.php

function bp_activity_do_heartbeat() {
	$retval = false;

	if ( bp_is_activity_heartbeat_active() && ( bp_is_activity_directory() || bp_is_group_activity() ) ) {
		$retval = true;
	}

	/**
	 * Filters whether the heartbeat feature in the activity feed should be active.
	 *
	 * @since BuddyPress 2.8.0
	 *
	 * @param bool $retval Whether or not activity heartbeat is active.
	 */
	return (bool) apply_filters( 'bp_activity_do_heartbeat', $retval );
}

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-template.php: bp_is_group_activity()	Is the current page a group’s activity page?
bp-core/bp-core-template.php: bp_is_user_activity()	Is the current page a user’s activity feed page?
bp-core/bp-core-template.php: bp_is_activity_directory()	Is the current page the activity directory?
bp-core/bp-core-options.php: bp_is_activity_heartbeat_active()	Check whether Activity Heartbeat refresh is enabled.
bp-activity/bp-activity-functions.php: bp_activity_do_heartbeat	Filters whether the heartbeat feature in the activity feed should be active.

Used By
Used By	Description
bp-activity/bp-activity-filters.php: bp_activity_enqueue_heartbeat_js()	Enqueue Heartbeat js for the activity
bp-activity/bp-activity-filters.php: bp_activity_get_js_dependencies()	Include extra JavaScript dependencies for activity component.
bp-activity/bp-activity-filters.php: bp_activity_timestamp_class()	Check if Activity Heartbeat feature i on to add a timestamp class.
bp-activity/bp-activity-filters.php: bp_activity_heartbeat_strings()	Set the strings for WP HeartBeat API where needed.

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