Changeset 6551 for trunk/src/includes/core/theme-compat.php

Timestamp:

06/15/2017 04:31:59 AM (9 years ago)

Author:

johnjamesjacoby

Message:

Theme Compat: Improve loading & support for external template packs.

• Better error handling if tempate pack is broken, unloaded, or missing
• Consolidate favs & subs code to use the same central handlers, by passing an object_id and object_type around (for future support of term subscriptions)
• Rename data addtributes from previous BuddyPress favs & subs fixes
• Adjust load order of template pack setup so that it's as late as possible, allowing template pack authors more time to get registered
• Automatically add the current template pack to the template stack (multiple packs can still be layered, and this improves support for that)
• Merge topic.js and forum.js in "bbPress Default" template pack to use the same engagements.js script, which simplifies localization & uses 1 less script between pages

This change puts the finishing touches on favs & subs consolidation for 2.6, and updates several related & surrounding functions to better support the necessary mark-up changes.

File:

• trunk/src/includes/core/theme-compat.php (modified) (11 diffs)

trunk/src/includes/core/theme-compat.php

@@ -29 +29 @@
  *
  * This is only intended to be extended, and is included here as a basic guide
- * for future Theme Packs to use. @link BBP_Twenty_Ten is a good example of
- * extending this class, as is @link bbp_setup_theme_compat()
+ * for future Template Packs to use. @link bbp_setup_theme_compat()
  *
  * @since 2.0.0 bbPress (r3506)
@@ -88 +87 @@
                         : '';
         }
+
+        /**
+         * Return the template directory.
+         *
+         * @since 2.6.0 bbPress (r6548)
+         *
+         * @return string
+         */
+        public function get_dir() {
+                return $this->dir;
+        }
 }
 
@@ -93 +103 @@
 
 /**
- * Setup the default theme compat theme
+ * Setup the active template pack and register it's directory in the stack.
  *
  * @since 2.0.0 bbPress (r3311)
@@ -99 +109 @@
  * @param BBP_Theme_Compat $theme
  */
-function bbp_setup_theme_compat( $theme = '' ) {
+function bbp_setup_theme_compat( $theme = 'default' ) {
         $bbp = bbpress();
 
-        // Make sure theme package is available, set to default if not
-        if ( ! isset( $bbp->theme_compat->packages[ $theme ] ) || ! is_a( $bbp->theme_compat->packages[ $theme ], 'BBP_Theme_Compat' ) ) {
+        // Bail if something already has this under control
+        if ( ! empty( $bbp->theme_compat->theme ) ) {
+                return;
+        }
+
+        // Fallback for empty theme
+        if ( empty( $theme ) ) {
                 $theme = 'default';
         }
 
-        // Try to set the active theme compat theme. If it's not in the registered
-        // packages array, it doesn't exist, so do nothing with it.
+        // If the theme is registered, use it and add it to the stack
         if ( isset( $bbp->theme_compat->packages[ $theme ] ) ) {
                 $bbp->theme_compat->theme = $bbp->theme_compat->packages[ $theme ];
-        }
+
+                // Setup the template stack for the active template pack
+                bbp_register_template_stack( array( $bbp->theme_compat->theme, 'get_dir' ) );
+        }
+}
+
+/**
+ * Get the current template pack package.
+ *
+ * @since 2.6.0 bbPress (r6548)
+ *
+ * @return BBP_Theme_Compat
+ */
+function bbp_get_current_template_pack() {
+        $bbp = bbpress();
+
+        // Theme was not setup, so fallback to an empty object
+        if ( empty( $bbp->theme_compat->theme ) ) {
+                $bbp->theme_compat->theme = new BBP_Theme_Compat();
+        }
+
+        // Filter & return
+        return apply_filters( 'bbp_get_current_template_pack', $bbp->theme_compat->theme );
+}
+
+/**
+ * Gets the id of the bbPress compatible theme used, in the event the
+ * currently active WordPress theme does not explicitly support bbPress.
+ * This can be filtered or set manually. Tricky theme authors can override the
+ * default and include their own bbPress compatibility layers for their themes.
+ *
+ * @since 2.0.0 bbPress (r3506)
+ *
+ * @uses apply_filters()
+ * @return string
+ */
+function bbp_get_theme_compat_id() {
+
+        // Filter & return
+        return apply_filters( 'bbp_get_theme_compat_id', bbp_get_current_template_pack()->id );
 }
 
@@ -125 +178 @@
  * @return string
  */
-function bbp_get_theme_compat_id() {
+function bbp_get_theme_compat_name() {
 
         // Filter & return
-        return apply_filters( 'bbp_get_theme_compat_id', bbpress()->theme_compat->theme->id );
-}
-
-/**
- * Gets the name of the bbPress compatible theme used, in the event the
- * currently active WordPress theme does not explicitly support bbPress.
- * This can be filtered or set manually. Tricky theme authors can override the
- * default and include their own bbPress compatibility layers for their themes.
- *
- * @since 2.0.0 bbPress (r3506)
- *
- * @uses apply_filters()
- * @return string
- */
-function bbp_get_theme_compat_name() {
-
-        // Filter & return
-        return apply_filters( 'bbp_get_theme_compat_name', bbpress()->theme_compat->theme->name );
+        return apply_filters( 'bbp_get_theme_compat_name', bbp_get_current_template_pack()->name );
 }
 
@@ -162 +198 @@
 
         // Filter & return
-        return apply_filters( 'bbp_get_theme_compat_version', bbpress()->theme_compat->theme->version );
+        return apply_filters( 'bbp_get_theme_compat_version', bbp_get_current_template_pack()->version );
 }
 
@@ -179 +215 @@
 
         // Filter & return
-        return apply_filters( 'bbp_get_theme_compat_dir', bbpress()->theme_compat->theme->dir );
+        return apply_filters( 'bbp_get_theme_compat_dir', bbp_get_current_template_pack()->dir );
 }
 
@@ -196 +232 @@
 
         // Filter & return
-        return apply_filters( 'bbp_get_theme_compat_url', bbpress()->theme_compat->theme->url );
+        return apply_filters( 'bbp_get_theme_compat_url', bbp_get_current_template_pack()->url );
 }
 
@@ -273 +309 @@
 
 /**
- * Set the theme compat original_template global
+ * Is a template the original_template global
  *
  * Stash the original template file for the current query. Useful for checking
@@ -283 +319 @@
         $bbp = bbpress();
 
+        // Bail if no original template
         if ( empty( $bbp->theme_compat->original_template ) ) {
                 return false;
@@ -317 +354 @@
         }
 }
+
 /**
  * This fun little function fills up some WordPress globals with dummy data to