Changeset 7131

Timestamp:

05/30/2013 10:58:46 PM (11 years ago)

Author:

johnjamesjacoby

Message:

Iterate on theme compatibility content replacement order. Introduce bp_do_theme_compat() and other helper functions to avoid breaking on nested calls to the_content() or nested usages of 'the_content' filter.

Also, experiment with not adding/removing all_filters from 'the_content' for a bit, and see if any issues come up in testing with other plugins active.

See #5021.

Location:

trunk/bp-core

Files:

• bp-core-template-loader.php (modified) (2 diffs)
• bp-core-theme-compatibility.php (modified) (4 diffs)

trunk/bp-core/bp-core-template-loader.php

@@ -212 +212 @@
 
     // Get the output buffer contents
-    $output = ob_get_contents();
-
-    // Flush the output buffer
-    ob_end_clean();
+    $output = ob_get_clean();
 
     // Echo or return the output buffer contents
@@ -342 +339 @@
     $new_template = apply_filters( 'bp_get_root_template', false, $template );
 
-    // BuddyPress template file exists
+    // A BuddyPress template file was located, so override the WordPress
+    // template and use it to switch off BuddyPress's theme compatibility.
     if ( !empty( $new_template ) ) {
-
-        // Override the WordPress template with a BuddyPress one
-        $template = $new_template;
-
-        // @see: bp_template_include_theme_compat()
-        buddypress()->theme_compat->found_template = true;
+        $template = bbp_set_template_included( $new_template );
     }
 
     return apply_filters( 'bp_template_include_theme_supports', $template );
+}
+
+/**
+ * Set the included template
+ *
+ * @since BuddyPress (1.8)
+ * @param mixed $template Default false
+ * @return mixed False if empty. Template name if template included
+ */
+function bp_set_template_included( $template = false ) {
+    buddypress()->theme_compat->found_template = $template;
+
+    return buddypress()->theme_compat->found_template;
+}
+
+/**
+ * Is a BuddyPress template being included?
+ *
+ * @since BuddyPress (1.8)
+ * @return bool True if yes, false if no
+ */
+function bp_is_template_included() {
+    return ! empty( buddypress()->theme_compat->found_template );
 }
 

trunk/bp-core/bp-core-theme-compatibility.php

@@ -524 +524 @@
      */
     if ( bp_is_theme_compat_active() ) {
-
-        // Hook to the beginning of the main post loop to remove all filters
-        // from the_content as late as possible.
-        add_action( 'loop_start', 'bp_theme_compat_main_loop_start',  9999 );
-
-        // Hook to the end of the main post loop to restore all filters to
-        // the_content as early as possible.
-        add_action( 'loop_end',   'bp_theme_compat_main_loop_end',   -9999 );
+        $template = bp_get_theme_compat_templates();
+
+        add_filter( 'the_content', 'bp_replace_the_content' );
 
         // Add BuddyPress's head action to wp_head
@@ -537 +532 @@
             add_action( 'wp_head', 'bp_head' );
         }
-
-        // Find the appropriate template file
-        $template = bp_get_theme_compat_templates();
     }
 
@@ -556 +548 @@
 function bp_replace_the_content( $content = '' ) {
 
-    if ( ! in_the_loop() )
+    // Bail if not the main loop where theme compat is happening
+    if ( ! bp_do_theme_compat() )
         return $content;
 
+    // Set theme compat to false early, to avoid recursion from nested calls to
+    // the_content() that execute before theme compat has unhooked itself.
+    bp_set_theme_compat_active( false );
+
+    // Do we have new content to replace the old content?
     $new_content = apply_filters( 'bp_replace_the_content', $content );
 
     // Juggle the content around and try to prevent unsightly comments
-    if ( !empty( $new_content ) && ( $new_content != $content ) ) {
+    if ( !empty( $new_content ) && ( $new_content !== $content ) ) {
 
         // Set the content to be the new content
@@ -579 +577 @@
 
 /**
- * Helper function to conditionally toggle the_content filters in the main
- * query loop. Aids with theme compatibility.
+ * Are we replacing the_content
  *
  * @since BuddyPress (1.8)
- * @internal Used only by theme compatibilty
- * @see bp_template_include_theme_compat()
- * @see bp_theme_compat_main_loop_end()
- */
-function bp_theme_compat_main_loop_start() {
-
-    // Bail if not the main query
-    if ( ! in_the_loop() )
-        return;
-
-    // Remove all of the filters from the_content
-    bp_remove_all_filters( 'the_content' );
-
-    // Make sure we replace the content
-    add_filter( 'the_content', 'bp_replace_the_content' );
-}
-
-/**
- * Helper function to conditionally toggle the_content filters in the main
- * query loop. Aids with theme compatibility.
- *
- * @since BuddyPress (1.8)
- * @internal Used only by theme compatibilty
- * @see bp_template_include_theme_compat()
- * @see bp_theme_compat_main_loop_start()
- */
-function bp_theme_compat_main_loop_end() {
-
-    // Bail if not the main query
-    if ( ! in_the_loop() )
-        return;
-
-    // Put all the filters back
-    bp_restore_all_filters( 'the_content' );
+ * @return bool
+ */
+function bp_do_theme_compat() {
+    return (bool) ( ! bp_is_template_included() && in_the_loop() && bp_is_theme_compat_active() );
 }