WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

wp_check_post_lock()

wp_check_post_lock( int|WP_Post $post ): int|false

In this article

Back to top

Determines whether the post is currently being edited by another user.

Parameters

$postint|WP_Postrequired
ID or object 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

function wp_check_post_lock( $post ) {	$post = get_post( $post );	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] ) ? (int) $lock[1] : (int) 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; }

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘wp_check_post_lock_window’, int $interval )

Filters the post lock window duration.

UsesDescription
get_userdata()wp-includes/pluggable.php

Retrieves user info by user ID.

apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

get_current_user_id()wp-includes/user.php

Gets the current user’s ID.

get_post_meta()wp-includes/post.php

Retrieves a post meta field for the given post ID.

get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

Show 3 moreShow less
Used byDescription
WP_REST_Autosaves_Controller::create_item()wp-includes/rest-api/endpoints/class-wp-rest-autosaves-controller.php

Creates, updates or deletes an autosave revision.

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

Checks locked changeset with heartbeat API.

WP_Customize_Manager::handle_changeset_trash_request()wp-includes/class-wp-customize-manager.php

Handles request to trash a changeset.

WP_Customize_Manager::customize_pane_settings()wp-includes/class-wp-customize-manager.php

Prints JavaScript settings for parent window.

WP_Posts_List_Table::column_title()wp-admin/includes/class-wp-posts-list-table.php

Handles the title column output.

wp_print_revision_templates()wp-admin/includes/revision.php

Print JavaScript templates required for the revisions experience.

wp_check_locked_posts()wp-admin/includes/misc.php

Checks lock status for posts displayed on the Posts screen.

wp_refresh_post_lock()wp-admin/includes/misc.php

Checks lock status on the New/Edit Post screen and refresh the lock.

_admin_notice_post_locked()wp-admin/includes/post.php

Outputs the HTML for the notice to say that someone else is editing or has taken over editing of this post.

post_preview()wp-admin/includes/post.php

Saves a draft or manually autosaves for the purpose of showing a post preview.

wp_autosave()wp-admin/includes/post.php

Saves a post submitted with XHR.

bulk_edit_posts()wp-admin/includes/post.php

Processes the post data for the bulk editing of posts.

wp_ajax_inline_save()wp-admin/includes/ajax-actions.php

Handles Quick Edit saving a post from a list table via AJAX.

WP_Posts_List_Table::single_row()wp-admin/includes/class-wp-posts-list-table.php
WP_Customize_Manager::save()wp-includes/class-wp-customize-manager.php

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

Show 10 moreShow less

Changelog

VersionDescription
2.5.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.