wp_set_post_lock( int $post_id )

Mark the post as currently being edited by the current user

Parameters

$post_id

(Required) ID of the post being edited.

Return

(array|false) Array of the lock time and user ID. False if the post does not exist, or there is no current user.

Source

File: wp-admin/includes/post.php 

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

	if ( 0 == ( $user_id = get_current_user_id() ) ) {
		return false;
	}

	$now = time();
	$lock = "$now:$user_id";

	update_post_meta( $post->ID, '_edit_lock', $lock );

	return array( $now, $user_id );
}

Expand Source Code View on GitHub

Related

Uses

Uses
Uses Description
wp-includes/user.php: get_current_user_id()

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

Update post meta field based on post ID.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.

Used By

Used By
Used By Description
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: edit_post()

Update an existing post with values provided in $_POST.
wp-admin/includes/post.php: wp_write_post()

Creates a new post from the “Write Post” form using $_POST information.

Changelog

Changelog
Version Description
WP-2.5.0 Introduced.