Changeset 56507 for trunk/src/wp-includes/block-template.php

Timestamp:

09/01/2023 05:30:02 PM (14 months ago)

Author:

flixos90

Message:

Editor: Ensure main query loop is entered for singular content in block themes.

Block themes currently lack the means to trigger the main query loop for singular content, since they cannot reasonably use the core/query and core/post-template blocks which are intended only for displaying a list of posts. So far, the missing main query loop on singular block templates has been worked around by enforcing the loop in certain core/post-* blocks, which however causes other bugs.

This changeset ensures that the main query loop is still started for singular block theme templates, by wrapping the entire template into the loop, which will by definition only have a single cycle as it only encompasses a single post. This is currently the most reliable solution, since even if there were blocks to properly trigger the main query loop on singular content, it would be unrealistic to expect all existing block themes to update their templates accordingly. It may be revisited in the future.

Props gziolo, youknowriad, joemcgill, costdev, mukesh27, flixos90.
Fixes #58154.
See #59225, #58027.

File:

• trunk/src/wp-includes/block-template.php (modified) (2 diffs)

trunk/src/wp-includes/block-template.php

@@ -211 +211 @@
  * @global string   $_wp_current_template_content
  * @global WP_Embed $wp_embed
+ * @global WP_Query $wp_query
  *
  * @return string Block template markup.
  */
 function get_the_block_template_html() {
-    global $_wp_current_template_content;
-    global $wp_embed;
+    global $_wp_current_template_content, $wp_embed, $wp_query;
 
     if ( ! $_wp_current_template_content ) {
@@ -229 +229 @@
     $content = shortcode_unautop( $content );
     $content = do_shortcode( $content );
-    $content = do_blocks( $content );
+
+    /*
+     * Most block themes omit the `core/query` and `core/post-template` blocks in their singular content templates.
+     * While this technically still works since singular content templates are always for only one post, it results in
+     * the main query loop never being entered which causes bugs in core and the plugin ecosystem.
+     *
+     * The workaround below ensures that the loop is started even for those singular templates. The while loop will by
+     * definition only go through a single iteration, i.e. `do_blocks()` is only called once. Additional safeguard
+     * checks are included to ensure the main query loop has not been tampered with and really only encompasses a
+     * single post.
+     *
+     * Even if the block template contained a `core/query` and `core/post-template` block referencing the main query
+     * loop, it would not cause errors since it would use a cloned instance and go through the same loop of a single
+     * post, within the actual main query loop.
+     */
+    if ( is_singular() && 1 === $wp_query->post_count && have_posts() ) {
+        while ( have_posts() ) {
+            the_post();
+            $content = do_blocks( $content );
+        }
+    } else {
+        $content = do_blocks( $content );
+    }
+
     $content = wptexturize( $content );
     $content = convert_smilies( $content );