Changeset 3971

Timestamp:

06/17/2012 02:25:31 PM (12 years ago)

Author:

johnjamesjacoby

Message:

Theme Compatibility:

• Allow root level templates to bypass the_content overriding if child/parent templates are found.
• Introduces two functions and new theme_compat functionality, that modifies bbp_get_query_template() to tell bbp_locate_template() to not override the_content.
• Reverts r3969.
• Fixes #1854 correctly.

Location:

branches/plugin/bbp-includes

Files:

• bbp-template-functions.php (modified) (4 diffs)
• bbp-theme-compatibility.php (modified) (2 diffs)

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

@@ -77 +77 @@
         if ( file_exists( trailingslashit( STYLESHEETPATH ) . $template_name ) ) {
             $located = trailingslashit( STYLESHEETPATH ) . $template_name;
+            bbp_set_the_content_override( false );
             break;
 
@@ -82 +83 @@
         } elseif ( file_exists( trailingslashit( TEMPLATEPATH ) . $template_name ) ) {
             $located = trailingslashit( TEMPLATEPATH ) . $template_name;
+            bbp_set_the_content_override( false );
             break;
 
@@ -87 +89 @@
         } elseif ( file_exists( trailingslashit( bbp_get_theme_compat_dir() ) . $template_name ) ) {
             $located = trailingslashit( bbp_get_theme_compat_dir() ) . $template_name;
+            bbp_set_the_content_override( true );
             break;
         }
@@ -120 +123 @@
         $templates = array( "{$type}.php" );
 
+    // Set query_template to true to tell bbp_locate_template() we are trying
+    // to determine if 'the_content' should be overridden or not.
+    bbpress()->theme_compat->query_template = true;
+
+    // Filter possible templates, try to match one, and set any bbPress theme
+    // compat properties so they can be cross-checked later.
     $templates = apply_filters( "bbp_get_{$type}_template", $templates );
     $templates = bbp_set_theme_compat_templates( $templates );
     $template  = bbp_locate_template( $templates );
     $template  = bbp_set_theme_compat_template( $template );
+
+    // Set query_template back to false, since we are done querying for main
+    // template files.
+    bbpress()->theme_compat->query_template = false;
 
     return apply_filters( "bbp_{$type}_template", $template );

branches/plugin/bbp-includes/bbp-theme-compatibility.php

@@ -285 +285 @@
         $bbp->theme_compat->packages[$theme->id] = $theme;
     }
+}
+
+/**
+ * This is called from inside bbp_locate_template(). It sets whether or not
+ * bbPress should override 'the_content' or if a root-level template was found
+ * in either the current child or parent themes.
+ *
+ * @since bbPress (r3970)
+ *
+ * @param boolean $override
+ * @return boolean
+ */
+function bbp_set_the_content_override( $override = false ) {
+    $bbp = bbpress();
+
+    if ( empty( $bbp->theme_compat->query_template ) )
+        return false;
+
+    $bbp->theme_compat->replace_the_content = $override;
+
+    return (bool) $bbp->theme_compat->replace_the_content;
+}
+
+/**
+ * Should bbPress try to replace 'the_content' because a template file could
+ * not be found in either the child or parent themes.
+ *
+ * @since bbPress (r3970)
+ *
+ * @return boolean
+ */
+function bbp_is_the_content_override() {
+    $bbp = bbpress();
+
+    if ( empty( $bbp->theme_compat->replace_the_content ) )
+        return false;
+
+    return (bool) $bbp->theme_compat->replace_the_content;
 }
 
@@ -402 +440 @@
     // includes archive-* and single-* WordPress post_type matches, allowing
     // themes to use the expected format.
-    if ( ! bbp_is_theme_compat_original_template( $template ) )
+    if ( bbp_is_theme_compat_original_template( $template ) )
+        return $template;
+
+    // If we know we are not going to override the_content with a bbPress
+    // template part, bail early so we don't reset queries and hook filters in.
+    if ( ! bbp_is_the_content_override() )
         return $template;