<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[53559] trunk: Editor: Universalize functions for checking block editor status.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/53559">53559</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/53559","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>jorbin</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-06-23 18:46:18 +0000 (Thu, 23 Jun 2022)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>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 <a href="https://core.trac.wordpress.org/ticket/51819">#51819</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludespostphp">trunk/src/wp-admin/includes/post.php</a></li>
<li><a href="#trunksrcwpincludespostphp">trunk/src/wp-includes/post.php</a></li>
<li><a href="#trunktestsphpunittestsadminincludesPostphp">trunk/tests/phpunit/tests/admin/includesPost.php</a></li>
<li><a href="#trunktestsphpunittestspostphp">trunk/tests/phpunit/tests/post.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludespostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/post.php 2022-06-23 15:01:19 UTC (rev 53558)
+++ trunk/src/wp-admin/includes/post.php 2022-06-23 18:46:18 UTC (rev 53559)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2148,76 +2148,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * 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 );
-}
-
-/**
</del><span class="cx" style="display: block; padding: 0 10px"> * Prepares server-registered blocks for the block editor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Returns an associative array of registered block data keyed by block name. Data includes properties
</span></span></pre></div>
<a id="trunksrcwpincludespostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/post.php 2022-06-23 15:01:19 UTC (rev 53558)
+++ trunk/src/wp-includes/post.php 2022-06-23 18:46:18 UTC (rev 53559)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -8106,3 +8106,75 @@
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_untrash_post_set_previous_status( $new_status, $post_id, $previous_status ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $previous_status;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+/**
+ * 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 );
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestsadminincludesPostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/admin/includesPost.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/admin/includesPost.php 2022-06-23 15:01:19 UTC (rev 53558)
+++ trunk/tests/phpunit/tests/admin/includesPost.php 2022-06-23 18:46:18 UTC (rev 53559)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -789,39 +789,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $p, post_exists( $title, $content, $date ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 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' );
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> public function test_get_block_editor_server_block_settings() {
</span><span class="cx" style="display: block; padding: 0 10px"> $name = 'core/test';
</span><span class="cx" style="display: block; padding: 0 10px"> $settings = array(
</span></span></pre></div>
<a id="trunktestsphpunittestspostphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/post.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/post.php 2022-06-23 15:01:19 UTC (rev 53558)
+++ trunk/tests/phpunit/tests/post.php 2022-06-23 18:46:18 UTC (rev 53559)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1844,4 +1844,43 @@
</span><span class="cx" style="display: block; padding: 0 10px"> unstick_post( 3 );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSameSets( array( 1, 2, 2 ), get_option( 'sticky_posts' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * 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' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>