heartbeat_received │ filter-hook │ WP 3.6.0

Filters the Heartbeat response received.

Usage

add_filter( 'heartbeat_received', 'wp_kama_heartbeat_received_filter', 10, 3 );

/**
 * Function for `heartbeat_received` filter-hook.
 * 
 * @param array  $response  The Heartbeat response.
 * @param array  $data      The $_POST data sent.
 * @param string $screen_id The screen ID.
 *
 * @return array
 */
function wp_kama_heartbeat_received_filter( $response, $data, $screen_id ){

	// filter...
	return $response;
}

$response(array)

The Heartbeat response.

$data(array)

The $_POST data sent.

$screen_id(string)

The screen ID.

Changelog

Where the hook is called

$response = apply_filters( 'heartbeat_received', $response, $data, $screen_id );

Where the hook is used in WordPress

add_filter( 'heartbeat_received', 'wp_check_locked_posts', 10, 3 );

add_filter( 'heartbeat_received', 'wp_refresh_post_lock', 10, 3 );

add_filter( 'heartbeat_received', 'heartbeat_autosave', 500, 2 );

add_filter( 'heartbeat_received', array( $this, 'check_changeset_lock_with_heartbeat' ), 10, 3 );