Changeset 3902 for branches/plugin/bbp-includes/bbp-common-template.php

Timestamp:

05/15/2012 05:15:22 AM (12 years ago)

Author:

johnjamesjacoby

Message:

Common:

• Audit _is_ functions and make sure they return and filter correctly.
• Add descriptions to phpdoc headers of common files.

File:

• branches/plugin/bbp-includes/bbp-common-template.php (modified) (6 diffs)

branches/plugin/bbp-includes/bbp-common-template.php

@@ -3 +3 @@
 /**
  * bbPress Common Template Tags
+ *
+ * Common template tags are ones that are used by more than one component, like
+ * forums, topics, replies, users, topic tags, etc...
  *
  * @package bbPress
@@ -293 +296 @@
  */
 function bbp_is_topic_tag() {
-    $bbp = bbpress();
 
     // Return false if editing a topic tag
@@ -325 +327 @@
     // Check query
     if ( !empty( $wp_query->bbp_is_topic_tag_edit ) && ( true == $wp_query->bbp_is_topic_tag_edit ) )
-        return true;
+        $retval = true;
 
     // Editing in admin
@@ -348 +350 @@
 function bbp_is_custom_post_type() {
 
-    // Current post type
-    $post_type = get_post_type();
-
-    // bbPress post types
-    $bbp_post_types = array(
+    // Assume false
+    $retval = false;
+
+    // Viewing one of the bbPress post types
+    if ( in_array( get_post_type(), array(
         bbp_get_forum_post_type(),
         bbp_get_topic_post_type(),
         bbp_get_reply_post_type()
-    );
-
-    // Viewing one of the bbPress post types
-    if ( in_array( $post_type, $bbp_post_types ) )
-        return true;
-
-    return false;
+    ) ) )
+        $retval = true;
+
+    return (bool) apply_filters( 'bbp_is_custom_post_type', $retval );
 }
 
@@ -403 +402 @@
     // Check query
     if ( !empty( $wp_query->bbp_is_reply_edit ) && ( true == $wp_query->bbp_is_reply_edit ) )
-        return true;
+        $retval = true;
 
     // Editing in admin
@@ -820 +819 @@
     /** Done ******************************************************************/
 
-    return apply_filters( 'is_bbpress', $retval );
+    return (bool) apply_filters( 'is_bbpress', $retval );
 }