<!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>[53093] trunk: Site Editor: Resolve homepage template on server-side</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/53093">53093</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/53093","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>gziolo</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-04-07 13:33:03 +0000 (Thu, 07 Apr 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'>Site Editor: Resolve homepage template on server-side
Backports change from Gutenberg to support server-side home template resolution in the Site Editor. Original PR https://github.com/WordPress/gutenberg/pull/38817.
Props Mamaduka.
See <a href="https://core.trac.wordpress.org/ticket/55505">#55505</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminsiteeditorphp">trunk/src/wp-admin/site-editor.php</a></li>
<li><a href="#trunksrcwpincludesblocktemplatephp">trunk/src/wp-includes/block-template.php</a></li>
<li><a href="#trunktestsphpunittestsblocktemplatephp">trunk/tests/phpunit/tests/block-template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminsiteeditorphp"></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/site-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/site-editor.php 2022-04-07 12:52:32 UTC (rev 53092)
+++ trunk/src/wp-admin/site-editor.php 2022-04-07 13:33:03 UTC (rev 53093)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -23,6 +23,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_die( __( 'The theme you are currently using is not compatible with Full Site Editing.' ) );
</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">+/**
+ * Do a server-side redirection if missing `postType` and `postId`
+ * query args when visiting Site Editor.
+ */
+$home_template = _resolve_home_block_template();
+if ( $home_template && empty( $_GET['postType'] ) && empty( $_GET['postId'] ) ) {
+ $redirect_url = add_query_arg(
+ $home_template,
+ admin_url( 'site-editor.php' )
+ );
+ wp_safe_redirect( $redirect_url );
+ exit;
+}
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Used in the HTML title tag.
</span><span class="cx" style="display: block; padding: 0 10px"> $title = __( 'Editor (beta)' );
</span><span class="cx" style="display: block; padding: 0 10px"> $parent_file = 'themes.php';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,6 +70,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'styles' => get_block_editor_theme_styles(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'defaultTemplateTypes' => $indexed_template_types,
</span><span class="cx" style="display: block; padding: 0 10px"> 'defaultTemplatePartAreas' => get_allowed_block_template_part_areas(),
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '__unstableHomeTemplate' => $home_template,
</ins><span class="cx" style="display: block; padding: 0 10px"> '__experimentalBlockPatterns' => WP_Block_Patterns_Registry::get_instance()->get_all_registered(),
</span><span class="cx" style="display: block; padding: 0 10px"> '__experimentalBlockPatternCategories' => WP_Block_Pattern_Categories_Registry::get_instance()->get_all_registered(),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span></span></pre></div>
<a id="trunksrcwpincludesblocktemplatephp"></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-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/block-template.php 2022-04-07 12:52:32 UTC (rev 53092)
+++ trunk/src/wp-includes/block-template.php 2022-04-07 13:33:03 UTC (rev 53093)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -331,3 +331,35 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $wp_query->set( 'post_status', 'auto-draft' );
</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">+
+/**
+ * Returns the correct template for the site's home page.
+ *
+ * @access private
+ * @since 6.0.0
+ *
+ * @return array|null A template object, or null if none could be found.
+ */
+function _resolve_home_block_template() {
+ $show_on_front = get_option( 'show_on_front' );
+ $front_page_id = get_option( 'page_on_front' );
+
+ if ( 'page' === $show_on_front && $front_page_id ) {
+ return array(
+ 'postType' => 'page',
+ 'postId' => $front_page_id,
+ );
+ }
+
+ $hierarchy = array( 'front-page', 'home', 'index' );
+ $template = resolve_block_template( 'home', $hierarchy, '' );
+
+ if ( ! $template ) {
+ return null;
+ }
+
+ return array(
+ 'postType' => 'wp_template',
+ 'postId' => $template->id,
+ );
+}
</ins></span></pre></div>
<a id="trunktestsphpunittestsblocktemplatephp"></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/block-template.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/block-template.php 2022-04-07 12:52:32 UTC (rev 53092)
+++ trunk/tests/phpunit/tests/block-template.php 2022-04-07 13:33:03 UTC (rev 53093)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -188,4 +188,42 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $resolved_template_path = locate_block_template( '', 'search', array() );
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( '', $resolved_template_path );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Covers: https://github.com/WordPress/gutenberg/pull/38817.
+ *
+ * @ticket 55505
+ */
+ public function test_resolve_home_block_template_default_hierarchy() {
+ $template = _resolve_home_block_template();
+
+ $this->assertSame( 'wp_template', $template['postType'] );
+ $this->assertSame( get_stylesheet() . '//index', $template['postId'] );
+ }
+
+ /**
+ * @ticket 55505
+ */
+ public function test_resolve_home_block_template_static_homepage() {
+ $post_id = self::factory()->post->create( array( 'post_type' => 'page' ) );
+ update_option( 'show_on_front', 'page' );
+ update_option( 'page_on_front', $post_id );
+
+ $template = _resolve_home_block_template();
+
+ $this->assertSame( 'page', $template['postType'] );
+ $this->assertSame( $post_id, $template['postId'] );
+
+ delete_option( 'show_on_front', 'page' );
+ }
+
+ /**
+ * @ticket 55505
+ */
+ public function test_resolve_home_block_template_no_resolution() {
+ switch_theme( 'stylesheetonly' );
+ $template = _resolve_home_block_template();
+
+ $this->assertNull( $template );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>