Changeset 53559

Timestamp:

06/23/2022 06:46:18 PM (2 years ago)

Author:

jorbin

Message:

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.

Location:

trunk

Files:

• src/wp-admin/includes/post.php (modified) (1 diff)
• src/wp-includes/post.php (modified) (1 diff)
• tests/phpunit/tests/admin/includesPost.php (modified) (1 diff)
• tests/phpunit/tests/post.php (modified) (1 diff)

trunk/src/wp-admin/includes/post.php

@@ -2149 +2149 @@
 
 /**
- * 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.
  *

trunk/src/wp-includes/post.php

@@ -8107 +8107 @@
     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 );
+}

trunk/tests/phpunit/tests/admin/includesPost.php

@@ -788 +788 @@
 
         $this->assertSame( $p, post_exists( $title, $content, $date ) );
-    }
-
-    public function test_use_block_editor_for_post() {
-        $this->assertFalse( use_block_editor_for_post( -1 ) );
-        $bogus_post_id = $this->factory()->post->create(
-            array(
-                'post_type' => 'bogus',
-            )
-        );
-        $this->assertFalse( use_block_editor_for_post( $bogus_post_id ) );
-
-        register_post_type(
-            'restless',
-            array(
-                'show_in_rest' => false,
-            )
-        );
-        $restless_post_id = $this->factory()->post->create(
-            array(
-                'post_type' => 'restless',
-            )
-        );
-        $this->assertFalse( use_block_editor_for_post( $restless_post_id ) );
-
-        $generic_post_id = $this->factory()->post->create();
-
-        add_filter( 'use_block_editor_for_post', '__return_false' );
-        $this->assertFalse( use_block_editor_for_post( $generic_post_id ) );
-        remove_filter( 'use_block_editor_for_post', '__return_false' );
-
-        add_filter( 'use_block_editor_for_post', '__return_true' );
-        $this->assertTrue( use_block_editor_for_post( $restless_post_id ) );
-        remove_filter( 'use_block_editor_for_post', '__return_true' );
     }
 

trunk/tests/phpunit/tests/post.php

@@ -1845 +1845 @@
         $this->assertSameSets( array( 1, 2, 2 ), get_option( 'sticky_posts' ) );
     }
+
+    /**
+     * Check if post supports block editor.
+     *
+     * @ticket 51819
+     * @covers ::use_block_editor_for_post
+     */
+    public function test_use_block_editor_for_post() {
+        $this->assertFalse( use_block_editor_for_post( -1 ) );
+        $bogus_post_id = $this->factory()->post->create(
+            array(
+                'post_type' => 'bogus',
+            )
+        );
+        $this->assertFalse( use_block_editor_for_post( $bogus_post_id ) );
+
+        register_post_type(
+            'restless',
+            array(
+                'show_in_rest' => false,
+            )
+        );
+        $restless_post_id = $this->factory()->post->create(
+            array(
+                'post_type' => 'restless',
+            )
+        );
+        $this->assertFalse( use_block_editor_for_post( $restless_post_id ) );
+
+        $generic_post_id = $this->factory()->post->create();
+
+        add_filter( 'use_block_editor_for_post', '__return_false' );
+        $this->assertFalse( use_block_editor_for_post( $generic_post_id ) );
+        remove_filter( 'use_block_editor_for_post', '__return_false' );
+
+        add_filter( 'use_block_editor_for_post', '__return_true' );
+        $this->assertTrue( use_block_editor_for_post( $restless_post_id ) );
+        remove_filter( 'use_block_editor_for_post', '__return_true' );
+    }
 }