Changeset 9451

Timestamp:

02/08/2015 11:09:16 PM (10 years ago)

Author:

tw2113

Message:

Adds hooks documentation to bp-groups-actions.php.

See #5943.

File:

• trunk/src/bp-groups/bp-groups-actions.php (modified) (6 diffs)

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

@@ -192 +192 @@
             }
 
-            // Set the invite status
-            // Checked against a whitelist for security
+            /**
+             * Filters the allowed invite statuses.
+             *
+             * @since BuddyPress (1.5.0)
+             *
+             * @param array $value Array of statuses allowed.
+             *                     Possible values are 'members,
+             *                     'mods', and 'admins'.
+             */
             $allowed_invite_status = apply_filters( 'groups_allowed_invite_status', array( 'members', 'mods', 'admins' ) );
             $invite_status         = !empty( $_POST['group-invite-status'] ) && in_array( $_POST['group-invite-status'], (array) $allowed_invite_status ) ? $_POST['group-invite-status'] : 'members';
@@ -213 +220 @@
         }
 
+        /**
+         * Fires before finalization of group creation and cookies are set.
+         *
+         * This hook is a variable hook dependent on the current step
+         * in the creation process.
+         *
+         * @since BuddyPress (1.1.0)
+         */
         do_action( 'groups_create_group_step_save_' . bp_get_groups_current_create_step() );
-        do_action( 'groups_create_group_step_complete' ); // Mostly for clearing cache on a generic action name
+
+        /**
+         * Fires after the group creation step is completed.
+         *
+         * Mostly for clearing cache on a generic action name.
+         *
+         * @since BuddyPress (1.1.0)
+         */
+        do_action( 'groups_create_group_step_complete' );
 
         /**
@@ -245 +268 @@
             ) );
 
+            /**
+             * Fires after the group has been successfully created.
+             *
+             * @since BuddyPress (1.1.0)
+             *
+             * @param int $new_group_id ID of the newly created group.
+             */
             do_action( 'groups_group_create_complete', $bp->groups->new_group_id );
 
@@ -316 +346 @@
     }
 
+    /**
+     * Filters the template to load for the group creation screen.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param string $value Path to the group creation template to load.
+     */
     bp_core_load_template( apply_filters( 'groups_template_create_group', 'groups/create' ) );
 }
@@ -353 +390 @@
     }
 
+    /**
+     * Filters the template to load for the single group screen.
+     *
+     * @since BuddyPress (1.0.0)
+     *
+     * @param string $value Path to the single group template to load.
+     */
     bp_core_load_template( apply_filters( 'groups_template_group_home', 'groups/single/home' ) );
 }
@@ -402 +446 @@
     }
 
+    /** This filter is documented in bp-groups/bp-groups-actions.php */
     bp_core_load_template( apply_filters( 'groups_template_group_home', 'groups/single/home' ) );
 }