W3cubDocs

/WordPress

wp_check_locked_posts( array $response, array $data, string $screen_id )

Check lock status for posts displayed on the Posts screen

Parameters

$response

(array) (Required) The Heartbeat response.

$data

(array) (Required) The $_POST data sent.

$screen_id

(string) (Required) The screen ID.

Return

(array) The Heartbeat response.

Source

File: wp-admin/includes/misc.php 

function wp_check_locked_posts( $response, $data, $screen_id ) {
	$checked = array();

	if ( array_key_exists( 'wp-check-locked-posts', $data ) && is_array( $data['wp-check-locked-posts'] ) ) {
		foreach ( $data['wp-check-locked-posts'] as $key ) {
			$post_id = absint( substr( $key, 5 ) );
			if ( ! $post_id ) {
				continue;
			}

			$user_id = wp_check_post_lock( $post_id );
			if ( $user_id ) {
				$user = get_userdata( $user_id );
				if ( $user && current_user_can( 'edit_post', $post_id ) ) {
					$send = array(
						/* translators: %s: User's display name. */
						'text' => sprintf( __( '%s is currently editing' ), $user->display_name ),
					);

					if ( get_option( 'show_avatars' ) ) {
						$send['avatar_src']    = get_avatar_url( $user->ID, array( 'size' => 18 ) );
						$send['avatar_src_2x'] = get_avatar_url( $user->ID, array( 'size' => 36 ) );
					}

					$checked[ $key ] = $send;
				}
			}
		}
	}

	if ( ! empty( $checked ) ) {
		$response['wp-check-locked-posts'] = $checked;
	}

	return $response;
}

Uses

Uses Description
wp-includes/link-template.php: get_avatar_url()

Retrieves the avatar URL.
wp-admin/includes/post.php: wp_check_post_lock()

Check to see if the post is currently being edited by another user.
wp-includes/capabilities.php: current_user_can()

Returns whether the current user has the specified capability.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/pluggable.php: get_userdata()

Retrieve user info by user ID.
wp-includes/functions.php: absint()

Convert a value to non-negative integer.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.

Changelog

Version Description
3.6.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_check_locked_posts