Added ability to change or disable WordPress heartbeat

Author: dmhendricks

CHANGELOG.md

@@ -3,6 +3,7 @@
 ### master
 
 - Fixed: Firing sequence of `common_toolkit_loaded` hook
+- Added: Ability to modify or disable WordPress heartbeat
 - Added: `ctk_environment` filter
 - Added: Ability to disable WordPress search
 - Added: Ability to define custom environment constant

README.md

@@ -32,15 +32,16 @@ All variables are optional.
 | `environment`             | Environment of current instance (ex: 'production', 'development', 'staging')                                             | string      | "production"  |
 | `environment_constant`    | Constant used to determine environment, environmental variable name for `getenv()`.                                      | string      | "WP_ENV"      |
 | `environment_production`  | The label used to match if production environment.                                                                       | string      | "production"  |
+| `admin_bar_color`         | Change admin bar color in current environment                                                                            | string      | _null_        |
 | `disable_emojis`          | Remove support for emojis                                                                                                | bool        | false         |
 | `disable_search`          | Disable WordPress site search                                                                                            | bool        | false         |
-| `admin_bar_color`         | Change admin bar color in current environment                                                                            | string      | _null_        |
-| `script_attributes`       | Enable support for [additional attributes](#add-attributes-to-enqueued-scripts) to script tags via wp_enqueue_script()   | bool        | flase         |
-| `shortcodes`              | Enable custom [shortcodes](#shortcodes) created by this class                                                            | bool        | false         |
 | `disable_xmlrpc`          | Disable XML-RPC                                                                                                          | bool        | false         |
+| `feed_links`              | Include RSS feed links in page head                                                                                      | bool        | true          |
+| `heartbeat`               | Modify or disable the WordPress heartbeat. Set to integer to change, `false` to disable                                  | bool/int    | null          |
 | `meta_generator`          | Enable or change meta generator tags in page head and RSS feeds                                                          | bool/string | true          |
+| `script_attributes`       | Enable support for [additional attributes](#add-attributes-to-enqueued-scripts) to script tags via wp_enqueue_script()   | bool        | flase         |
+| `shortcodes`              | Enable custom [shortcodes](#shortcodes) created by this class                                                            | bool        | false         |
 | `windows_live_writer`     | Enable [Windows Live Writer](https://is.gd/Q6KjEQ) support                                                               | bool        | true          |
-| `feed_links`              | Include RSS feed links in page head                                                                                      | bool        | true          |
 
 ### Example
 

common-toolkit.php

@@ -44,6 +44,7 @@ public static function init() {
                 'disable_search' => false,
                 'disable_xmlrpc' => false,
                 'feed_links' => true,
+                'heartbeat' => null,
                 'meta_generator' => true,
                 'script_attributes' => false,
                 'shortcodes' => false,
@@ -69,6 +70,13 @@ public static function init() {
                 'is_production' => defined( self::get_config( 'common_toolkit/environment_constant' ) ) ? self::get_config( 'common_toolkit/environment_production' ) == getenv( self::get_config( 'common_toolkit/environment_constant' ) ) : true
             ];
 
+            // Modify or disable WordPress heartbeat
+            if( self::get_config( 'common_toolkit/heartbeat' ) === false ) { // Disable heartbeat
+                add_action( 'init', function() { wp_deregister_script( 'heartbeat' ); }, 1 );
+            } else if( intval( self::get_config( 'common_toolkit/heartbeat' ) ) ) { // Modify heartbeat
+                add_action( 'heartbeat_settings', array( self::$instance, 'modify_heartbeat' ) );
+            }
+
             // Disable emoji support
             if( self::get_config( 'common_toolkit/disable_emojis' ) ) add_action( 'init', array( self::$instance, 'disable_emojis' ) );
 
@@ -366,6 +374,22 @@ public static function set_default_atts( $pairs, $atts ) {
 
     }
 
+    /*
+     * Modify the WordPress heartbeat
+     *
+     * @since 0.8.0
+     * @see https://codex.wordpress.org/Function_Reference/wp_heartbeat_settings
+     */
+    public function modify_heartbeat( $settings ) {
+
+        $heartbeat = intval( self::get_config( 'common_toolkit/heartbeat' ) );
+        if( !$heartbeat ) return $settings;
+
+        $settings['interval'] = $heartbeat;
+        return $settings;
+
+    }
+
     /*
      * Remove or modify meta generator tag.
      *

sample-config.json

@@ -8,6 +8,7 @@
                 "disable_search": false,
                 "disable_xmlrpc": false,
                 "feed_links": true,
+                "heartbeat": null,
                 "meta_generator": "Atari 2600",
                 "script_attributes": true,
                 "shortcodes": false,