Changeset 2995

Timestamp:

05/13/2010 07:15:34 PM (15 years ago)

Author:

johnjamesjacoby

Message:

Fixes #1921 (plus phpdoc'ed for good measure)

File:

• branches/1.2/bp-groups/bp-groups-templatetags.php (modified) (1 diff)

branches/1.2/bp-groups/bp-groups-templatetags.php

@@ -957 +957 @@
 }
 
+/**
+ * bp_group_is_member()
+ *
+ * Checks if current user is member of a group.
+ *
+ * @uses is_site_admin Check if current user is super admin
+ * @uses apply_filters Creates bp_group_is_member filter and passes $is_member
+ * @usedby groups/activity.php, groups/single/forum/edit.php, groups/single/forum/topic.php to determine template part visibility
+ * @global array $bp BuddyPress Master global
+ * @global object $groups_template Current Group (usually in template loop)
+ * @param object $group Group to check is_member
+ * @return bool If user is member of group or not
+ */
 function bp_group_is_member( $group = false ) {
     global $bp, $groups_template;
 
+    // Site admins always have access
     if ( is_site_admin() )
         return true;
 
+    // Load group if none passed
     if ( !$group )
         $group =& $groups_template->group;
 
+    // Check membership
     if ( null == $group->is_member )
-        return false;
-
-    return true;
+        $is_member = false;
+    else
+        $is_member = true;
+
+    // Return
+    return apply_filters( 'bp_group_is_member', $is_member );
 }