W3cubDocs

/WordPress

WP_Customize_Manager::check_changeset_lock_with_heartbeat( array $response, array $data, string $screen_id )

Check locked changeset with heartbeat API.

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-includes/class-wp-customize-manager.php 

public function check_changeset_lock_with_heartbeat( $response, $data, $screen_id ) {
		if ( isset( $data['changeset_uuid'] ) ) {
			$changeset_post_id = $this->find_changeset_post_id( $data['changeset_uuid'] );
		} else {
			$changeset_post_id = $this->changeset_post_id();
		}

		if (
			array_key_exists( 'check_changeset_lock', $data )
			&& 'customize' === $screen_id
			&& $changeset_post_id
			&& current_user_can( get_post_type_object( 'customize_changeset' )->cap->edit_post, $changeset_post_id )
		) {
			$lock_user_id = wp_check_post_lock( $changeset_post_id );

			if ( $lock_user_id ) {
				$response['customize_changeset_lock_user'] = $this->get_lock_user_data( $lock_user_id );
			} else {

				// Refreshing time will ensure that the user is sitting on customizer and has not closed the customizer tab.
				$this->refresh_changeset_lock( $changeset_post_id );
			}
		}

		return $response;
	}

Uses

Uses Description
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::get_lock_user_data()

Get lock user data.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::refresh_changeset_lock()

Refreshes changeset lock with the current time if current user edited the changeset before.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::find_changeset_post_id()

Find the changeset post ID for a given changeset UUID.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::changeset_post_id()

Get the changeset post ID for the loaded changeset.
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/post.php: get_post_type_object()

Retrieves a post type object by name.

Changelog

Version Description
4.9.0 Introduced.

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