Changeset 7394

Timestamp:

12/30/2025 05:29:34 PM (4 weeks ago)

Author:

johnjamesjacoby

Message:

Core - Theme Compat: add Block Theme support.

This commit includes the following changes:

• Deprecates bbp_get_theme_compat_templates() for a singular version
• Introduces bbp_get_theme_canvas_template() to retrieve a filtered path to theme-canvas.php
• Introduces bbp_get_template_include_templates() to retrieve a filtered array of checker & getter functions
• Simplifies bbp_template_include_theme_supports() into a foreach loop
• Simplifies bbp_is_template_included() usage inside of bbp_template_include_theme_compat() by removing the later check now that 404's are handled elsewhere

Props mikachan, robin-w, arafatjamil01, johnjamesjacoby.

Fixes #3487.

In trunk, for 2.7.

Location:

trunk/src/includes/core

Files:

• template-loader.php (modified) (4 diffs)
• theme-compat.php (modified) (4 diffs)

trunk/src/includes/core/template-loader.php

@@ -29 +29 @@
 function bbp_template_include_theme_supports( $template = '' ) {
 
-    // phpcs:disable
-
-    // Editing a user
-    if     ( bbp_is_single_user_edit() && ( $new_template = bbp_get_single_user_edit_template() ) ) :  //phpcs:ignore
-
-    // User favorites
-    elseif ( bbp_is_favorites() && ( $new_template = bbp_get_favorites_template()        ) ) :
-
-    // User favorites
-    elseif ( bbp_is_subscriptions() && ( $new_template = bbp_get_subscriptions_template()    ) ) :
-
-    // Viewing a user
-    elseif ( bbp_is_single_user() && ( $new_template = bbp_get_single_user_template()      ) ) :
-
-    // Single View
-    elseif ( bbp_is_single_view() && ( $new_template = bbp_get_single_view_template()      ) ) :
-
-    // Search
-    elseif ( bbp_is_search() && ( $new_template = bbp_get_search_template()           ) ) :
-
-    // Forum edit
-    elseif ( bbp_is_forum_edit() && ( $new_template = bbp_get_forum_edit_template()       ) ) :
-
-    // Single Forum
-    elseif ( bbp_is_single_forum() && ( $new_template = bbp_get_single_forum_template()     ) ) :
-
-    // Forum Archive
-    elseif ( bbp_is_forum_archive() && ( $new_template = bbp_get_forum_archive_template()    ) ) :
-
-    // Topic merge
-    elseif ( bbp_is_topic_merge() && ( $new_template = bbp_get_topic_merge_template()      ) ) :
-
-    // Topic split
-    elseif ( bbp_is_topic_split() && ( $new_template = bbp_get_topic_split_template()      ) ) :
-
-    // Topic edit
-    elseif ( bbp_is_topic_edit() && ( $new_template = bbp_get_topic_edit_template()       ) ) :
-
-    // Single Topic
-    elseif ( bbp_is_single_topic() && ( $new_template = bbp_get_single_topic_template()     ) ) :
-
-    // Topic Archive
-    elseif ( bbp_is_topic_archive() && ( $new_template = bbp_get_topic_archive_template()    ) ) :
-
-    // Reply move
-    elseif ( bbp_is_reply_move() && ( $new_template = bbp_get_reply_move_template()       ) ) :
-
-    // Editing a reply
-    elseif ( bbp_is_reply_edit() && ( $new_template = bbp_get_reply_edit_template()       ) ) :
-
-    // Single Reply
-    elseif ( bbp_is_single_reply() && ( $new_template = bbp_get_single_reply_template()     ) ) :
-
-    // Editing a topic tag
-    elseif ( bbp_is_topic_tag_edit() && ( $new_template = bbp_get_topic_tag_edit_template()   ) ) :
-
-    // Viewing a topic tag
-    elseif ( bbp_is_topic_tag() && ( $new_template = bbp_get_topic_tag_template()        ) ) :
-    endif;
-
-    // phpcs:enable
-
-    // A bbPress template file was located, so override the WordPress template
-    // and use it to switch off theme compatibility.
-    if ( ! empty( $new_template ) ) {
-        $template = bbp_set_template_included( $new_template );
+    // Default return value
+    $retval = $template;
+
+    // Get the templates
+    $bbp_templates = bbp_get_template_include_templates();
+
+    // Loop through each of the template conditionals
+    if ( ! empty( $bbp_templates ) ) {
+        foreach ( $bbp_templates as $checker => $getter ) {
+
+            // Skip if check fails
+            if ( ! function_exists( $checker ) || ! call_user_func( $checker ) ) {
+                continue;
+            }
+
+            // Maybe get a template file
+            $new_template = function_exists( $getter )
+                ? call_user_func( $getter )
+                : '';
+
+            // Skip if new template not found
+            if ( empty( $new_template ) ) {
+                continue;
+            }
+
+            // A bbPress template file was located, so set the return value
+            // that will override the WordPress template, and switches off
+            // theme compatibility.
+            $retval = bbp_set_template_included( $new_template );
+
+            // Exit the loop
+            break;
+        }
     }
 
@@ -102 +69 @@
      * @since 2.0.0 bbPress (r3032)
      *
-     * @param string $template The path to the template file.
+     * @param string $retval   Path to the filtered template file.
+     * @param string $template Path to the original template file.
      */
-    return apply_filters( 'bbp_template_include_theme_supports', $template );
+    return apply_filters( 'bbp_template_include_theme_supports', $retval, $template );
 }
 
@@ -460 +428 @@
 
 /**
- * Get the templates to use as the endpoint for bbPress template parts.
- *
- * @since 2.0.0 bbPress (r3311)
- * @since 2.6.0 bbPress (r5950) Added `singular.php` to template stack
- *
- * @return string Path to template file.
- */
-function bbp_get_theme_compat_templates() {
+ * Get the template to use as the wrapper for bbPress template parts.
+ *
+ * @since 2.7.0 bbPress (r7393)
+ *
+ * @return string Path to template file.
+ */
+function bbp_get_theme_compat_template() {
     $templates = array(
         'plugin-bbpress.php',
@@ -481 +448 @@
     return bbp_get_query_template( 'bbpress', $templates );
 }
+
+/**
+ * Get the theme canvas template, used for Block Themes.
+ *
+ * @since 2.7.0 bbPress (r7383)
+ *
+ * @return string Path to canvas file.
+ */
+function bbp_get_theme_canvas_template() {
+
+    // Default WordPress Canvas
+    $template = ABSPATH . WPINC . '/template-canvas.php';
+
+    // Filter & return
+    return apply_filters( 'bbp_get_theme_canvas_template', $template );
+}
+
+/**
+ * Get the array of _is_ functions and their template finders.
+ *
+ * This function abstracts the template checkers & getters to allow third-party
+ * plugins to add their own bbPress component functionality more easily.
+ *
+ * @since 2.7.0 bbPress (r7393)
+ *
+ * @return array Key => Value array of checkers & getters.
+ */
+function bbp_get_template_include_templates() {
+
+    // Possible templates: checker => getter
+    $templates = array(
+
+        // User
+        'bbp_is_single_user_edit' => 'bbp_get_single_user_edit_template',
+        'bbp_is_favorites'        => 'bbp_get_favorites_template',
+        'bbp_is_subscriptions'    => 'bbp_get_subscriptions_template',
+        'bbp_is_single_user'      => 'bbp_get_single_user_template',
+
+        // Topic view
+        'bbp_is_single_view'      => 'bbp_get_single_view_template',
+
+        // Search
+        'bbp_is_search'           => 'bbp_get_search_template',
+
+        // Forum
+        'bbp_is_forum_edit'       => 'bbp_get_forum_edit_template',
+        'bbp_is_single_forum'     => 'bbp_get_single_forum_template',
+        'bbp_is_forum_archive'    => 'bbp_get_forum_archive_template',
+
+        // Topic
+        'bbp_is_topic_merge'      => 'bbp_get_topic_merge_template',
+        'bbp_is_topic_split'      => 'bbp_get_topic_split_template',
+        'bbp_is_topic_edit'       => 'bbp_get_topic_edit_template',
+        'bbp_is_single_topic'     => 'bbp_get_single_topic_template',
+        'bbp_is_topic_archive'    => 'bbp_get_topic_archive_template',
+
+        // Reply
+        'bbp_is_reply_move'       => 'bbp_get_reply_move_template',
+        'bbp_is_reply_edit'       => 'bbp_get_reply_edit_template',
+        'bbp_is_single_reply'     => 'bbp_get_single_reply_template',
+
+        // Topic tag
+        'bbp_is_topic_tag_edit'   => 'bbp_get_topic_tag_edit_template',
+        'bbp_is_topic_tag'        => 'bbp_get_topic_tag_template',
+    );
+
+    // Filter & return
+    return (array) apply_filters( 'bbp_get_template_include_templates', $templates );
+}
+
+/** Deprecated ****************************************************************/
+
+/**
+ * Get the templates to use as the endpoint for bbPress template parts.
+ *
+ * This function was deprecated because it was named plural when it should have
+ * been singular, as it only returns the path to a single file.
+ *
+ * @since 2.0.0 bbPress (r3311)
+ * @since 2.6.0 bbPress (r5950) Added `singular.php` to template stack
+ * @deprecated 2.7.0 bbPress (r7393)
+ *
+ * @return string Path to template file.
+ */
+function bbp_get_theme_compat_templates() {
+    return bbp_get_theme_compat_template();
+}
+

trunk/src/includes/core/theme-compat.php

@@ -482 +482 @@
  *
  * @since 2.0.0 bbPress (r3032)
+ * @since 2.7.0 bbPress (r7393) Added support for Block Themes
  *
  * @param string $template
@@ -488 +489 @@
 
     /**
-     * Bail if a root template was already found. This prevents unintended
-     * recursive filtering of 'the_content'.
-     *
-     * @link https://bbpress.trac.wordpress.org/ticket/2429
+     * Bail if the template already matches a bbPress template. This includes
+     * archive-* and single-* WordPress post_type matches (allowing
+     * themes to use the expected format) as well as all bbPress-specific
+     * template files for users, topics, forums, etc...
+     *
+     * @see https://bbpress.trac.wordpress.org/ticket/1478
+     * @see https://bbpress.trac.wordpress.org/ticket/2429
      */
     if ( bbp_is_template_included() ) {
@@ -838 +842 @@
 
     /**
-     * Bail if the template already matches a bbPress template. This includes
-     * archive-* and single-* WordPress post_type matches (allowing
-     * themes to use the expected format) as well as all bbPress-specific
-     * template files for users, topics, forums, etc...
-     *
-     * We do this after the above checks to prevent incorrect 404 body classes
-     * and header statuses, as well as to set the post global as needed.
-     *
-     * @see https://bbpress.trac.wordpress.org/ticket/1478/
-     */
-    if ( bbp_is_template_included() ) {
-        return $template;
-
-    /**
      * If we are relying on the built-in theme compatibility API to load
      * the proper content, we need to intercept the_content, replace the
@@ -858 +848 @@
      * To do this, we first remove all filters from 'the_content' and hook
      * our own function into it, which runs a series of checks to determine
-     * the context, and then uses the built in shortcodes to output the
-     * correct results from inside an output buffer.
-     *
-     * Uses bbp_get_theme_compat_templates() to provide fall-backs that
+     * the context, and then uses the shortcodes API to output the correct
+     * results from inside an output buffer.
+     *
+     * Uses bbp_get_theme_compat_template() to provide fall-backs that
      * should be coded without superfluous mark-up and logic (prev/next
      * navigation, comments, date/time, etc...)
      *
-     * Hook into the 'bbp_get_bbpress_template' to override the array of
+     * Hook into the 'bbp_get_bbpress_template' filter to override the array of
      * possible templates, or 'bbp_bbpress_template' to override the result.
+     *
+     * This is Block Theme aware as of 2.7.0 and will use the Canvas file that
+     * block themes expect instead of a theme-compat template.
      */
-    } elseif ( bbp_is_theme_compat_active() ) {
+    if ( bbp_is_theme_compat_active() ) {
         bbp_remove_all_filters( 'the_content' );
 
-        $template = bbp_get_theme_compat_templates();
+        // Block themes
+        if ( current_theme_supports( 'block-templates' ) ) {
+            $template = bbp_get_theme_canvas_template();
+
+        // Non-block themes
+        } else {
+            $template = bbp_get_theme_compat_template();
+        }
     }