wppaste
WordPress

wp_set_post_lock( int|WP_Post $post ): array|false

Since
2.5.0
Source
wp-admin/includes/post.php:1760
Marks the post as currently being edited by the current user.

Compatibility

WordPress
since 2.5.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$postint|WP_Post
ID or object of the post being edited.

Return value

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

  • $0int

    The current time as a Unix timestamp.

  • $1int

    The ID of the current user.

Performance profile

How much work a call to wp_set_post_lock() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class
Heavy

Reaches the database via get_post().

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
7–26

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 28.

Plugin surface
None

Nothing here hands control to plugin code.

Called by
3

3 places in core call this, so the cost is paid more often than your own code shows.

What it touches

  • querycontent queryget_post()called directly

Further down the call graph this can also reach hook, serialize, cache, option and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 3 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_set_post_lock() can have, taken from its control-flow graph on PHP 8.5.

WhenInstructionsCalls it makes
always7get_post()
$user_id === 012get_post(), get_current_user_id()
$user_id !== 026get_post(), get_current_user_id(), time(), update_post_meta()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 28 instructions, 7–26 executed per call, 2 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 3

Used by · 3

  • edit_post()Updates an existing post with values provided in `$_POST`.
  • wp_refresh_post_lock()Checks lock status on the New/Edit Post screen and refresh the lock.
  • wp_write_post()Creates a new post from the "Write Post" form using `$_POST` information.

Source code

View on Trac View on GitHub 

function wp_set_post_lock( $post ) {	$post = get_post( $post ); 	if ( ! $post ) {		return false;	} 	$user_id = get_current_user_id(); 	if ( 0 === $user_id ) {		return false;	} 	$now  = time();	$lock = "$now:$user_id"; 	update_post_meta( $post->ID, '_edit_lock', $lock ); 	return array( $now, $user_id );}

Changelog

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.0.4 tag, from src/wp-admin/includes/post.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.