Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
02/08/2015 11:20:04 PM (5 years ago)
Author:
tw2113
Message:

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

See #5943.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-groups/bp-groups-loader.php

    r9351 r9454  
    179179
    180180            $bp->is_single_item  = true;
     181
     182            /**
     183             * Filters the current PHP Class being used.
     184             *
     185             * @since BuddyPress (1.5.0)
     186             *
     187             * @param string $value Name of the class being used.
     188             */
    181189            $current_group_class = apply_filters( 'bp_groups_current_group_class', 'BP_Groups_Group' );
    182190
     
    188196
    189197            } else {
     198
     199                /**
     200                 * Filters the current group object being instantiated from previous filter.
     201                 *
     202                 * @since BuddyPress (1.5.0)
     203                 *
     204                 * @param object $value Newly instantiated object for the group.
     205                 */
    190206                $this->current_group = apply_filters( 'bp_groups_current_group_object', new $current_group_class( $group_id ) );
    191207            }
     
    234250        }
    235251
    236         // Illegal group names/slugs
     252        /**
     253         * Filters the list of illegal groups names/slugs.
     254         *
     255         * @since BuddyPress (1.0.0)
     256         *
     257         * @param array $value Array of illegal group names/slugs.
     258         */
    237259        $this->forbidden_names = apply_filters( 'groups_forbidden_names', array(
    238260            'my-groups',
     
    258280        }
    259281
    260         // Preconfigured group creation steps
     282        /**
     283         * Filters the preconfigured groups creation steps.
     284         *
     285         * @since BuddyPress (1.1.0)
     286         *
     287         * @param array $value Array of preconfigured group creation steps.
     288         */
    261289        $this->group_creation_steps = apply_filters( 'groups_create_group_steps', array(
    262290            'group-details'  => array(
     
    286314        }
    287315
    288         // Groups statuses
     316        /**
     317         * Filters the list of valid groups statuses.
     318         *
     319         * @since BuddyPress (1.1.0)
     320         *
     321         * @param array $value Array of valid group statuses.
     322         */
    289323        $this->valid_status = apply_filters( 'groups_valid_status', array(
    290324            'public',
     
    312346
    313347
     348        /**
     349         * Filters the default groups extension.
     350         *
     351         * @since BuddyPress (1.6.0)
     352         *
     353         * @param string $value BP_GROUPS_DEFAULT_EXTENSION constant if defined,
     354         *                      else 'home'.
     355         */
    314356        $this->default_extension = apply_filters( 'bp_groups_default_extension', defined( 'BP_GROUPS_DEFAULT_EXTENSION' ) ? BP_GROUPS_DEFAULT_EXTENSION : 'home' );
    315357
     
    565607
    566608        if ( isset( $this->current_group->user_has_access ) ) {
     609
     610            /**
     611             * Fires at the end of the groups navigation setup if user has access.
     612             *
     613             * @since BuddyPress (1.0.2)
     614             *
     615             * @param bool $user_has_access Whether or not user has access.
     616             */
    567617            do_action( 'groups_setup_nav', $this->current_group->user_has_access );
    568618        } else {
     619
     620            /** This action is documented in bp-groups/bp-groups-loader.php */
    569621            do_action( 'groups_setup_nav');
    570622        }
Note: See TracChangeset for help on using the changeset viewer.