From a457e3498ed51c97629b67d4657aad05b33d1f32 Mon Sep 17 00:00:00 2001 From: Aaron Jorbin Date: Thu, 23 Jun 2022 18:48:13 +0000 Subject: [PATCH] Editor: Universalize functions for checking block editor status. `use_block_editor_for_post_type` and `use_block_editor_for_post` can be very useful in more contexts than wp-admin, especially when a site is in transition. For example, you may want to do things on init that are different. Neither function depends on other functions that are available only in wp-admin (other than use_block_editor_for_post() relying on use_block_editor_for_post_type() and an admin-referrer check that's historically gated by a query variable and now also gated by is_admin), therefore moving them to wp-includes seems both feasible and beneficial Props ethitter, jorbin. Fixes #51819. Built from https://develop.svn.wordpress.org/trunk@53559 git-svn-id: http://core.svn.wordpress.org/trunk@53148 1a063a9b-81f0-0310-95a4-ce76da25c4cd --- wp-admin/includes/post.php | 70 ------------------------------------ wp-includes/post.php | 72 ++++++++++++++++++++++++++++++++++++++ wp-includes/version.php | 2 +- 3 files changed, 73 insertions(+), 71 deletions(-) diff --git a/wp-admin/includes/post.php b/wp-admin/includes/post.php index a4dd6a0519..51af5bb2f2 100644 --- a/wp-admin/includes/post.php +++ b/wp-admin/includes/post.php @@ -2147,76 +2147,6 @@ function taxonomy_meta_box_sanitize_cb_input( $taxonomy, $terms ) { return $clean_terms; } -/** - * Returns whether the post can be edited in the block editor. - * - * @since 5.0.0 - * - * @param int|WP_Post $post Post ID or WP_Post object. - * @return bool Whether the post can be edited in the block editor. - */ -function use_block_editor_for_post( $post ) { - $post = get_post( $post ); - - if ( ! $post ) { - return false; - } - - // We're in the meta box loader, so don't use the block editor. - if ( isset( $_GET['meta-box-loader'] ) ) { - check_admin_referer( 'meta-box-loader', 'meta-box-loader-nonce' ); - return false; - } - - $use_block_editor = use_block_editor_for_post_type( $post->post_type ); - - /** - * 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 can be edited or not. - * @param WP_Post $post The post being checked. - */ - return apply_filters( 'use_block_editor_for_post', $use_block_editor, $post ); -} - -/** - * Returns whether a post type is compatible with the block editor. - * - * 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. - * - * @since 5.0.0 - * - * @param string $post_type The post type. - * @return bool Whether the post type can be edited with the block editor. - */ -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 ); -} - /** * Prepares server-registered blocks for the block editor. * diff --git a/wp-includes/post.php b/wp-includes/post.php index 23719feadd..05b97d699f 100644 --- a/wp-includes/post.php +++ b/wp-includes/post.php @@ -8106,3 +8106,75 @@ function wp_get_original_image_url( $attachment_id ) { function wp_untrash_post_set_previous_status( $new_status, $post_id, $previous_status ) { return $previous_status; } + +/** + * Returns whether the post can be edited in the block editor. + * + * @since 5.0.0 + * @since 6.1.0 Moved to wp-includes from wp-admin. + * + * @param int|WP_Post $post Post ID or WP_Post object. + * @return bool Whether the post can be edited in the block editor. + */ +function use_block_editor_for_post( $post ) { + $post = get_post( $post ); + + if ( ! $post ) { + return false; + } + + // We're in the meta box loader, so don't use the block editor. + if ( is_admin() && isset( $_GET['meta-box-loader'] ) ) { + check_admin_referer( 'meta-box-loader', 'meta-box-loader-nonce' ); + return false; + } + + $use_block_editor = use_block_editor_for_post_type( $post->post_type ); + + /** + * 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 can be edited or not. + * @param WP_Post $post The post being checked. + */ + return apply_filters( 'use_block_editor_for_post', $use_block_editor, $post ); +} + +/** + * Returns whether a post type is compatible with the block editor. + * + * 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. + * + * @since 5.0.0 + * @since 6.1.0 Moved to wp-includes from wp-admin. + * + * @param string $post_type The post type. + * @return bool Whether the post type can be edited with the block editor. + */ +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 ); +} diff --git a/wp-includes/version.php b/wp-includes/version.php index d089f372e9..026339c48a 100644 --- a/wp-includes/version.php +++ b/wp-includes/version.php @@ -16,7 +16,7 @@ * * @global string $wp_version */ -$wp_version = '6.1-alpha-53558'; +$wp_version = '6.1-alpha-53559'; /** * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.