<!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>[59449] trunk/src/wp-includes: Editor: Warn about empty templates on the frontend for logged in users.</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/59449">59449</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/59449","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>mikachan</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-11-22 10:55:12 +0000 (Fri, 22 Nov 2024)</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: Warn about empty templates on the frontend for logged in users.
Adds a new function, `wp_render_empty_block_template_warning`, that renders a warning for logged-in users when a block template is empty.
Reviewed by get_dave, richtabor.
Props vcanales, mikachan, peterwilsoncc, richtabor, get_dave, mrfoxtalbot, matveb, arielmaidana, seifradwane, annezazu.
Fixes <a href="https://core.trac.wordpress.org/ticket/62053">#62053</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesblocktemplatephp">trunk/src/wp-includes/block-template.php</a></li>
<li><a href="#trunksrcwpincludesscriptloaderphp">trunk/src/wp-includes/script-loader.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#trunksrcwpincludescsswpemptytemplatealertcss">trunk/src/wp-includes/css/wp-empty-template-alert.css</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2024-11-21 19:00:46 UTC (rev 59448)
+++ trunk/src/wp-includes/block-template.php 2024-11-22 10:55:12 UTC (rev 59449)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -18,6 +18,32 @@
</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">+ * Renders a warning screen for empty block templates.
+ *
+ * @since 6.8.0
+ *
+ * @param WP_Block_Template $block_template The block template object.
+ * @return string The warning screen HTML.
+ */
+function wp_render_empty_block_template_warning( $block_template ) {
+ wp_enqueue_style( 'wp-empty-template-alert' );
+ return sprintf(
+ /* translators: %1$s: Block template title. %2$s: Empty template warning message. %3$s: Edit template link. %4$s: Edit template button label. */
+ '<div id="wp-empty-template-alert">
+ <h2>%1$s</h2>
+ <p>%2$s</p>
+ <a href="%3$s" class="wp-element-button">
+ %4$s
+ </a>
+ </div>',
+ esc_html( $block_template->title ),
+ __( 'This page is blank because the template is empty. You can reset or customize it in the Site Editor.' ),
+ get_edit_post_link( $block_template->wp_id, 'site-editor' ),
+ __( 'Edit template' )
+ );
+}
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Finds a block template with equal or higher specificity than a given PHP template file.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Internally, this communicates the block content that needs to be used by the template canvas through a global variable.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -68,13 +94,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $block_template ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $_wp_current_template_id = $block_template->id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $block_template->content ) && is_user_logged_in() ) {
- $_wp_current_template_content =
- sprintf(
- /* translators: %s: Template title */
- __( 'Empty template: %s' ),
- $block_template->title
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( empty( $block_template->content ) ) {
+ if ( is_user_logged_in() ) {
+ $_wp_current_template_content = wp_render_empty_block_template_warning( $block_template );
+ } else {
+ if ( $block_template->has_theme_file ) {
+ // Show contents from theme template if user is not logged in.
+ $theme_template = _get_block_template_file( 'wp_template', $block_template->slug );
+ $_wp_current_template_content = file_get_contents( $theme_template['path'] );
+ } else {
+ $_wp_current_template_content = $block_template->content;
+ }
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> } elseif ( ! empty( $block_template->content ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $_wp_current_template_content = $block_template->content;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunksrcwpincludescsswpemptytemplatealertcss"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: trunk/src/wp-includes/css/wp-empty-template-alert.css</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/css/wp-empty-template-alert.css (rev 0)
+++ trunk/src/wp-includes/css/wp-empty-template-alert.css 2024-11-22 10:55:12 UTC (rev 59449)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,23 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+#wp-empty-template-alert {
+ display: flex;
+ padding: var(--wp--style--root--padding-right, 2rem);
+ min-height: 60vh;
+ flex-direction: column;
+ align-items: center;
+ justify-content: center;
+ gap: var(--wp--style--block-gap, 2rem);
+}
+
+#wp-empty-template-alert > * {
+ max-width: 400px;
+}
+
+#wp-empty-template-alert h2,
+#wp-empty-template-alert p {
+ margin: 0;
+ text-align: center;
+}
+
+#wp-empty-template-alert a {
+ margin-top: 1rem;
+}
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: trunk/src/wp-includes/css/wp-empty-template-alert.css
</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="trunksrcwpincludesscriptloaderphp"></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/script-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/script-loader.php 2024-11-21 19:00:46 UTC (rev 59448)
+++ trunk/src/wp-includes/script-loader.php 2024-11-22 10:55:12 UTC (rev 59449)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1627,6 +1627,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $styles->add( 'wp-pointer', "/wp-includes/css/wp-pointer$suffix.css", array( 'dashicons' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $styles->add( 'customize-preview', "/wp-includes/css/customize-preview$suffix.css", array( 'dashicons' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $styles->add( 'wp-embed-template-ie', "/wp-includes/css/wp-embed-template-ie$suffix.css" );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $styles->add( 'wp-empty-template-alert', "/wp-includes/css/wp-empty-template-alert$suffix.css" );
</ins><span class="cx" style="display: block; padding: 0 10px"> $styles->add_data( 'wp-embed-template-ie', 'conditional', 'lte IE 8' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // External libraries and friends.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1809,6 +1810,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'customize-preview',
</span><span class="cx" style="display: block; padding: 0 10px"> 'login',
</span><span class="cx" style="display: block; padding: 0 10px"> 'site-health',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'wp-empty-template-alert',
</ins><span class="cx" style="display: block; padding: 0 10px"> // Includes CSS.
</span><span class="cx" style="display: block; padding: 0 10px"> 'buttons',
</span><span class="cx" style="display: block; padding: 0 10px"> 'admin-bar',
</span></span></pre>
</div>
</div>
</body>
</html>