use_block_editor_for_post_type( string $post_type )
Return 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_type
-
(string) (Required) The post type.
Return
(bool) Whether the post type can be edited with the block editor.
Source
File: wp-admin/includes/post.php
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 ); }
Changelog
Version | Description |
---|---|
5.0.0 | Introduced. |
© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/use_block_editor_for_post_type