use_block_editor_for_post_type() – Function

Returns whether a post type is compatible with the block editor.

Description

The block editor depends on the REST API, and if the post type is not shown in the REST API, then it won’t work with the block editor.

Parameters

$post_typestringrequired: The post type.

Return

bool Whether the post type can be edited with the block editor.

Source

function use_block_editor_for_post_type( $post_type ) {
	if ( ! post_type_exists( $post_type ) ) {
		return false;
	}

	if ( ! post_type_supports( $post_type, 'editor' ) ) {
		return false;
	}

	$post_type_object = get_post_type_object( $post_type );
	if ( $post_type_object && ! $post_type_object->show_in_rest ) {
		return false;
	}

	/**
	 * Filters whether a post is able to be edited in the block editor.
	 *
	 * @since 5.0.0
	 *
	 * @param bool   $use_block_editor  Whether the post type can be edited or not. Default true.
	 * @param string $post_type         The post type being checked.
	 */
	return apply_filters( 'use_block_editor_for_post_type', true, $post_type );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘use_block_editor_for_post_type’, bool $use_block_editor, string $post_type ): Filters whether a post is able to be edited in the block editor.

Uses	Description
post_type_exists()`wp-includes/post.php`	Determines whether a post type is registered.
post_type_supports()`wp-includes/post.php`	Checks a post type’s support for a given feature.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_post_type_object()`wp-includes/post.php`	Retrieves a post type object by name.

Show 2 more Show less

Used by	Description
use_block_editor_for_post()`wp-includes/post.php`	Returns whether the post can be edited in the block editor.
WP_Screen::get()`wp-admin/includes/class-wp-screen.php`	Fetches a screen object.

Changelog

Version	Description
6.1.0	Moved to wp-includes from wp-admin.
5.0.0	Introduced.

User Contributed Notes

Skip to note 2 content

marginean.doru 2 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
```
/**
 * Disable Gutenberg editor for post types.
 */
add_filter( 'use_block_editor_for_post_type', '__return_false' );
```
Log in to add feedback

use_block_editor_for_post_type( string $post_type ): bool

In this article