<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[42389] trunk/src/wp-includes/js/heartbeat.js: Docs: Improve JS Docs for `wp-includes/js/heartbeat.js`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/42389">42389</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/42389","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>atimmer</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-12-12 14:32:33 +0000 (Tue, 12 Dec 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Improve JS Docs for `wp-includes/js/heartbeat.js`.
Most of the documentation was already present. This change achieves the following:
* Fixes the formatting for most doc blocks.
* Adds `@since` tags to all functions.
* Makes sure the heartbeat public methods are correctly added to the `wp.heartbeat` namespace.
Props andizer, jjcomack, carolinegeven.
Fixes <a href="https://core.trac.wordpress.org/ticket/42675">#42675</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesjsheartbeatjs">trunk/src/wp-includes/js/heartbeat.js</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesjsheartbeatjs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/js/heartbeat.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/js/heartbeat.js 2017-12-12 05:42:12 UTC (rev 42388)
+++ trunk/src/wp-includes/js/heartbeat.js 2017-12-12 14:32:33 UTC (rev 42389)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -27,73 +27,89 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> ( function( $, window, undefined ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Constructs the Heartbeat API.
+ *
+ * @since 3.6.0
+ *
+ * @returns {Object} An instance of the Heartbeat class.
+ * @constructor
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> var Heartbeat = function() {
</span><span class="cx" style="display: block; padding: 0 10px"> var $document = $(document),
</span><span class="cx" style="display: block; padding: 0 10px"> settings = {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Suspend/resume
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Suspend/resume.
</ins><span class="cx" style="display: block; padding: 0 10px"> suspend: false,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Whether suspending is enabled
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Whether suspending is enabled.
</ins><span class="cx" style="display: block; padding: 0 10px"> suspendEnabled: true,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Current screen id, defaults to the JS global 'pagenow' when present (in the admin) or 'front'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Current screen id, defaults to the JS global 'pagenow' when present
+ // (in the admin) or 'front'.
</ins><span class="cx" style="display: block; padding: 0 10px"> screenId: '',
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // XHR request URL, defaults to the JS global 'ajaxurl' when present
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // XHR request URL, defaults to the JS global 'ajaxurl' when present.
</ins><span class="cx" style="display: block; padding: 0 10px"> url: '',
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Timestamp, start of the last connection request
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Timestamp, start of the last connection request.
</ins><span class="cx" style="display: block; padding: 0 10px"> lastTick: 0,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Container for the enqueued items
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Container for the enqueued items.
</ins><span class="cx" style="display: block; padding: 0 10px"> queue: {},
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Connect interval (in seconds)
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Connect interval (in seconds).
</ins><span class="cx" style="display: block; padding: 0 10px"> mainInterval: 60,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Used when the interval is set to 5 sec. temporarily
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Used when the interval is set to 5 sec. temporarily.
</ins><span class="cx" style="display: block; padding: 0 10px"> tempInterval: 0,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Used when the interval is reset
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Used when the interval is reset.
</ins><span class="cx" style="display: block; padding: 0 10px"> originalInterval: 0,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Used to limit the number of AJAX requests.
</span><span class="cx" style="display: block; padding: 0 10px"> minimalInterval: 0,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Used together with tempInterval
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Used together with tempInterval.
</ins><span class="cx" style="display: block; padding: 0 10px"> countdown: 0,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Whether a connection is currently in progress
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Whether a connection is currently in progress.
</ins><span class="cx" style="display: block; padding: 0 10px"> connecting: false,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Whether a connection error occurred
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Whether a connection error occurred.
</ins><span class="cx" style="display: block; padding: 0 10px"> connectionError: false,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Used to track non-critical errors
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Used to track non-critical errors.
</ins><span class="cx" style="display: block; padding: 0 10px"> errorcount: 0,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Whether at least one connection has completed successfully
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Whether at least one connection has been completed successfully.
</ins><span class="cx" style="display: block; padding: 0 10px"> hasConnected: false,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Whether the current browser window is in focus and the user is active
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Whether the current browser window is in focus and the user is active.
</ins><span class="cx" style="display: block; padding: 0 10px"> hasFocus: true,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Timestamp, last time the user was active. Checked every 30 sec.
</span><span class="cx" style="display: block; padding: 0 10px"> userActivity: 0,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Flags whether events tracking user activity were set
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Flag whether events tracking user activity were set.
</ins><span class="cx" style="display: block; padding: 0 10px"> userActivityEvents: false,
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Timer that keeps track of how long a user has focus.
</ins><span class="cx" style="display: block; padding: 0 10px"> checkFocusTimer: 0,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Timer that keeps track of how long needs to be waited before connecting to
+ // the server again.
</ins><span class="cx" style="display: block; padding: 0 10px"> beatTimer: 0
</span><span class="cx" style="display: block; padding: 0 10px"> };
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Set local vars and events, then start
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sets local variables and events, then starts the heartbeat.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.8.0
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function initialize() {
</span><span class="cx" style="display: block; padding: 0 10px"> var options, hidden, visibilityState, visibilitychange;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -106,17 +122,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> settings.url = window.ajaxurl;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Pull in options passed from PHP
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Pull in options passed from PHP.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( typeof window.heartbeatSettings === 'object' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> options = window.heartbeatSettings;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // The XHR URL can be passed as option when window.ajaxurl is not set
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // The XHR URL can be passed as option when window.ajaxurl is not set.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! settings.url && options.ajaxurl ) {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.url = options.ajaxurl;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // The interval can be from 15 to 120 sec. and can be set temporarily to 5 sec.
- // It can be set in the initial options or changed later from JS and/or from PHP.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * The interval can be from 15 to 120 sec. and can be set temporarily to 5 sec.
+ * It can be set in the initial options or changed later through JS and/or
+ * through PHP.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( options.interval ) {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.mainInterval = options.interval;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -127,11 +146,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Used to limit the number of AJAX requests. Overrides all other intervals if they are shorter.
- // Needed for some hosts that cannot handle frequent requests and the user may exceed the allocated server CPU time, etc.
- // The minimal interval can be up to 600 sec. however setting it to longer than 120 sec. will limit or disable
- // some of the functionality (like post locks).
- // Once set at initialization, minimalInterval cannot be changed/overridden.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Used to limit the number of AJAX requests. Overrides all other intervals if
+ * they are shorter. Needed for some hosts that cannot handle frequent requests
+ * and the user may exceed the allocated server CPU time, etc. The minimal
+ * interval can be up to 600 sec. however setting it to longer than 120 sec.
+ * will limit or disable some of the functionality (like post locks). Once set
+ * at initialization, minimalInterval cannot be changed/overridden.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( options.minimalInterval ) {
</span><span class="cx" style="display: block; padding: 0 10px"> options.minimalInterval = parseInt( options.minimalInterval, 10 );
</span><span class="cx" style="display: block; padding: 0 10px"> settings.minimalInterval = options.minimalInterval > 0 && options.minimalInterval <= 600 ? options.minimalInterval * 1000 : 0;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -141,7 +163,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> settings.mainInterval = settings.minimalInterval;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // 'screenId' can be added from settings on the front end where the JS global 'pagenow' is not set
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // 'screenId' can be added from settings on the front end where the JS global
+ // 'pagenow' is not set.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! settings.screenId ) {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.screenId = options.screenId || 'front';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -151,13 +174,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Convert to milliseconds
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Convert to milliseconds.
</ins><span class="cx" style="display: block; padding: 0 10px"> settings.mainInterval = settings.mainInterval * 1000;
</span><span class="cx" style="display: block; padding: 0 10px"> settings.originalInterval = settings.mainInterval;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Switch the interval to 120 sec. by using the Page Visibility API.
- // If the browser doesn't support it (Safari < 7, Android < 4.4, IE < 10), the interval
- // will be increased to 120 sec. after 5 min. of mouse and keyboard inactivity.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Switch the interval to 120 seconds by using the Page Visibility API.
+ * If the browser doesn't support it (Safari < 7, Android < 4.4, IE < 10), the
+ * interval will be increased to 120 seconds after 5 minutes of mouse and keyboard
+ * inactivity.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( typeof document.hidden !== 'undefined' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> hidden = 'hidden';
</span><span class="cx" style="display: block; padding: 0 10px"> visibilitychange = 'visibilitychange';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -196,10 +222,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $(window).on( 'unload.wp-heartbeat', function() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Don't connect any more
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Don't connect anymore.
</ins><span class="cx" style="display: block; padding: 0 10px"> settings.suspend = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Abort the last request if not completed
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Abort the last request if not completed.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( settings.xhr && settings.xhr.readyState !== 4 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.xhr.abort();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -208,7 +234,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Check for user activity every 30 seconds.
</span><span class="cx" style="display: block; padding: 0 10px"> window.setInterval( checkUserActivity, 30000 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Start one tick after DOM ready
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Start one tick after DOM ready.
</ins><span class="cx" style="display: block; padding: 0 10px"> $document.ready( function() {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.lastTick = time();
</span><span class="cx" style="display: block; padding: 0 10px"> scheduleNextTick();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -216,28 +242,34 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Return the current time according to the browser
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Returns the current time according to the browser.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return int
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.6.0
+ *
+ * @returns {number} Returns the current time.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function time() {
</span><span class="cx" style="display: block; padding: 0 10px"> return (new Date()).getTime();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if the iframe is from the same origin
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if the iframe is from the same origin.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.6.0
+ *
+ * @returns {boolean} Returns whether or not the iframe is from the same origin.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function isLocalFrame( frame ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var origin, src = frame.src;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Need to compare strings as WebKit doesn't throw JS errors when iframes have different origin.
- // It throws uncatchable exceptions.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * Need to compare strings as WebKit doesn't throw JS errors when iframes have
+ * different origin. It throws uncatchable exceptions.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( src && /^https?:\/\//.test( src ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> origin = window.location.origin ? window.location.origin : window.location.protocol + '//' + window.location.host;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -256,11 +288,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if the document's focus has changed
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if the document's focus has changed.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.1.0
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function checkFocus() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( settings.hasFocus && ! document.hasFocus() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -271,13 +305,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Set error state and fire an event on XHR errors or timeout
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sets error state and fires an event on XHR errors or timeout.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string error The error type passed from the XHR
- * @param int status The HTTP status code passed from jqXHR (200, 404, 500, etc.)
- * @return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.8.0
+ *
+ * @param {string} error The error type passed from the XHR.
+ * @param {number} status The HTTP status code passed from jqXHR
+ * (200, 404, 500, etc.).
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function setErrorState( error, status ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var trigger;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -285,10 +323,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( error ) {
</span><span class="cx" style="display: block; padding: 0 10px"> switch ( error ) {
</span><span class="cx" style="display: block; padding: 0 10px"> case 'abort':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // do nothing
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Do nothing.
</ins><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> case 'timeout':
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // no response for 30 sec.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // No response for 30 sec.
</ins><span class="cx" style="display: block; padding: 0 10px"> trigger = true;
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> case 'error':
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -317,14 +355,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Clear the error state and fire an event
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Clears the error state and fires an event if there is a connection error.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.8.0
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function clearErrorState() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Has connected successfully
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Has connected successfully.
</ins><span class="cx" style="display: block; padding: 0 10px"> settings.hasConnected = true;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( hasConnectionError() ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -335,11 +375,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Gather the data and connect to the server
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gathers the data and connects to the server.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.6.0
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function connect() {
</span><span class="cx" style="display: block; padding: 0 10px"> var ajaxData, heartbeatData;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -353,7 +395,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> settings.lastTick = time();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> heartbeatData = $.extend( {}, settings.queue );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Clear the data queue, anything added after this point will be send on the next tick
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Clear the data queue. Anything added after this point will be sent on the next tick.
</ins><span class="cx" style="display: block; padding: 0 10px"> settings.queue = {};
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $document.trigger( 'heartbeat-send', [ heartbeatData ] );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -403,7 +445,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $document.trigger( 'heartbeat-tick', [response, textStatus, jqXHR] );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Do this last, can trigger the next XHR if connection time > 5 sec. and newInterval == 'fast'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Do this last. Can trigger the next XHR if connection time > 5 sec. and newInterval == 'fast'.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( newInterval ) {
</span><span class="cx" style="display: block; padding: 0 10px"> interval( newInterval );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -414,13 +456,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Schedule the next connection
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Schedules the next connection.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires immediately if the connection time is longer than the interval.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.8.0
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function scheduleNextTick() {
</span><span class="cx" style="display: block; padding: 0 10px"> var delta = time() - settings.lastTick,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -460,22 +504,26 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Set the internal state when the browser window becomes hidden or loses focus
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sets the internal state when the browser window becomes hidden or loses focus.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.6.0
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function blurred() {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.hasFocus = false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Set the internal state when the browser window becomes visible or is in focus
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sets the internal state when the browser window becomes visible or is in focus.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.6.0
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function focused() {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.userActivity = time();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -490,11 +538,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Runs when the user becomes active after a period of inactivity
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Runs when the user becomes active after a period of inactivity.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.6.0
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function userIsActive() {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.userActivityEvents = false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -510,16 +560,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check for user activity
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks for user activity.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Runs every 30 sec.
- * Sets 'hasFocus = true' if user is active and the window is in the background.
- * Set 'hasFocus = false' if the user has been inactive (no mouse or keyboard activity)
- * for 5 min. even when the window has focus.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Runs every 30 sec. Sets 'hasFocus = true' if user is active and the window is
+ * in the background. Sets 'hasFocus = false' if the user has been inactive
+ * (no mouse or keyboard activity) for 5 min. even when the window has focus.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.8.0
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function checkUserActivity() {
</span><span class="cx" style="display: block; padding: 0 10px"> var lastActive = settings.userActivity ? time() - settings.userActivity : 0;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -552,33 +603,45 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Public methods
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Public methods.
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Whether the window (or any local iframe in it) has focus, or the user is active
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks whether the window (or any local iframe in it) has focus, or the user
+ * is active.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.6.0
+ * @memberOf wp.heartbeat.prototype
+ *
+ * @returns {boolean} True if the window or the user is active.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function hasFocus() {
</span><span class="cx" style="display: block; padding: 0 10px"> return settings.hasFocus;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Whether there is a connection error
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks whether there is a connection error.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.6.0
+ *
+ * @memberOf wp.heartbeat.prototype
+ *
+ * @returns {boolean} True if a connection error was found.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function hasConnectionError() {
</span><span class="cx" style="display: block; padding: 0 10px"> return settings.connectionError;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Connect asap regardless of 'hasFocus'
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Connects as soon as possible regardless of 'hasFocus' state.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Will not open two concurrent connections. If a connection is in progress,
</span><span class="cx" style="display: block; padding: 0 10px"> * will connect again immediately after the current connection completes.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.8.0
+ *
+ * @memberOf wp.heartbeat.prototype
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function connectNow() {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.lastTick = 0;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -586,28 +649,41 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Disable suspending
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Disables suspending.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Should be used only when Heartbeat is performing critical tasks like autosave, post-locking, etc.
- * Using this on many screens may overload the user's hosting account if several
- * browser windows/tabs are left open for a long time.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Should be used only when Heartbeat is performing critical tasks like
+ * autosave, post-locking, etc. Using this on many screens may overload the
+ * user's hosting account if several browser windows/tabs are left open for a
+ * long time.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.8.0
+ *
+ * @memberOf wp.heartbeat.prototype
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function disableSuspend() {
</span><span class="cx" style="display: block; padding: 0 10px"> settings.suspendEnabled = false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Get/Set the interval
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets/Sets the interval.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * When setting to 'fast' or 5, by default interval is 5 sec. for the next 30 ticks (for 2 min and 30 sec).
- * In this case the number of 'ticks' can be passed as second argument.
- * If the window doesn't have focus, the interval slows down to 2 min.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * When setting to 'fast' or 5, the interval is 5 seconds for the next 30 ticks
+ * (for 2 minutes and 30 seconds) by default. In this case the number of 'ticks'
+ * can be passed as second argument. If the window doesn't have focus, the
+ * interval slows down to 2 min.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed speed Interval: 'fast' or 5, 15, 30, 60, 120
- * @param string ticks Used with speed = 'fast' or 5, how many ticks before the interval reverts back
- * @return int Current interval in seconds
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.6.0
+ *
+ * @memberOf wp.heartbeat.prototype
+ *
+ * @param {string|number} speed Interval: 'fast' or 5, 15, 30, 60, 120. Fast
+ * equals 5.
+ * @param {string} ticks Tells how many ticks before the interval reverts
+ * back. Used with speed = 'fast' or 5.
+ *
+ * @returns {number} Current interval in seconds.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function interval( speed, ticks ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var newInterval,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -667,20 +743,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Enqueue data to send with the next XHR
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Enqueues data to send with the next XHR.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * As the data is send asynchronously, this function doesn't return the XHR response.
- * To see the response, use the custom jQuery event 'heartbeat-tick' on the document, example:
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * As the data is send asynchronously, this function doesn't return the XHR
+ * response. To see the response, use the custom jQuery event 'heartbeat-tick'
+ * on the document, example:
</ins><span class="cx" style="display: block; padding: 0 10px"> * $(document).on( 'heartbeat-tick.myname', function( event, data, textStatus, jqXHR ) {
</span><span class="cx" style="display: block; padding: 0 10px"> * // code
</span><span class="cx" style="display: block; padding: 0 10px"> * });
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * If the same 'handle' is used more than once, the data is not overwritten when the third argument is 'true'.
- * Use wp.heartbeat.isQueued('handle') to see if any data is already queued for that handle.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * If the same 'handle' is used more than once, the data is not overwritten when
+ * the third argument is 'true'. Use `wp.heartbeat.isQueued('handle')` to see if
+ * any data is already queued for that handle.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * $param string handle Unique handle for the data. The handle is used in PHP to receive the data.
- * $param mixed data The data to send.
- * $param bool noOverwrite Whether to overwrite existing data in the queue.
- * $return bool Whether the data was queued or not.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.6.0
+ *
+ * @memberOf wp.heartbeat.prototype
+ *
+ * @param {string} handle Unique handle for the data, used in PHP to
+ * receive the data.
+ * @param {*} data The data to send.
+ * @param {boolean} noOverwrite Whether to overwrite existing data in the queue.
+ *
+ * @returns {boolean} True if the data was queued.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function enqueue( handle, data, noOverwrite ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( handle ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -695,10 +779,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if data with a particular handle is queued
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if data with a particular handle is queued.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * $param string handle The handle for the data
- * $return bool Whether some data is queued with this handle
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.6.0
+ *
+ * @param {string} handle The handle for the data.
+ *
+ * @returns {boolean} True if the data is queued with this handle.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function isQueued( handle ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( handle ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -707,10 +794,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Remove data with a particular handle from the queue
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Removes data with a particular handle from the queue.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * $param string handle The handle for the data
- * $return void
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.7.0
+ *
+ * @memberOf wp.heartbeat.prototype
+ *
+ * @param {string} handle The handle for the data.
+ *
+ * @returns {void}
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function dequeue( handle ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( handle ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -719,10 +811,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Get data that was enqueued with a particular handle
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets data that was enqueued with a particular handle.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * $param string handle The handle for the data
- * $return mixed The data or undefined
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 3.7.0
+ *
+ * @memberOf wp.heartbeat.prototype
+ *
+ * @param {string} handle The handle for the data.
+ *
+ * @returns {*} The data or undefined.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function getQueuedItem( handle ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( handle ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -732,7 +829,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> initialize();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Expose public methods
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Expose public methods.
</ins><span class="cx" style="display: block; padding: 0 10px"> return {
</span><span class="cx" style="display: block; padding: 0 10px"> hasFocus: hasFocus,
</span><span class="cx" style="display: block; padding: 0 10px"> connectNow: connectNow,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -752,6 +849,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @namespace wp
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> window.wp = window.wp || {};
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Contains the Heartbeat API.
+ *
+ * @namespace wp.heartbeat
+ * @type {Heartbeat}
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> window.wp.heartbeat = new Heartbeat();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> }( jQuery, window ));
</span></span></pre>
</div>
</div>
</body>
</html>