heartbeat_received

The WordPress Core heartbeat received hook.

Description

add_filter( 'heartbeat_received', (string) $wp_check_locked_posts, (int) $int, (int) $int ); 

Parameters (3)

0. $wp_check_locked_posts (string) => 'wp_check_locked_posts'
The wp check locked posts.
1. $int (int) => 10
The int.
2. $int (int) => 3
The int.

Usage

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

Defined (4)

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

/wp-admin/includes/admin-filters.php  
  1. add_filter( 'heartbeat_received', 'wp_check_locked_posts', 10, 3 ); 
  1. add_filter( 'heartbeat_received', 'wp_refresh_post_lock', 10, 3 ); 
  1. add_filter( 'heartbeat_received', 'heartbeat_autosave', 500, 2 ); 
/wp-admin/includes/ajax-actions.php  
  1. $response = apply_filters( 'heartbeat_received', $response, $data, $screen_id );