_admin_notice_post_locked()

Compatibility

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

Performance profile

How much work a call to _admin_notice_post_locked() 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

65–195

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

Plugin surface

4 hooks

Third-party callbacks on 'show_post_locked_dialog', 'override_post_lock', 'post_locked_dialog' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly
• optionoption read or writeget_option()one call below _admin_notice_post_locked()

Further down the call graph this can also reach cache, serialize 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 · 53 distinct outcomes

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

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 4

4 hooks fire while _admin_notice_post_locked() runs, in this order:

1. 1
   apply_filters( show_post_locked_dialog )filterline 1812 (+26 into the body)

   Filters whether to show the post locked dialog.

2. 2
   apply_filters( override_post_lock )filterline 1871 (+85 into the body)

   Filters whether to allow the post lock to be overridden.

3. 3
   do_action( post_locked_dialog )actionline 1898 (+112 into the body)

   Fires inside the post locked dialog before the buttons are displayed.

4. 4
   do_action( post_lock_lost_dialog )actionline 1935 (+149 into the body)

   Fires inside the dialog displayed when a user has lost the post lock.

Uses · 20

• get_post()Retrieves post data given a post ID or post object.
• wp_check_post_lock()Determines whether the post is currently being edited by another user.
• get_userdata()Retrieves user info by user ID.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• wp_get_referer()Retrieves referer from '_wp_http_referer' or HTTP referer.
• __()Retrieves the translation of $text.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• admin_url()Retrieves the URL to the admin area for the current site.
• add_query_arg()Retrieves a modified URL query string.
• get_post_type_object()Retrieves a post type object by name.
• wp_create_nonce()Creates a cryptographic token tied to a specific action, user, user session, and window of time.
• get_preview_post_link()Retrieves the URL used for the post preview.

Source code

View on Trac ↗View on GitHub ↗

1786function _admin_notice_post_locked() {1787	$post = get_post();1788 1789	if ( ! $post ) {1790		return;1791	}1792 1793	$user    = null;1794	$user_id = wp_check_post_lock( $post->ID );1795 1796	if ( $user_id ) {1797		$user = get_userdata( $user_id );1798	}1799 1800	if ( $user ) {1801		/**1802		 * Filters whether to show the post locked dialog.1803		 *1804		 * Returning false from the filter will prevent the dialog from being displayed.1805		 *1806		 * @since 3.6.01807		 *1808		 * @param bool    $display Whether to display the dialog. Default true.1809		 * @param WP_Post $post    Post object.1810		 * @param WP_User $user    The user with the lock for the post.1811		 */1812		if ( ! apply_filters( 'show_post_locked_dialog', true, $post, $user ) ) {1813			return;1814		}1815 1816		$locked = true;1817	} else {1818		$locked = false;1819	}1820 1821	$sendback      = wp_get_referer();1822	$sendback_text = __( 'Go back' );1823 1824	if ( ! $locked || ! $sendback || str_contains( $sendback, 'post.php' ) || str_contains( $sendback, 'post-new.php' ) ) {1825		$sendback = admin_url( 'edit.php' );1826 1827		if ( 'post' !== $post->post_type ) {1828			$sendback = add_query_arg( 'post_type', $post->post_type, $sendback );1829		}1830 1831		$post_type_object = get_post_type_object( $post->post_type );1832 1833		if ( $post_type_object ) {1834			$sendback_text = $post_type_object->labels->all_items;1835		}1836	}1837 1838	$hidden = $locked ? '' : ' hidden';1839 1840	?>1841	<div id="post-lock-dialog" class="notification-dialog-wrap<?php echo $hidden; ?>">1842	<div class="notification-dialog-background"></div>1843	<div class="notification-dialog">1844	<?php1845 1846	if ( $locked ) {1847		$query_args = array();1848		if ( get_post_type_object( $post->post_type )->public ) {1849			if ( 'publish' === $post->post_status || $user->ID !== (int) $post->post_author ) {1850				// Latest content is in autosave.1851				$nonce                       = wp_create_nonce( 'post_preview_' . $post->ID );1852				$query_args['preview_id']    = $post->ID;1853				$query_args['preview_nonce'] = $nonce;1854			}1855		}1856 1857		$preview_link = get_preview_post_link( $post->ID, $query_args );1858 1859		/**1860		 * Filters whether to allow the post lock to be overridden.1861		 *1862		 * Returning false from the filter will disable the ability1863		 * to override the post lock.1864		 *1865		 * @since 3.6.0

Changelog

Introduced in 2.8.5. 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.1.0 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.