wp_refresh_post_lock( array $response, array $data, string $screen_id ): array
- Since
- 3.6.0
- Source
wp-admin/includes/misc.php:1189
Compatibility
- WordPress
- since 3.6.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
$responsearray- The Heartbeat response.
$dataarray- The $_POST data sent.
$screen_idstring- The screen ID.
Return value
array- The Heartbeat response.
Performance profile
How much work a call to wp_refresh_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
- Scaling
- Constant
- Instructions
- 6–66
- Plugin surface
- None
- Called by
- 0
Reaches the database via get_post().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 76.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- optionoption read or write
get_option()called directly - querycontent query
get_post()one call below wp_refresh_post_lock() - hookthird-party callbacks
apply_filters()one call below wp_refresh_post_lock() - cacheobject cache
wp_cache_get()one call below wp_refresh_post_lock() - serializeserialisation
maybe_unserialize()one call below wp_refresh_post_lock()
Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 6 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_refresh_post_lock() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!$data | 6 | none |
$data | 15 | absint() |
$data && !current_user_can() | 20 | absint(), current_user_can() |
$data && current_user_can() | 36–39 | absint(), current_user_can(), wp_check_post_lock(), get_userdata(), wp_set_post_lock() |
$data && current_user_can() && !get_option() | 50 | absint(), current_user_can(), wp_check_post_lock(), get_userdata(), __(), sprintf(), get_option() |
$data && current_user_can() && get_option() | 66 | absint(), current_user_can(), wp_check_post_lock(), get_userdata(), __(), sprintf(), get_option(), get_avatar_url(), get_avatar_url() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 76 | 6–66 | 6 | |
| 8.5 | 76 | 6–66 | 6 | |
| 8.4 | 76 | 6–66 | 6 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 79 | 6–66 | 6 | |
| 8.2 | 79 | 6–66 | 6 | |
| 8.1 | 79 | 6–66 | 6 | |
| 7.4 | 79 | 6–66 | 6 |
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 · 8
- absint()Converts a value to non-negative integer.
- current_user_can()Returns whether the current user has the specified capability.
- wp_check_post_lock()Determines whether the post is currently being edited by another user.
- get_userdata()Retrieves user info by user ID.
- __()Retrieves the translation of $text.
- get_option()Retrieves an option value based on an option name.
- get_avatar_url()Retrieves the avatar URL.
- wp_set_post_lock()Marks the post as currently being edited by the current user.
Source code
function wp_refresh_post_lock( $response, $data, $screen_id ) { if ( array_key_exists( 'wp-refresh-post-lock', $data ) ) { $received = $data['wp-refresh-post-lock']; $send = array(); $post_id = absint( $received['post_id'] ); if ( ! $post_id ) { return $response; } if ( ! current_user_can( 'edit_post', $post_id ) ) { return $response; } $user_id = wp_check_post_lock( $post_id ); $user = get_userdata( $user_id ); if ( $user ) { $error = array( 'name' => $user->display_name, /* translators: %s: User's display name. */ 'text' => sprintf( __( '%s has taken over and is currently editing.' ), $user->display_name ), ); if ( get_option( 'show_avatars' ) ) { $error['avatar_src'] = get_avatar_url( $user->ID, array( 'size' => 64 ) ); $error['avatar_src_2x'] = get_avatar_url( $user->ID, array( 'size' => 128 ) ); } $send['lock_error'] = $error; } else { $new_lock = wp_set_post_lock( $post_id ); if ( $new_lock ) { $send['new_lock'] = implode( ':', $new_lock ); } } $response['wp-refresh-post-lock'] = $send; } return $response;}Changelog
Introduced in 3.6.0. Unchanged from 6.7.7 through 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/misc.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.