How to use heartbeat_send filter in WordPress

heartbeat_send filter

Filters the Heartbeat response sent.

To use the heartbeat_send filter, first, you have to register it using add_filter. You can write this code into functions.php of your activated theme or in a custom WordPress Plugin.

We at WePlugins always prefer to create a custom WordPress Plugin while using hooks so nothing breaks when you update your WordPress Theme in the future.

In the below live example, we have defined a function weplugins_modify_heartbeat_send_defaults which takes 2 parameters and we registered using add_filter. The first parameter heartbeat_send is the name of the hook, The second parameter weplugins_modify_heartbeat_send_defaults is the name of the function which needs to be called, the third parameter is the priority of calling the hook if the same hook is used multiple times, and the last parameter is the number of arguments (if any) to be passed in the registered function.

Sometimes, you have to remove a registered hook, so you can use remove_filter to remove the heartbeat_send filter.

Parameters

Below are the 2 parameters required to use this hook.

• $response : (array) The Heartbeat response.
• $screen_id : (string) The screen ID.

Live Examples

Example 1: Basic Usage

Below is an example of how you can use this hook.

    function weplugins_modify_heartbeat_send_defaults($response, $screen_id) { 
        // Update the $response variable according to your website requirements and return this variable. You can modify the $response variable conditionally too if you want.
        return $response; 
    }
    // add the filter
    add_filter("heartbeat_send", "weplugins_modify_heartbeat_send_defaults", 10, 2);
    

Example 2: Conditional Response Modification

Here, we modify the response conditionally based on the screen ID.

    function weplugins_modify_heartbeat_send_based_on_screen($response, $screen_id) {
        if ($screen_id === 'dashboard') {
            // Modify the $response specifically for the dashboard screen
            $response['custom_data'] = 'Dashboard specific data';
        }
        return $response;
    }
    add_filter("heartbeat_send", "weplugins_modify_heartbeat_send_based_on_screen", 10, 2);
    

Example 3: Removing the Hook

To remove a hook callback, use the example below.

    remove_filter("heartbeat_send", "weplugins_modify_heartbeat_send_defaults", 10, 2);
    

Please make sure to provide the same callback function name, priority, and number of arguments while removing the hook callback.

Contact Us

If you’re having any trouble using this hook, please contact our WordPress Development Team and we’d be happy to assist you.