Changeset 42720

Timestamp:

02/19/2018 09:45:03 PM (9 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct documentation for Heartbeat filters.

$response parameter is documented as an array or object, but only array is actually supported.

See #42777, #42505.

File:

• trunk/src/wp-admin/includes/ajax-actions.php (modified) (4 diffs)

trunk/src/wp-admin/includes/ajax-actions.php

@@ -38 +38 @@
                  * @since 3.6.0
                  *
-                 * @param array|object $response  The no-priv Heartbeat response object or array.
-                 * @param array        $data      An array of data passed via $_POST.
-                 * @param string       $screen_id The screen id.
+                 * @param array  $response  The no-priv Heartbeat response.
+                 * @param array  $data      The $_POST data sent.
+                 * @param string $screen_id The screen id.
                  */
                 $response = apply_filters( 'heartbeat_nopriv_received', $response, $data, $screen_id );
@@ -46 +46 @@
 
         /**
-         * Filters Heartbeat Ajax response when no data is passed.
+         * Filters Heartbeat Ajax response in no-privilege environments when no data is passed.
          *
          * @since 3.6.0
          *
-         * @param array|object $response  The Heartbeat response object or array.
-         * @param string       $screen_id The screen id.
+         * @param array  $response  The no-priv Heartbeat response.
+         * @param string $screen_id The screen id.
          */
         $response = apply_filters( 'heartbeat_nopriv_send', $response, $screen_id );
@@ -62 +62 @@
          * @since 3.6.0
          *
-         * @param array|object $response  The no-priv Heartbeat response.
-         * @param string       $screen_id The screen id.
+         * @param array  $response  The no-priv Heartbeat response.
+         * @param string $screen_id The screen id.
          */
         do_action( 'heartbeat_nopriv_tick', $response, $screen_id );
@@ -3027 +3027 @@
         if ( 1 !== $nonce_state ) {
                 /**
-                 * Filters the nonces to send to the editor.
+                 * Filters the nonces to send to the New/Edit Post screen.
                  *
                  * @since 4.3.0
                  *
-                 * @param array|object $response  The no-priv Heartbeat response object or array.
-                 * @param array        $data      An array of data passed via $_POST.
-                 * @param string       $screen_id The screen id.
+                 * @param array  $response  The Heartbeat response.
+                 * @param array  $data      The $_POST data sent.
+                 * @param string $screen_id The screen id.
                  */
                 $response = apply_filters( 'wp_refresh_nonces', $response, $data, $screen_id );