How to use heartbeat_settings filter in WordPress

heartbeat_settings filter

Filters the Heartbeat settings.

To use the heartbeat_settings 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 modify_heartbeat_settings_defaults which takes 1 parameter and we registered using add_filter. The first parameter heartbeat_settings is the name of the hook, The second parameter modify_heartbeat_settings_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 heartbeat_settings filter.

Parameters

Below the 1 parameter is required to use this hook.

• $settings : (array) Heartbeat settings array.

Live Example 1: Basic Heartbeat Interval Change

In this example, we change the heartbeat interval to 60 seconds.

    function weplugins_wp_heartbeat_settings_3242( $settings ) {
        $settings['interval'] = 60; // Anything between 15-120
        return $settings;
    }
    add_filter( 'heartbeat_settings', 'weplugins_wp_heartbeat_settings_3242' );
    

Live Example 2: Modify Heartbeat Settings

Below is an example of how you can use this hook to modify the heartbeat settings based on your website requirements.

    function weplugins_modify_heartbeat_settings_defaults($settings) { 
        // Update the $settings variable according to your website requirements and return this variable. You can modify the $settings variable conditionally too if you want.
        return $settings; 
    }
    // Add the filter
    add_filter( "heartbeat_settings", "weplugins_modify_heartbeat_settings_defaults", 10, 1 );
    

Live Example 3: Removing a Hook Callback

To remove a hook callback, use the example below.

    remove_filter( "heartbeat_settings", "weplugins_modify_heartbeat_settings_defaults", 10, 1 );
    

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 team and we’d be happy to assist you.