Changeset 9490

Timestamp:

02/17/2015 06:23:02 AM (10 years ago)

Author:

tw2113

Message:

Adds hooks documentation for bp-groups-functions.php.

See #5943.

File:

• trunk/src/bp-groups/bp-groups-functions.php (modified) (28 diffs)

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

@@ -57 +57 @@
     $group = new BP_Groups_Group( $r['group_id'], $group_args );
 
+    /**
+     * Filters a single group object.
+     *
+     * @since BuddyPress (1.2.0)
+     *
+     * @param BP_Groups_Group $group Single group object.
+     */
     return apply_filters( 'groups_get_group', $group );
 }
@@ -161 +168 @@
         groups_update_groupmeta( $group->id, 'last_activity', bp_core_current_time() );
 
+        /**
+         * Fires after the creation of a new group and a group creator needs to be made.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param int              $id     ID of the newly created group.
+         * @param BP_Groups_Member $member Instance of the member who is assigned
+         *                                 as group creator.
+         * @param BP_Groups_Group  $group  Instance of the group being created.
+         */
         do_action( 'groups_create_group', $group->id, $member, $group );
 
     } else {
+
+        /**
+         * Fires after the update of a group.
+         *
+         * @since BuddyPress (1.5.0)
+         *
+         * @param int             $id    ID of the updated group.
+         * @param BP_Groups_Group $group Instance of the group being updated.
+         */
         do_action( 'groups_update_group', $group->id, $group );
     }
 
+    /**
+     * Fires after the creation of a group.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int             $id    ID of the newly created group.
+     * @param BP_Groups_Group $group Instance of the group being updated.
+     */
     do_action( 'groups_created_group', $group->id, $group );
 
@@ -260 +294 @@
 
     groups_update_groupmeta( $group->id, 'last_activity', bp_core_current_time() );
+
+    /**
+     * Fires after the update of a groups settings.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $id ID of the group that was updated.
+     */
     do_action( 'groups_settings_updated', $group->id );
 
@@ -275 +317 @@
 function groups_delete_group( $group_id ) {
 
+    /**
+     * Fires before the deletion of a group.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param int $group_id ID of the group to be deleted.
+     */
     do_action( 'groups_before_delete_group', $group_id );
 
@@ -288 +337 @@
     groups_delete_all_group_invites( $group_id );
 
+    /**
+     * Fires after the deletion of a group.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $group_id ID of the group that was deleted.
+     */
     do_action( 'groups_delete_group', $group_id );
 
@@ -383 +439 @@
     bp_core_add_message( __( 'You successfully left the group.', 'buddypress' ) );
 
+    /**
+     * Fires after a user leaves a group.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $group_id ID of the group.
+     * @param int $user_id  ID of the user leaving the group.
+     */
     do_action( 'groups_leave_group', $group_id, $user_id );
 
@@ -442 +506 @@
     groups_update_groupmeta( $group_id, 'last_activity', bp_core_current_time() );
 
+    /**
+     * Fires after a user joins a group.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $group_id ID of the group.
+     * @param int $user_id  ID of the user joining the group.
+     */
     do_action( 'groups_join_group', $group_id, $user_id );
 
@@ -635 +707 @@
     ) );
 
+    /**
+     * Filters the collection of groups based on parsed parameters.
+     *
+     * @since BuddyPress (1.2.0)
+     *
+     *
+     * @param BP_Groups_Group $groups Object of found groups based on parameters.
+     *                                Passed by reference.
+     * @param array           $r      Array of parsed arguments used for group query.
+     *                                Passed by reference.
+     */
     return apply_filters_ref_array( 'groups_get_groups', array( &$groups, &$r ) );
 }
@@ -710 +793 @@
         : false;
 
+    /**
+     * Filters the BP_Groups_Group object corresponding to the current group.
+     *
+     * @since BuddyPress (1.5.0)
+     *
+     * @param BP_Groups_Group $current_group Current BP_Groups_Group object.
+     */
     return apply_filters( 'groups_get_current_group', $current_group );
 }
@@ -738 +828 @@
     $newsubdir = '/group-avatars/' . $group_id;
 
+    /**
+     * Filters the avatar upload directory path for a given group.
+     *
+     * @since BuddyPress (1.1.0)
+     *
+     * @param array $value Array of parts related to the groups avatar upload directory.
+     */
     return apply_filters( 'groups_avatar_upload_dir', array( 'path' => $path, 'url' => $newurl, 'subdir' => $newsubdir, 'basedir' => $newbdir, 'baseurl' => $newburl, 'error' => false ) );
 }
@@ -838 +935 @@
     $activity_content = $content;
 
+    /**
+     * Filters the action for the new group activity update.
+     *
+     * @since BuddyPress (1.2.0)
+     *
+     * @param string $activity_action The new group activity update.
+     */
+    $action = apply_filters( 'groups_activity_new_update_action',  $activity_action  );
+
+    /**
+     * Filters the content for the new group activity update.
+     *
+     * @since BuddyPress (1.2.0)
+     *
+     * @param string $activity_content The content of the update.
+     */
+    $content_filtered = apply_filters( 'groups_activity_new_update_content', $activity_content );
+
     $activity_id = groups_record_activity( array(
         'user_id' => $user_id,
-        'action'  => apply_filters( 'groups_activity_new_update_action',  $activity_action  ),
-        'content' => apply_filters( 'groups_activity_new_update_content', $activity_content ),
+        'action'  => $action,
+        'content' => $content_filtered,
         'type'    => 'activity_update',
         'item_id' => $group_id
@@ -847 +962 @@
 
     groups_update_groupmeta( $group_id, 'last_activity', bp_core_current_time() );
+
+    /**
+     * Fires after posting of an Activity status update affiliated with a group.
+     *
+     * @since BuddyPress (1.2.0)
+     *
+     * @param string $content     The content of the update.
+     * @param int    $user_id     ID of the user posting the update.
+     * @param int    $group_id    ID of the group being posted to.
+     * @param bool   $activity_id Whether or not the activity recording succeeded.
+     */
     do_action( 'bp_groups_posted_update', $content, $user_id, $group_id, $activity_id );
 
@@ -934 +1060 @@
             return false;
 
+        /**
+         * Fires after the creation of a new group invite.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param array $args Array of parsed arguments for the group invite.
+         */
         do_action( 'groups_invite_user', $args );
     }
@@ -954 +1087 @@
         return false;
 
+    /**
+     * Fires after uninviting a user from a group.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $group_id ID of the group being uninvited from.
+     * @param int $user_id  ID of the user being uninvited.
+     */
     do_action( 'groups_uninvite_user', $group_id, $user_id );
 
@@ -999 +1140 @@
     groups_update_groupmeta( $group_id, 'last_activity', bp_core_current_time() );
 
+    /**
+     * Fires after a user has accepted a group invite.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $user_id  ID of the user who accepted the group invite.
+     * @param int $group_id ID of the group being accepted to.
+     */
     do_action( 'groups_accept_invite', $user_id, $group_id );
 
@@ -1015 +1164 @@
         return false;
 
+    /**
+     * Fires after a user rejects a group invitation.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $user_id  ID of the user rejecting the invite.
+     * @param int $group_id ID of the group being rejected.
+     */
     do_action( 'groups_reject_invite', $user_id, $group_id );
 
@@ -1031 +1188 @@
         return false;
 
+    /**
+     * Fires after the deletion of a group invitation.
+     *
+     * @since BuddyPress (1.9.0)
+     *
+     * @param int $user_id  ID of the user whose invitation is being deleted.
+     * @param int $group_id ID of the group whose invitation is being deleted.
+     */
     do_action( 'groups_delete_invite', $user_id, $group_id );
 
@@ -1061 +1226 @@
     }
 
+    /**
+     * Fires after the sending of invites for a group.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int   $group_id      ID of the group who's being invited to.
+     * @param array $invited_users Array of users being invited to the group.
+     */
     do_action( 'groups_send_invites', $group_id, $invited_users );
 }
@@ -1123 +1296 @@
     do_action( 'groups_premote_member', $group_id, $user_id, $status );
 
-    // Use this action instead.
+    /**
+     * Fires before the promotion of a user to a new status.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param int    $group_id ID of the group being promoted in.
+     * @param int    $user_id  ID of the user being promoted.
+     * @param string $status   New status being promoted to.
+     */
     do_action( 'groups_promote_member', $group_id, $user_id, $status );
 
@@ -1143 +1324 @@
     $member = new BP_Groups_Member( $user_id, $group_id );
 
+    /**
+     * Fires before the demotion of a user to 'member'.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $group_id ID of the group being demoted in.
+     * @param int $user_id  ID of the user being demoted.
+     */
     do_action( 'groups_demote_member', $group_id, $user_id );
 
@@ -1162 +1351 @@
     $member = new BP_Groups_Member( $user_id, $group_id );
 
+    /**
+     * Fires before the banning of a member from a group.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $group_id ID of the group being banned from.
+     * @param int $user_id  ID of the user being banned.
+     */
     do_action( 'groups_ban_member', $group_id, $user_id );
 
@@ -1181 +1378 @@
     $member = new BP_Groups_Member( $user_id, $group_id );
 
+    /**
+     * Fires before the unbanning of a member from a group.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int $group_id ID of the group being unbanned from.
+     * @param int $user_id  ID of the user being unbanned.
+     */
     do_action( 'groups_unban_member', $group_id, $user_id );
 
@@ -1202 +1407 @@
     $member = new BP_Groups_Member( $user_id, $group_id );
 
+    /**
+     * Fires before the removal of a member from a group.
+     *
+     * @since BuddyPress (1.2.6)
+     *
+     * @param int $group_id ID of the group being removed from.
+     * @param int $user_id  ID of the user being removed.
+     */
     do_action( 'groups_remove_member', $group_id, $user_id );
 
@@ -1249 +1462 @@
             groups_notification_new_membership_request( $requesting_user_id, $admins[$i]->user_id, $group_id, $requesting_user->id );
 
+        /**
+         * Fires after the creation of a new membership request.
+         *
+         * @since BuddyPress (1.0.0)
+         *
+         * @param int   $requesting_user_id  ID of the user requesting membership.
+         * @param array $admins              Array of group admins.
+         * @param int   $group_id            ID of the group being requested to.
+         * @param int   $requesting_user->id ID of the user requesting membership.
+         */
         do_action( 'groups_membership_requested', $requesting_user_id, $admins, $group_id, $requesting_user->id );
 
@@ -1287 +1510 @@
     }
 
+    /**
+     * Fires after a group membership request has been accepted.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int  $user_id  ID of the user who accepted membership.
+     * @param int  $group_id ID of the group that was accepted membership to.
+     * @param bool $value    If membership was accepted.
+     */
     do_action( 'groups_membership_accepted', $membership->user_id, $membership->group_id, true );
 
@@ -1308 +1540 @@
     }
 
+    /**
+     * Fires after a group membership request has been rejected.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param int  $user_id  ID of the user who rejected membership.
+     * @param int  $group_id ID of the group that was rejected membership to.
+     * @param bool $value    If membership was accepted.
+     */
     do_action( 'groups_membership_rejected', $membership->user_id, $membership->group_id, false );
 
@@ -1362 +1603 @@
         groups_accept_membership_request( false, $user_id, $group_id );
 
+    /**
+     * Fires after the acceptance of all pending membership requests to a group.
+     *
+     * @since BuddyPress (1.0.2)
+     *
+     * @param int $group_id ID of the group whose pending memberships were accepted.
+     */
     do_action( 'groups_accept_all_pending_membership_requests', $group_id );
 
@@ -1480 +1728 @@
     BP_Groups_Member::delete_all_for_user( $user_id );
 
+    /**
+     * Fires after the deletion of all data for a user.
+     *
+     * @since BuddyPress (1.1.0)
+     *
+     * @param int $user_id ID of the user whose data is being deleted.
+     */
     do_action( 'groups_remove_data_for_user', $user_id );
 }