Changeset 36231

Timestamp:

01/09/2016 01:36:45 AM (9 years ago)

Author:

johnbillion

Message:

Docs: Correct the parameter docs for various Heartbeat filters and functions.

See #32246

Location:

trunk/src/wp-admin/includes

Files:

• ajax-actions.php (modified) (3 diffs)
• misc.php (modified) (4 diffs)

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

@@ -2707 +2707 @@
          * @since 3.6.0
          *
-         * @param array|object $response  The Heartbeat response object or array.
-         * @param array        $data      The $_POST data sent.
-         * @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( 'heartbeat_received', $response, $data, $screen_id );
@@ -2719 +2719 @@
      * @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 Heartbeat response.
+     * @param string $screen_id The screen id.
      */
     $response = apply_filters( 'heartbeat_send', $response, $screen_id );
@@ -2731 +2731 @@
      * @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 Heartbeat response.
+     * @param string $screen_id The screen id.
      */
     do_action( 'heartbeat_tick', $response, $screen_id );

trunk/src/wp-admin/includes/misc.php

@@ -730 +730 @@
  *
  * @since 3.6.0
+ *
+ * @param array  $response  The Heartbeat response.
+ * @param array  $data      The $_POST data sent.
+ * @param string $screen_id The screen id.
+ * @return array The Heartbeat response.
  */
 function wp_check_locked_posts( $response, $data, $screen_id ) {
@@ -760 +765 @@
  *
  * @since 3.6.0
+ *
+ * @param array  $response  The Heartbeat response.
+ * @param array  $data      The $_POST data sent.
+ * @param string $screen_id The screen id.
+ * @return array The Heartbeat response.
  */
 function wp_refresh_post_lock( $response, $data, $screen_id ) {
@@ -798 +808 @@
  *
  * @since 3.6.0
+ *
+ * @param array  $response  The Heartbeat response.
+ * @param array  $data      The $_POST data sent.
+ * @param string $screen_id The screen id.
+ * @return array The Heartbeat response.
  */
 function wp_refresh_post_nonces( $response, $data, $screen_id ) {
@@ -851 +866 @@
  *
  * @since 3.9.0
+ *
+ * @param array $response The Heartbeat response.
+ * @param array $data     The $_POST data sent.
+ * @return array The Heartbeat response.
  */
 function heartbeat_autosave( $response, $data ) {