sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source 
See #32246


git-svn-id: https://develop.svn.wordpress.org/trunk@36231 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
John Blackbourn 2016-01-09 01:36:45 +00:00
parent 5b2c1a52cc
commit aaa61e80e4
2 changed files with 26 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/wp-admin/includes/ajax-actions.php
View File

@ -2706,7 +2706,7 @@ function wp_ajax_heartbeat() {
* *
* @since 3.6.0 * @since 3.6.0
* *
* @param array|object $response The Heartbeat response object or array. * @param array $response The Heartbeat response.
* @param array $data The $_POST data sent. * @param array $data The $_POST data sent.
* @param string $screen_id The screen id. * @param string $screen_id The screen id.
*/ */
@ -2718,7 +2718,7 @@ function wp_ajax_heartbeat() {
* *
* @since 3.6.0 * @since 3.6.0
* *
* @param array|object $response The Heartbeat response object or array. * @param array $response The Heartbeat response.
* @param string $screen_id The screen id. * @param string $screen_id The screen id.
*/ */
$response = apply_filters( 'heartbeat_send', $response, $screen_id ); $response = apply_filters( 'heartbeat_send', $response, $screen_id );
@ -2730,7 +2730,7 @@ function wp_ajax_heartbeat() {
* *
* @since 3.6.0 * @since 3.6.0
* *
* @param array|object $response The Heartbeat response object or array. * @param array $response The Heartbeat response.
* @param string $screen_id The screen id. * @param string $screen_id The screen id.
*/ */
do_action( 'heartbeat_tick', $response, $screen_id ); do_action( 'heartbeat_tick', $response, $screen_id );

19
src/wp-admin/includes/misc.php
View File

@ -729,6 +729,11 @@ function _ipad_meta() {
* Check lock status for posts displayed on the Posts screen * Check lock status for posts displayed on the Posts screen
* *
* @since 3.6.0 * @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 ) { function wp_check_locked_posts( $response, $data, $screen_id ) {
$checked = array(); $checked = array();
@ -759,6 +764,11 @@ function wp_check_locked_posts( $response, $data, $screen_id ) {
* Check lock status on the New/Edit Post screen and refresh the lock * Check lock status on the New/Edit Post screen and refresh the lock
* *
* @since 3.6.0 * @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 ) { function wp_refresh_post_lock( $response, $data, $screen_id ) {
if ( array_key_exists( 'wp-refresh-post-lock', $data ) ) { if ( array_key_exists( 'wp-refresh-post-lock', $data ) ) {
@ -797,6 +807,11 @@ function wp_refresh_post_lock( $response, $data, $screen_id ) {
* Check nonce expiration on the New/Edit Post screen and refresh if needed * Check nonce expiration on the New/Edit Post screen and refresh if needed
* *
* @since 3.6.0 * @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 ) { function wp_refresh_post_nonces( $response, $data, $screen_id ) {
if ( array_key_exists( 'wp-refresh-post-nonces', $data ) ) { if ( array_key_exists( 'wp-refresh-post-nonces', $data ) ) {
@ -850,6 +865,10 @@ function wp_heartbeat_set_suspension( $settings ) {
* Autosave with heartbeat * Autosave with heartbeat
* *
* @since 3.9.0 * @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 ) { function heartbeat_autosave( $response, $data ) {
if ( ! empty( $data['wp_autosave'] ) ) { if ( ! empty( $data['wp_autosave'] ) ) {