<!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][9389] trunk/src/bp-core: Introduce `bp_theme_compat_page_templates()` for determining if a directory page template is available as an override for the theme compatibility template hierarchy.</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" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://buddypress.trac.wordpress.org/changeset/9389">9389</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://buddypress.trac.wordpress.org/changeset/9389","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnjamesjacoby</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2015-01-21 19:31:58 +0000 (Wed, 21 Jan 2015)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Introduce `bp_theme_compat_page_templates()` for determining if a directory page template is available as an override for the theme compatibility template hierarchy.
This fixes a fatal PHP error when the results of `get_page_template_slug()` do not match an available template for the currently active parent or child themes, causing that directory page to have no fallback template (and consequently `template_include` to receive an empty array.)
Fixes <a href="http://buddypress.trac.wordpress.org/ticket/6065">#6065</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcbpcorebpcorefiltersphp">trunk/src/bp-core/bp-core-filters.php</a></li>
<li><a href="#trunksrcbpcorebpcoretemplateloaderphp">trunk/src/bp-core/bp-core-template-loader.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcbpcorebpcorefiltersphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-filters.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-filters.php 2015-01-21 08:15:14 UTC (rev 9388)
+++ trunk/src/bp-core/bp-core-filters.php 2015-01-21 19:31:58 UTC (rev 9389)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -63,8 +63,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'bp_template_include', 'bp_template_include_theme_compat', 4, 2 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Filter BuddyPress template locations
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-add_filter( 'bp_get_template_stack', 'bp_add_template_stack_locations' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+add_filter( 'bp_get_template_stack', 'bp_add_template_stack_locations' );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+// Filter BuddyPress template hierarchy and look for page templates
+add_filter( 'bp_get_buddypress_template', 'bp_theme_compat_page_templates' );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Turn comments off for BuddyPress pages
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'comments_open', 'bp_comments_open', 10, 2 );
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcbpcorebpcoretemplateloaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/bp-core/bp-core-template-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/bp-core/bp-core-template-loader.php 2015-01-21 08:15:14 UTC (rev 9388)
+++ trunk/src/bp-core/bp-core-template-loader.php 2015-01-21 19:31:58 UTC (rev 9389)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -442,6 +442,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Array of possible root level wrapper template files.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function bp_get_theme_compat_templates() {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return bp_get_query_template( 'buddypress', array(
+ 'plugin-buddypress.php',
+ 'buddypress.php',
+ 'community.php',
+ 'generic.php',
+ 'page.php',
+ 'single.php',
+ 'index.php'
+ ) );
+}
+
+/**
+ * Filter the default theme compatibility root template hierarchy, and prepend
+ * a page template to the front if it's set.
+ *
+ * @see https://buddypress.trac.wordpress.org/ticket/6065
+ *
+ * @since BuddyPress (2.2.0)
+ *
+ * @param array $templates
+ * @return array
+ */
+function bp_theme_compat_page_templates( $templates = array() ) {
+
+ // Bail if not looking at a directory
+ if ( ! bp_is_directory() ) {
+ return $templates;
+ }
+
+ // No page ID yet
</ins><span class="cx" style="display: block; padding: 0 10px"> $page_id = 0;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Get the WordPress Page ID for the current view.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -458,30 +488,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // The Members component requires an explicit check due to overlapping components.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( bp_is_user() && 'members' === $component ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( bp_is_user() && ( 'members' === $component ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $page_id = (int) $bp_page->id;
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $templates = array(
- 'plugin-buddypress.php',
- 'buddypress.php',
- 'community.php',
- 'generic.php',
- 'page.php',
- 'single.php',
- 'index.php'
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Bail if no directory page set
+ if ( 0 === $page_id ) {
+ return $templates;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If the Page has a Page Template set, use that.
- if ( $page_id ) {
- $template_file = get_page_template_slug( $page_id );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check for page template
+ $page_template = get_page_template_slug( $page_id );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $template_file ) {
- $templates = array( $template_file );
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Add it to the beginning of the templates array so it takes precedence
+ // over the default hierarchy.
+ if ( ! empty( $page_template ) ) {
+ array_unshift( $templates, $page_template );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return bp_get_query_template( 'buddypress', $templates );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ return $templates;
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>