<!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>[55955] trunk: Editor: add Post Content attributes to block editor settings.</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/55955">55955</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/55955","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>isabel_brison</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-06-21 04:21:04 +0000 (Wed, 21 Jun 2023)</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: add Post Content attributes to block editor settings.
Adds a new block editor setting containing the Post Content block attributes, if they exist.
Props audrasjb, spacedmonkey, jeremyfelt, mukesh27, flixos90, andrewserong.
Fixes <a href="https://core.trac.wordpress.org/ticket/58534">#58534</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblockeditorphp">trunk/src/wp-includes/block-editor.php</a></li>
<li><a href="#trunktestsphpunittestsblockseditorphp">trunk/tests/phpunit/tests/blocks/editor.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunktestsphpunitdatathemedir1blockthemetemplatessinglehtml">trunk/tests/phpunit/data/themedir1/block-theme/templates/single.html</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesblockeditorphp"></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/block-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-editor.php 2023-06-21 01:52:16 UTC (rev 55954)
+++ trunk/src/wp-includes/block-editor.php 2023-06-21 04:21:04 UTC (rev 55955)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -362,6 +362,92 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Finds the first occurrence of a specific block in an array of blocks.
+ *
+ * @since 6.3.0
+ *
+ * @param array $blocks Array of blocks.
+ * @param string $block_name Name of the block to find.
+ * @return array Found block, or empty array if none found.
+ */
+function wp_get_first_block( $blocks, $block_name ) {
+ foreach ( $blocks as $block ) {
+ if ( $block_name === $block['blockName'] ) {
+ return $block;
+ }
+ if ( ! empty( $block['innerBlocks'] ) ) {
+ $found_block = wp_get_first_block( $block['innerBlocks'], $block_name );
+
+ if ( ! empty( $found_block ) ) {
+ return $found_block;
+ }
+ }
+ }
+
+ return array();
+}
+
+/**
+ * Retrieves Post Content block attributes from the current post template.
+ *
+ * @since 6.3.0
+ * @access private
+ *
+ * @global int $post_ID
+ *
+ * @return array Post Content block attributes or empty array if they don't exist.
+ */
+function wp_get_post_content_block_attributes() {
+ global $post_ID;
+
+ $is_block_theme = wp_is_block_theme();
+
+ if ( ! $is_block_theme || ! $post_ID ) {
+ return array();
+ }
+
+ $template_slug = get_page_template_slug( $post_ID );
+
+ if ( ! $template_slug ) {
+ $post_slug = 'singular';
+ $page_slug = 'singular';
+ $template_types = get_block_templates();
+
+ foreach ( $template_types as $template_type ) {
+ if ( 'page' === $template_type->slug ) {
+ $page_slug = 'page';
+ }
+ if ( 'single' === $template_type->slug ) {
+ $post_slug = 'single';
+ }
+ }
+
+ $what_post_type = get_post_type( $post_ID );
+ switch ( $what_post_type ) {
+ case 'page':
+ $template_slug = $page_slug;
+ break;
+ default:
+ $template_slug = $post_slug;
+ break;
+ }
+ }
+
+ $current_template = get_block_templates( array( 'slug__in' => array( $template_slug ) ) );
+
+ if ( ! empty( $current_template ) ) {
+ $template_blocks = parse_blocks( $current_template[0]->content );
+ $post_content_block = wp_get_first_block( $template_blocks, 'core/post-content' );
+
+ if ( ! empty( $post_content_block['attrs'] ) ) {
+ return $post_content_block['attrs'];
+ }
+ }
+
+ return array();
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Returns the contextualized block editor settings for a selected editor context.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -529,6 +615,12 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_content_block_attributes = wp_get_post_content_block_attributes();
+
+ if ( ! empty( $post_content_block_attributes ) ) {
+ $editor_settings['postContentAttributes'] = $post_content_block_attributes;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Filters the settings to pass to the block editor for all editor type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span></span></pre></div>
<a id="trunktestsphpunitdatathemedir1blockthemetemplatessinglehtml"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/tests/phpunit/data/themedir1/block-theme/templates/single.html</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/data/themedir1/block-theme/templates/single.html (rev 0)
+++ trunk/tests/phpunit/data/themedir1/block-theme/templates/single.html 2023-06-21 04:21:04 UTC (rev 55955)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,2 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<!-- wp:post-title {"level":1,"style":{"spacing":{"margin":{"bottom":"var:preset|spacing|40"}}}} /-->
+<!-- wp:post-content {"layout":{"type":"constrained"}} /-->
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/tests/phpunit/data/themedir1/block-theme/templates/single.html
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><a id="trunktestsphpunittestsblockseditorphp"></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/blocks/editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/blocks/editor.php 2023-06-21 01:52:16 UTC (rev 55954)
+++ trunk/tests/phpunit/tests/blocks/editor.php 2023-06-21 04:21:04 UTC (rev 55955)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -27,6 +27,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_rest_server;
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_rest_server = new Spy_REST_Server();
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( 'rest_api_init', $wp_rest_server );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ global $post_ID;
+ $post_ID = 1;
</ins><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"> public function tear_down() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,6 +36,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /** @var WP_REST_Server $wp_rest_server */
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp_rest_server;
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_rest_server = null;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ global $post_ID;
+ $post_ID = null;
</ins><span class="cx" style="display: block; padding: 0 10px"> parent::tear_down();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -397,6 +402,59 @@
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 58534
+ */
+ public function test_wp_get_first_block() {
+ $block_name = 'core/paragraph';
+ $blocks = array(
+ array(
+ 'blockName' => 'core/image',
+ ),
+ array(
+ 'blockName' => $block_name,
+ 'attrs' => array(
+ 'content' => 'Hello World!',
+ ),
+ ),
+ array(
+ 'blockName' => 'core/heading',
+ ),
+ array(
+ 'blockName' => $block_name,
+ ),
+ );
+ $blocks_with_no_paragraph = array(
+ array(
+ 'blockName' => 'core/image',
+ ),
+ array(
+ 'blockName' => 'core/heading',
+ ),
+ );
+
+ $this->assertSame( $blocks[1], wp_get_first_block( $blocks, $block_name ) );
+
+ $this->assertSame( array(), wp_get_first_block( $blocks_with_no_paragraph, $block_name ) );
+ }
+
+ /**
+ * @ticket 58534
+ */
+ public function test_wp_get_post_content_block_attributes() {
+ $attributes_with_layout = array(
+ 'layout' => array(
+ 'type' => 'constrained',
+ ),
+ );
+ // With no block theme, expect an empty array.
+ $this->assertSame( array(), wp_get_post_content_block_attributes() );
+
+ switch_theme( 'block-theme' );
+
+ $this->assertSame( $attributes_with_layout, wp_get_post_content_block_attributes() );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 53458
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function test_get_block_editor_settings_theme_json_settings() {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -456,6 +514,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSameSets( array( 'rem' ), $settings['enableCustomUnits'] );
</span><span class="cx" style="display: block; padding: 0 10px"> // settings.spacing.customPadding
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertTrue( $settings['enableCustomSpacing'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // settings.postContentAttributes
+ $this->assertSameSets(
+ array(
+ 'layout' => array(
+ 'type' => 'constrained',
+ ),
+ ),
+ $settings['postContentAttributes']
+ );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> switch_theme( WP_DEFAULT_THEME );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>