Changeset 9057

Timestamp:

09/30/2014 01:57:50 AM (10 years ago)

Author:

boonebgorges

Message:

Improved documentation in bp-groups-template.php

See #5022

File:

• trunk/src/bp-groups/bp-groups-template.php (modified) (14 diffs)

trunk/src/bp-groups/bp-groups-template.php

@@ -2287 +2287 @@
     }
 
+/**
+ * HTML admin subnav items for group pages.
+ *
+ * @param object $group Optional. Group object. Default: current group in
+ *        the loop.
+ */
 function bp_group_admin_tabs( $group = false ) {
     global $groups_template;
@@ -2328 +2334 @@
 }
 
+/**
+ * Output the group count for the displayed user.
+ */
 function bp_group_total_for_member() {
     echo bp_get_group_total_for_member();
 }
+    /**
+     * Get the group count for the displayed user.
+     *
+     * @return string
+     */
     function bp_get_group_total_for_member() {
         return apply_filters( 'bp_get_group_total_for_member', BP_Groups_Member::total_group_count() );
     }
 
+/**
+ * Output the 'action' attribute for a group form.
+ *
+ * @param string $page Page slug.
+ */
 function bp_group_form_action( $page ) {
     echo bp_get_group_form_action( $page );
 }
+    /**
+     * Generate the 'action' attribute for a group form.
+     *
+     * @param string $page Page slug.
+     * @param object $group Optional. Group object. Default: current group
+     *        in the loop.
+     * @return string
+     */
     function bp_get_group_form_action( $page, $group = false ) {
         global $groups_template;
@@ -2347 +2374 @@
     }
 
+/**
+ * Output the 'action' attribute for a group admin form.
+ *
+ * @param string $page Optional. Page slug.
+ */
 function bp_group_admin_form_action( $page = false ) {
     echo bp_get_group_admin_form_action( $page );
 }
+    /**
+     * Generate the 'action' attribute for a group admin form.
+     *
+     * @param string $page Optional. Page slug.
+     * @param object $group Optional. Group object. Default: current group
+     *        in the loop.
+     * @return string
+     */
     function bp_get_group_admin_form_action( $page = false, $group = false ) {
         global $groups_template;
@@ -2362 +2402 @@
     }
 
+/**
+ * Determine whether the logged-in user has requested membership to a group.
+ *
+ * @param object $group Optional. Group object. Default: current group in
+ *        the loop.
+ * @return bool
+ */
 function bp_group_has_requested_membership( $group = false ) {
     global $groups_template;
@@ -2375 +2422 @@
 
 /**
- * bp_group_is_member()
- *
- * Checks if current user is member of a group.
- *
- * @uses bp_current_user_can() 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 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
+ * Check if current user is member of a group.
+ *
+ * @global object $groups_template
+ *
+ * @param object $group Optional. Group to check is_member. Default: current
+ *        group in the loop.
+ * @return bool If user is member of group or not.
  */
 function bp_group_is_member( $group = false ) {
@@ -2402 +2446 @@
  * Check whether the current user has an outstanding invite to the current group in the loop.
  *
- * @param object $group Optional. Group data object. Defaults to the current
+ * @param object $group Optional. Group data object. Default: the current
  *        group in the groups loop.
  * @return bool True if the user has an outstanding invite, otherwise false.
@@ -2470 +2514 @@
 }
 
+/**
+ * Output the URL for accepting an invitation to the current group in the loop.
+ */
 function bp_group_accept_invite_link() {
     echo bp_get_group_accept_invite_link();
 }
+    /**
+     * Generate the URL for accepting an invitation to a group.
+     *
+     * @param object $group Optional. Group object. Default: Current group
+     *        in the loop.
+     * @return string
+     */
     function bp_get_group_accept_invite_link( $group = false ) {
         global $groups_template, $bp;
@@ -2482 +2536 @@
     }
 
+/**
+ * Output the URL for accepting an invitation to the current group in the loop.
+ */
 function bp_group_reject_invite_link() {
     echo bp_get_group_reject_invite_link();
 }
+    /**
+     * Generate the URL for rejecting an invitation to a group.
+     *
+     * @param object $group Optional. Group object. Default: Current group
+     *        in the loop.
+     * @return string
+     */
     function bp_get_group_reject_invite_link( $group = false ) {
         global $groups_template, $bp;
@@ -2494 +2558 @@
     }
 
+/**
+ * Output the URL for confirming a request to leave a group.
+ */
 function bp_group_leave_confirm_link() {
     echo bp_get_group_leave_confirm_link();
 }
+    /**
+     * Generate the URL for confirming a request to leave a group.
+     *
+     * @param object $group Optional. Group object. Default: Current group
+     *        in the loop.
+     * @return string
+     */
     function bp_get_group_leave_confirm_link( $group = false ) {
         global $groups_template;
@@ -2506 +2580 @@
     }
 
+/**
+ * Output the URL for rejecting a request to leave a group.
+ */
 function bp_group_leave_reject_link() {
     echo bp_get_group_leave_reject_link();
 }
+    /**
+     * Generate the URL for rejecting a request to leave a group.
+     *
+     * @param object $group Optional. Group object. Default: Current group
+     *        in the loop.
+     * @return string
+     */
     function bp_get_group_leave_reject_link( $group = false ) {
         global $groups_template;
@@ -2518 +2602 @@
     }
 
+/**
+ * Output the 'action' attribute for a group send invite form.
+ */
 function bp_group_send_invite_form_action() {
     echo bp_get_group_send_invite_form_action();
 }
+    /**
+     * Output the 'action' attribute for a group send invite form.
+     *
+     * @param object $page Optional. Group object. Default: current group
+     *        in the loop.
+     * @return string
+     */
     function bp_get_group_send_invite_form_action( $group = false ) {
         global $groups_template;
@@ -2530 +2624 @@
     }
 
+/**
+ * Determine whether the current user has friends to invite to a group.
+ *
+ * @param object $group Optional. Group object. Default: current group in
+ *        the loop.
+ * @return bool
+ */
 function bp_has_friends_to_invite( $group = false ) {
     global $groups_template;
@@ -2546 +2647 @@
 
 /**
- * Outputs a 'New Topic' button for a group.
+ * Output a 'New Topic' button for a group.
  *
  * @since BuddyPress (1.2.7)
  *
- * @param BP_Groups_Group|bool $group The BP Groups_Group object if passed, boolean false if not passed.
- * @uses bp_get_group_new_topic_button() Returns the 'New Topic' button
+ * @param BP_Groups_Group|bool $group The BP Groups_Group object if passed,
+ *        boolean false if not passed.
  */
 function bp_group_new_topic_button( $group = false ) {
@@ -2561 +2662 @@
      * @since BuddyPress (1.2.7)
      *
-     * @param BP_Groups_Group|bool $group The BP Groups_Group object if passed, boolean false if not passed.
-     * @uses is_user_logged_in() Is there a user logged in?
-     * @uses bp_group_is_user_banned() Is the current user banned from the current group?
-     * @uses bp_is_group_forum() Are we on a group forum page?
-     * @uses bp_is_group_forum_topic() Are we on a group topic page?
-     * @uses bp_get_button() Renders a button
-     * @return string HTML code for the button
+     * @param BP_Groups_Group|bool $group The BP Groups_Group object if
+     *        passed, boolean false if not passed.
+     * @return string HTML code for the button.
      */
     function bp_get_group_new_topic_button( $group = false ) {