Changeset 6866 for trunk/bp-core/bp-core-theme-compatibility.php

Timestamp:

03/25/2013 08:00:06 PM (12 years ago)

Author:

boonebgorges

Message:

Moves some core theme compatibility logic to the BP_Theme_Compat parent class

Since every new BP template pack will need to do the same kinds of checks
before starting the theme compat process (is this a child theme of bp-default,
etc), it makes sense for a parent::start() method to handle the logic, rather
than requiring individual template packs to reproduce it in their child
classes.

In addition, this changeset introduces a fallback check for legacy BuddyPress
themes. For themes that are not child themes of bp-default and also have not
declared current_theme_supports( 'buddypress' ), BP_Theme_Compat::start() now
checks for the existence of members/members-loop.php in the current theme, and
if found, it interprets it as a sign that the current theme does indeed support
BuddyPress, and that theme compatibility should be aborted. Theme authors are
still urged to use current_theme_supports( 'buddypress' ) in their template
packs.

Fixes #4869

Props r-a-y

File:

• trunk/bp-core/bp-core-theme-compatibility.php (modified) (2 diffs)

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

@@ -49 +49 @@
      * @var array 
      */
-    private $_data = array();
+    protected $_data = array();
 
     /**
@@ -60 +60 @@
         $this->_data = $properties;
     }
+
+
+    /**
+     * Themes shoud use this method in their constructor.
+     *
+     * In this method, we check all types of conditions where theme compatibility
+     * should *not* run.
+     *
+     * If we pass all conditions, then we setup some additional methods to use.
+     *
+     * @since BuddyPress (1.7)
+     */
+    protected function start() {
+
+        // If the theme supports 'buddypress', bail.
+        if ( current_theme_supports( 'buddypress' ) ) {
+            return;
+
+        // If the theme doesn't support BP, do some additional checks
+        } else {
+            // Bail if theme is a derivative of bp-default
+            if ( in_array( 'bp-default', array( get_template(), get_stylesheet() ) ) ) {
+                return;
+            }
+
+            // Bruteforce check for a BP template
+            // Examples are clones of bp-default
+            if ( locate_template( 'members/members-loop.php', false, false ) ) {
+                return;
+            }
+        }
+
+        // Setup methods
+        $this->setup_globals();
+        $this->setup_actions();
+    }
+
+    /**
+     * Meant to be extended in your class.
+     *
+     * @since BuddyPress (1.7)
+     */
+    protected function setup_globals() {}
+
+    /**
+     * Meant to be extended in your class.
+     *
+     * @since BuddyPress (1.7)
+     */
+    protected function setup_actions() {}
 
     /**