Changeset 3927 for branches/plugin/bbp-includes/bbp-theme-compatibility.php

Timestamp:

05/31/2012 04:30:09 AM (14 years ago)

Author:

johnjamesjacoby

Message:

Theme Compatibility:

• Introduce bbp_is_theme_compat_original_template() and bbp_set_theme_compat_original_template() functions, to allow the template loader to properly use custom post type templates.
• Refactor BBP_Theme_Compat to use magic methods.
• Reorder bbp_template_include_theme_supports() to put _edit() checks before single/archive checks, to prevent them from being stomped.
• Clean up BBP_Theme_Compat usage to work with refactored approach.
• Fixes #1833.

File:

• branches/plugin/bbp-includes/bbp-theme-compatibility.php (modified) (4 diffs)

branches/plugin/bbp-includes/bbp-theme-compatibility.php

@@ -37 +37 @@
 
     /**
-     * @var string ID of the theme (should be unique)
+     * Should be like:
+     *
+     * array(
+     *     'id'      => ID of the theme (should be unique)
+     *     'name'    => Name of the theme (should match style.css)
+     *     'version' => Theme version for cache busting scripts and styling
+     *     'dir'     => Path to theme
+     *     'url'     => URL to theme
+     * );
+     * @var array 
      */
-    public $id = '';
+    private $_data = array();
 
     /**
-     * @var string Name of the theme (should match style.css)
+     * Pass the $properties to the object on creation.
+     *
+     * @since bbPress (r3926)
+     * @param array $properties
      */
-    public $name = '';
+    public function __construct( Array $properties = array() ) {
+        $this->_data = $properties;
+    }
 
     /**
-     * @var string Theme version for cache busting scripts and styling
+     * Set a theme's property.
+     *
+     * @since bbPress (r3926)
+     * @param string $property
+     * @param mixed $value
+     * @return mixed
      */
-    public $version = '';
+    public function __set( $property, $value ) {
+        return $this->_data[$property] = $value;
+    }
 
     /**
-     * @var string Path to theme
+     * Get a theme's property.
+     *
+     * @since bbPress (r3926)
+     * @param string $property
+     * @param mixed $value
+     * @return mixed
      */
-    public $dir = '';
-
-    /**
-     * @var string URL to theme
-     */
-    public $url = '';
+    public function __get( $property ) {
+        return array_key_exists( $property, $this->_data ) ? $this->_data[$property] : '';
+    }
 }
 
@@ -206 +229 @@
 
     return bbpress()->theme_compat->template;
+}
+
+/**
+ * Set the theme compat original_template global
+ *
+ * Stash the original template file for the current query. Useful for checking
+ * if bbPress was able to find a more appropriate template.
+ *
+ * @since bbPress (r3926)
+ */
+function bbp_set_theme_compat_original_template( $template = '' ) {
+    bbpress()->theme_compat->original_template = $template;
+
+    return bbpress()->theme_compat->original_template;
+}
+
+/**
+ * Set the theme compat original_template global
+ *
+ * Stash the original template file for the current query. Useful for checking
+ * if bbPress was able to find a more appropriate template.
+ *
+ * @since bbPress (r3926)
+ */
+function bbp_is_theme_compat_original_template( $template = '' ) {
+    $bbp = bbpress();
+
+    if ( empty( $bbp->theme_compat->original_template ) )
+        return false;
+
+    return (bool) ( $bbp->theme_compat->original_template == $template );
 }
 
@@ -341 +395 @@
 function bbp_template_include_theme_compat( $template = '' ) {
 
-    // Only filter the main query
-    if ( ! is_main_query() )
+    // Bail if the template doesn't specifically match a bbPress template. This
+    // includes archive-* and single-* WordPress post_type matches, allowing
+    // themes to use the expected format.
+    if ( bbp_is_theme_compat_original_template( $template ) )
         return $template;
 
@@ -739 +795 @@
         if ( !apply_filters( 'bbp_spill_the_beans', false ) ) {
 
-            // Setup the chopping block
-            global $withcomments, $post;
-
-            // Empty out globals that aren't being used in this loop anymore
-            $withcomments = $post = false;
+            // Empty globals that aren't being used in this loop anymore
+            $GLOBALS['withcomments'] = false;
+            $GLOBALS['post']         = false;
 
             // Reset the post data when the next sidebar is fired