<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[BuddyPress][7131] trunk/bp-core: Iterate on theme compatibility content replacement order.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://buddypress.trac.wordpress.org/changeset/7131">7131</a></dd>
<dt>Author</dt> <dd>johnjamesjacoby</dd>
<dt>Date</dt> <dd>2013-05-30 22:58:46 +0000 (Thu, 30 May 2013)</dd>
</dl>
<h3>Log Message</h3>
<pre>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 <a href="http://buddypress.trac.wordpress.org/ticket/5021">#5021</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkbpcorebpcoretemplateloaderphp">trunk/bp-core/bp-core-template-loader.php</a></li>
<li><a href="#trunkbpcorebpcorethemecompatibilityphp">trunk/bp-core/bp-core-theme-compatibility.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkbpcorebpcoretemplateloaderphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-template-loader.php (7130 => 7131)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-template-loader.php 2013-05-29 03:35:17 UTC (rev 7130)
+++ trunk/bp-core/bp-core-template-loader.php 2013-05-30 22:58:46 UTC (rev 7131)
</span><span class="lines">@@ -211,11 +211,8 @@
</span><span class="cx"> add_filter( 'the_content', 'bp_replace_the_content' );
</span><span class="cx">
</span><span class="cx"> // Get the output buffer contents
</span><del>- $output = ob_get_contents();
</del><ins>+ $output = ob_get_clean();
</ins><span class="cx">
</span><del>- // Flush the output buffer
- ob_end_clean();
-
</del><span class="cx"> // Echo or return the output buffer contents
</span><span class="cx"> if ( true === $echo ) {
</span><span class="cx"> echo $output;
</span><span class="lines">@@ -341,20 +338,39 @@
</span><span class="cx"> // Look for root BuddyPress template files in parent/child themes
</span><span class="cx"> $new_template = apply_filters( 'bp_get_root_template', false, $template );
</span><span class="cx">
</span><del>- // BuddyPress template file exists
</del><ins>+ // A BuddyPress template file was located, so override the WordPress
+ // template and use it to switch off BuddyPress's theme compatibility.
</ins><span class="cx"> if ( !empty( $new_template ) ) {
</span><del>-
- // Override the WordPress template with a BuddyPress one
- $template = $new_template;
-
- // @see: bp_template_include_theme_compat()
- buddypress()->theme_compat->found_template = true;
</del><ins>+ $template = bbp_set_template_included( $new_template );
</ins><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> return apply_filters( 'bp_template_include_theme_supports', $template );
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><ins>+ * 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 );
+}
+
+/**
</ins><span class="cx"> * Attempt to load a custom BuddyPress functions file, similar to each themes
</span><span class="cx"> * functions.php file.
</span><span class="cx"> *
</span></span></pre></div>
<a id="trunkbpcorebpcorethemecompatibilityphp"></a>
<div class="modfile"><h4>Modified: trunk/bp-core/bp-core-theme-compatibility.php (7130 => 7131)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/bp-core/bp-core-theme-compatibility.php 2013-05-29 03:35:17 UTC (rev 7130)
+++ trunk/bp-core/bp-core-theme-compatibility.php 2013-05-30 22:58:46 UTC (rev 7131)
</span><span class="lines">@@ -523,22 +523,14 @@
</span><span class="cx"> * possible templates, or 'bp_buddypress_template' to override the result.
</span><span class="cx"> */
</span><span class="cx"> if ( bp_is_theme_compat_active() ) {
</span><ins>+ $template = bp_get_theme_compat_templates();
</ins><span class="cx">
</span><del>- // 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 );
</del><ins>+ add_filter( 'the_content', 'bp_replace_the_content' );
</ins><span class="cx">
</span><del>- // 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 );
-
</del><span class="cx"> // Add BuddyPress's head action to wp_head
</span><span class="cx"> if ( ! has_action( 'wp_head', 'bp_head' ) ) {
</span><span class="cx"> add_action( 'wp_head', 'bp_head' );
</span><span class="cx"> }
</span><del>-
- // Find the appropriate template file
- $template = bp_get_theme_compat_templates();
</del><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> return apply_filters( 'bp_template_include_theme_compat', $template );
</span><span class="lines">@@ -555,13 +547,19 @@
</span><span class="cx"> */
</span><span class="cx"> function bp_replace_the_content( $content = '' ) {
</span><span class="cx">
</span><del>- if ( ! in_the_loop() )
</del><ins>+ // Bail if not the main loop where theme compat is happening
+ if ( ! bp_do_theme_compat() )
</ins><span class="cx"> return $content;
</span><span class="cx">
</span><ins>+ // 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?
</ins><span class="cx"> $new_content = apply_filters( 'bp_replace_the_content', $content );
</span><span class="cx">
</span><span class="cx"> // Juggle the content around and try to prevent unsightly comments
</span><del>- if ( !empty( $new_content ) && ( $new_content != $content ) ) {
</del><ins>+ if ( !empty( $new_content ) && ( $new_content !== $content ) ) {
</ins><span class="cx">
</span><span class="cx"> // Set the content to be the new content
</span><span class="cx"> $content = $new_content;
</span><span class="lines">@@ -578,46 +576,15 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * Helper function to conditionally toggle the_content filters in the main
- * query loop. Aids with theme compatibility.
</del><ins>+ * Are we replacing the_content
</ins><span class="cx"> *
</span><span class="cx"> * @since BuddyPress (1.8)
</span><del>- * @internal Used only by theme compatibilty
- * @see bp_template_include_theme_compat()
- * @see bp_theme_compat_main_loop_end()
</del><ins>+ * @return bool
</ins><span class="cx"> */
</span><del>-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' );
</del><ins>+function bp_do_theme_compat() {
+ return (bool) ( ! bp_is_template_included() && in_the_loop() && bp_is_theme_compat_active() );
</ins><span class="cx"> }
</span><span class="cx">
</span><del>-/**
- * 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' );
-}
-
</del><span class="cx"> /** Filters *******************************************************************/
</span><span class="cx">
</span><span class="cx"> /**
</span></span></pre>
</div>
</div>
</body>
</html>