Changeset 9389

Timestamp:

01/21/2015 07:31:58 PM (10 years ago)

Author:

johnjamesjacoby

Message:

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 #6065.

Location:

trunk/src/bp-core

Files:

• bp-core-filters.php (modified) (1 diff)
• bp-core-template-loader.php (modified) (2 diffs)

trunk/src/bp-core/bp-core-filters.php

@@ -64 +64 @@
 
 // Filter BuddyPress template locations
-add_filter( 'bp_get_template_stack', 'bp_add_template_stack_locations'          );
+add_filter( 'bp_get_template_stack', 'bp_add_template_stack_locations' );
+
+// Filter BuddyPress template hierarchy and look for page templates
+add_filter( 'bp_get_buddypress_template', 'bp_theme_compat_page_templates' );
 
 // Turn comments off for BuddyPress pages

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

@@ -443 +443 @@
  */
 function bp_get_theme_compat_templates() {
-    $page_id = 0;
-
-    // Get the WordPress Page ID for the current view.
-    foreach ( (array) buddypress()->pages as $component => $bp_page ) {
-
-        // Handles the majority of components.
-        if ( bp_is_current_component( $component ) ) {
-            $page_id = (int) $bp_page->id;
-        }
-
-        // Stop if not on a user page.
-        if ( ! bp_is_user() && ! empty( $page_id ) ) {
-            break;
-        }
-
-        // The Members component requires an explicit check due to overlapping components.
-        if ( bp_is_user() && 'members' === $component ) {
-            $page_id = (int) $bp_page->id;
-            break;
-        }
-    }
-
-    $templates = array(
+    return bp_get_query_template( 'buddypress', array(
         'plugin-buddypress.php',
         'buddypress.php',
@@ -473 +451 @@
         'single.php',
         'index.php'
-    );
-
-    // If the Page has a Page Template set, use that.
-    if ( $page_id ) {
-        $template_file = get_page_template_slug( $page_id );
-
-        if ( $template_file ) {
-            $templates = array( $template_file );
+    ) );
+}
+
+/**
+ * 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
+    $page_id = 0;
+
+    // Get the WordPress Page ID for the current view.
+    foreach ( (array) buddypress()->pages as $component => $bp_page ) {
+
+        // Handles the majority of components.
+        if ( bp_is_current_component( $component ) ) {
+            $page_id = (int) $bp_page->id;
         }
-    }
-
-    return bp_get_query_template( 'buddypress', $templates );
-}
+
+        // Stop if not on a user page.
+        if ( ! bp_is_user() && ! empty( $page_id ) ) {
+            break;
+        }
+
+        // The Members component requires an explicit check due to overlapping components.
+        if ( bp_is_user() && ( 'members' === $component ) ) {
+            $page_id = (int) $bp_page->id;
+            break;
+        }
+    }
+
+    // Bail if no directory page set
+    if ( 0 === $page_id ) {
+        return $templates;
+    }
+
+    // Check for page template
+    $page_template = get_page_template_slug( $page_id );
+
+    // 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 );
+    }
+
+    return $templates;
+}