W3cubDocs

/WordPress

wp_check_post_lock( int $post_id )

Check to see if the post is currently being edited by another user.

Parameters

$post_id

(int) (Required) ID of the post to check for editing.

Return

(int|false) ID of the user with lock. False if the post does not exist, post is not locked, the user with lock does not exist, or the post is locked by current user.

Source

File: wp-admin/includes/post.php 

function wp_check_post_lock( $post_id ) {
	$post = get_post( $post_id );
	if ( ! $post ) {
		return false;
	}

	$lock = get_post_meta( $post->ID, '_edit_lock', true );
	if ( ! $lock ) {
		return false;
	}

	$lock = explode( ':', $lock );
	$time = $lock[0];
	$user = isset( $lock[1] ) ? $lock[1] : get_post_meta( $post->ID, '_edit_last', true );

	if ( ! get_userdata( $user ) ) {
		return false;
	}

	/** This filter is documented in wp-admin/includes/ajax-actions.php */
	$time_window = apply_filters( 'wp_check_post_lock_window', 150 );

	if ( $time && $time > time() - $time_window && get_current_user_id() != $user ) {
		return $user;
	}

	return false;
}

Uses

Uses Description
wp-admin/includes/ajax-actions.php: wp_check_post_lock_window

Filters the post lock window duration.
wp-includes/pluggable.php: get_userdata()

Retrieve user info by user ID.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/user.php: get_current_user_id()

Get the current user’s ID
wp-includes/post.php: get_post_meta()

Retrieves a post meta field for the given post ID.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.

Used By

Used By Description
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::check_changeset_lock_with_heartbeat()

Check locked changeset with heartbeat API.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::handle_changeset_trash_request()

Handle request to trash a changeset.
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::customize_pane_settings()

Print JavaScript settings for parent window.
wp-admin/includes/class-wp-posts-list-table.php: WP_Posts_List_Table::column_title()

Handles the title column output.
wp-admin/includes/revision.php: wp_print_revision_templates()

Print JavaScript templates required for the revisions experience.
wp-admin/includes/misc.php: wp_check_locked_posts()

Check lock status for posts displayed on the Posts screen
wp-admin/includes/misc.php: wp_refresh_post_lock()

Check lock status on the New/Edit Post screen and refresh the lock
wp-admin/includes/post.php: _admin_notice_post_locked()

Outputs the HTML for the notice to say that someone else is editing or has taken over editing of this post.
wp-admin/includes/post.php: post_preview()

Saves a draft or manually autosaves for the purpose of showing a post preview.
wp-admin/includes/post.php: wp_autosave()

Save a post submitted with XHR
wp-admin/includes/post.php: bulk_edit_posts()

Process the post data for the bulk editing of posts.
wp-admin/includes/ajax-actions.php: wp_ajax_inline_save()

Ajax handler for Quick Edit saving a post from a list table.
wp-admin/includes/class-wp-posts-list-table.php: WP_Posts_List_Table::single_row()
wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::save()

Handle customize_save WP Ajax request to save/update a changeset.

Changelog

Version Description
2.5.0 Introduced.

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