Changeset 9454

Timestamp:

02/08/2015 11:20:04 PM (12 years ago)

Author:

tw2113

Message:

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

See #5943.

File:

• trunk/src/bp-groups/bp-groups-loader.php (modified) (7 diffs)

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

@@ -179 +179 @@
 
                         $bp->is_single_item  = true;
+
+                        /**
+                         * Filters the current PHP Class being used.
+                         *
+                         * @since BuddyPress (1.5.0)
+                         *
+                         * @param string $value Name of the class being used.
+                         */
                         $current_group_class = apply_filters( 'bp_groups_current_group_class', 'BP_Groups_Group' );
 
@@ -188 +196 @@
 
                         } else {
+
+                                /**
+                                 * Filters the current group object being instantiated from previous filter.
+                                 *
+                                 * @since BuddyPress (1.5.0)
+                                 *
+                                 * @param object $value Newly instantiated object for the group.
+                                 */
                                 $this->current_group = apply_filters( 'bp_groups_current_group_object', new $current_group_class( $group_id ) );
                         }
@@ -234 +250 @@
                 }
 
-                // Illegal group names/slugs
+                /**
+                 * Filters the list of illegal groups names/slugs.
+                 *
+                 * @since BuddyPress (1.0.0)
+                 *
+                 * @param array $value Array of illegal group names/slugs.
+                 */
                 $this->forbidden_names = apply_filters( 'groups_forbidden_names', array(
                         'my-groups',
@@ -258 +280 @@
                 }
 
-                // Preconfigured group creation steps
+                /**
+                 * Filters the preconfigured groups creation steps.
+                 *
+                 * @since BuddyPress (1.1.0)
+                 *
+                 * @param array $value Array of preconfigured group creation steps.
+                 */
                 $this->group_creation_steps = apply_filters( 'groups_create_group_steps', array(
                         'group-details'  => array(
@@ -286 +314 @@
                 }
 
-                // Groups statuses
+                /**
+                 * Filters the list of valid groups statuses.
+                 *
+                 * @since BuddyPress (1.1.0)
+                 *
+                 * @param array $value Array of valid group statuses.
+                 */
                 $this->valid_status = apply_filters( 'groups_valid_status', array(
                         'public',
@@ -312 +346 @@
 
 
+                /**
+                 * Filters the default groups extension.
+                 *
+                 * @since BuddyPress (1.6.0)
+                 *
+                 * @param string $value BP_GROUPS_DEFAULT_EXTENSION constant if defined,
+                 *                      else 'home'.
+                 */
                 $this->default_extension = apply_filters( 'bp_groups_default_extension', defined( 'BP_GROUPS_DEFAULT_EXTENSION' ) ? BP_GROUPS_DEFAULT_EXTENSION : 'home' );
 
@@ -565 +607 @@
 
                 if ( isset( $this->current_group->user_has_access ) ) {
+
+                        /**
+                         * Fires at the end of the groups navigation setup if user has access.
+                         *
+                         * @since BuddyPress (1.0.2)
+                         *
+                         * @param bool $user_has_access Whether or not user has access.
+                         */
                         do_action( 'groups_setup_nav', $this->current_group->user_has_access );
                 } else {
+
+                        /** This action is documented in bp-groups/bp-groups-loader.php */
                         do_action( 'groups_setup_nav');
                 }