Changeset 3927 for branches/plugin/bbp-includes/bbp-template-loader.php

Timestamp:

05/31/2012 04:30:09 AM (14 years ago)

Author:

johnjamesjacoby

Message:

Theme Compatibility:

• Introduce bbp_is_theme_compat_original_template() and bbp_set_theme_compat_original_template() functions, to allow the template loader to properly use custom post type templates.
• Refactor BBP_Theme_Compat to use magic methods.
• Reorder bbp_template_include_theme_supports() to put _edit() checks before single/archive checks, to prevent them from being stomped.
• Clean up BBP_Theme_Compat usage to work with refactored approach.
• Fixes #1833.

File:

• branches/plugin/bbp-includes/bbp-template-loader.php (modified) (5 diffs)

branches/plugin/bbp-includes/bbp-template-loader.php

@@ -14 +14 @@
  * Possibly intercept the template being loaded
  *
- * Listens to the 'template_include' filter and waits for a bbPress post_type
- * to appear. If the current theme does not explicitly support bbPress, it
- * intercepts the page template and uses one served from the bbPress compatable
- * theme, set in the $bbp->theme_compat global. If the current theme does
- * support bbPress, we'll explore the template hierarchy and try to locate one.
+ * Listens to the 'template_include' filter and waits for any bbPress specific
+ * template condition to be met. If one is met and the template file exists,
+ * it will be used; otherwise 
  *
  * @since bbPress (r3032)
@@ -46 +44 @@
 function bbp_template_include_theme_supports( $template = '' ) {
 
+        // Set the original template that WordPress found so we can compare the
+        // one bbPress find's in bbp_template_include_theme_compat().
+        bbp_set_theme_compat_original_template( $template );
+
+        /** bbPress Templates *****************************************************/
+        
+        // Note that the _edit() checks are ahead of their counterparts, to
+        // prevent them from being stomped on accident.
+
+        // Editing a user
+        if     ( bbp_is_single_user_edit() && ( $new_template = bbp_get_single_user_edit_template() ) ) :
+
         // Viewing a user
-        if     ( bbp_is_single_user()      && ( $new_template = bbp_get_single_user_template()      ) ) :
-
-        // Editing a user
-        elseif ( bbp_is_single_user_edit() && ( $new_template = bbp_get_single_user_edit_template() ) ) :
+        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()      ) ) :
 
+        // 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()     ) ) :
@@ -61 +71 @@
         elseif ( bbp_is_forum_archive()    && ( $new_template = bbp_get_forum_archive_template()    ) ) :
 
-        // Forum edit
-        elseif ( bbp_is_forum_edit()       && ( $new_template = bbp_get_forum_edit_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
@@ -70 +86 @@
         elseif ( bbp_is_topic_archive()    && ( $new_template = bbp_get_topic_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()       ) ) :
+        // 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 reply
-        elseif ( bbp_is_reply_edit()       && ( $new_template = bbp_get_reply_edit_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()        ) ) :
-
-        // Editing a topic tag
-        elseif ( bbp_is_topic_tag_edit()   && ( $new_template = bbp_get_topic_tag_edit_template()   ) ) :
         endif;
 
-        // Custom template file exists
-        $template = !empty( $new_template ) ? $new_template : $template;
+        // bbPress template file exists
+        if ( !empty( $new_template ) && ! bbp_is_theme_compat_original_template( $new_template ) )
+                $template = $new_template;
 
         return apply_filters( 'bbp_template_include_theme_supports', $template );
@@ -403 +411 @@
         $templates = array(
                 'bbpress.php',
+                'forums.php',
                 'forum.php',
                 'page.php',