Changeset 24819

Timestamp:

07/28/2013 08:55:53 PM (12 years ago)

Author:

azaozz

Message:

Add "experimental" to heartbeat phpdoc, fixes #24855 for 3.6.

Location:

branches/3.6

Files:

• wp-admin/includes/ajax-actions.php (modified) (3 diffs)
• wp-includes/js/heartbeat.js (modified) (2 diffs)

branches/3.6/wp-admin/includes/ajax-actions.php

@@ -9 +9 @@
 /*
  * No-privilege Ajax handlers.
+ */
+
+/**
+ * Heartbeat API (experimental)
+ *
+ * Runs when the user is not logged in.
  */
 function wp_ajax_nopriv_heartbeat() {
@@ -2053 +2059 @@
 }
 
+/**
+ * Heartbeat API (experimental)
+ *
+ * Runs when the user is logged in.
+ */
 function wp_ajax_heartbeat() {
     if ( empty( $_POST['_nonce'] ) )
@@ -2073 +2084 @@
     if ( ! empty($_POST['data']) ) {
         $data = (array) $_POST['data'];
-
-        // todo: separate filters: 'heartbeat_[action]' so we call different callbacks only when there is data for them,
-        // or all callbacks listen to one filter and run when there is something for them in $data?
         $response = apply_filters( 'heartbeat_received', $response, $data, $screen_id );
     }

branches/3.6/wp-includes/js/heartbeat.js

@@ -1 +1 @@
 /**
  * Heartbeat API
+ *
+ * Note: this API is "experimental" meaning it will likely change a lot
+ * in the next few releases based on feedback from 3.6.0. If you intend
+ * to use it, please follow the development closely.
  *
  * Heartbeat is a simple server polling API that sends XHR requests to
@@ -48 +52 @@
          *
          * @returns boolean
-         * @private
          */
         this.hasConnectionError = function() {