use_block_editor_for_post( int|WP_Post $post ): bool

Compatibility

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

Post ID or WP_Post object.

Return value

bool

Whether the post can be edited in the block editor.

Performance profile

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

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

Plugin surface

1 hook

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

Called by

1

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

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly

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

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

Hooks and filters fired · 1

One hook fires while use_block_editor_for_post() runs, in this order:

1. 1
   apply_filters( use_block_editor_for_post )filterline 8798 (+23 into the body)

   Filters whether a post is able to be edited in the block editor.

Uses · 5

• get_post()Retrieves post data given a post ID or post object.
• is_admin()Determines whether the current request is for an administrative interface page.
• check_admin_referer()Ensures intent by verifying that a user was referred from another admin page with the correct security nonce.
• use_block_editor_for_post_type()Returns whether a post type is compatible with the block editor.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

• WP_Screen::get()Fetches a screen object.

Source code

View on Trac ↗View on GitHub ↗

8775function use_block_editor_for_post( $post ) {8776	$post = get_post( $post );8777 8778	if ( ! $post ) {8779		return false;8780	}8781 8782	// We're in the meta box loader, so don't use the block editor.8783	if ( is_admin() && isset( $_GET['meta-box-loader'] ) ) {8784		check_admin_referer( 'meta-box-loader', 'meta-box-loader-nonce' );8785		return false;8786	}8787 8788	$use_block_editor = use_block_editor_for_post_type( $post->post_type );8789 8790	/**8791	 * Filters whether a post is able to be edited in the block editor.8792	 *8793	 * @since 5.0.08794	 *8795	 * @param bool    $use_block_editor Whether the post can be edited or not.8796	 * @param WP_Post $post             The post being checked.8797	 */8798	return apply_filters( 'use_block_editor_for_post', $use_block_editor, $post );8799}

Changelog

Introduced in 5.0.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.1.0 tag, from src/wp-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.