Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/27/2015 05:25:02 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Groups Component.

See #6576.

File:
1 edited

Legend:

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

    r10110 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Loader.
     
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
     
    2019     * Auto-join group when non group member performs group activity.
    2120     *
    22      * @since BuddyPress (1.5.0)
     21     * @since 1.5.0
    2322     * @access public
    2423     * @var bool
     
    2928     * The group being currently accessed.
    3029     *
    31      * @since BuddyPress (1.5.0)
     30     * @since 1.5.0
    3231     * @access public
    3332     * @var BP_Groups_Group
     
    3837     * Default group extension.
    3938     *
    40      * @since BuddyPress (1.6.0)
     39     * @since 1.6.0
    4140     * @access public
    4241     * @todo Is this used anywhere? Is this a duplicate of $default_extension?
     
    4746     * Default group extension.
    4847     *
    49      * @since BuddyPress (1.6.0)
     48     * @since 1.6.0
    5049     * @access public
    5150     * @var string
     
    5655     * Illegal group names/slugs.
    5756     *
    58      * @since BuddyPress (1.5.0)
     57     * @since 1.5.0
    5958     * @access public
    6059     * @var array
     
    6564     * Group creation/edit steps (e.g. Details, Settings, Avatar, Invites).
    6665     *
    67      * @since BuddyPress (1.5.0)
     66     * @since 1.5.0
    6867     * @access public
    6968     * @var array
     
    7473     * Types of group statuses (Public, Private, Hidden).
    7574     *
    76      * @since BuddyPress (1.5.0)
     75     * @since 1.5.0
    7776     * @access public
    7877     * @var array
     
    8382     * Start the groups component creation process.
    8483     *
    85      * @since BuddyPress (1.5.0)
     84     * @since 1.5.0
    8685     */
    8786    public function __construct() {
     
    10099     * Include Groups component files.
    101100     *
    102      * @since BuddyPress (1.5.0)
     101     * @since 1.5.0
    103102     *
    104103     * @see BP_Component::includes() for a description of arguments.
     
    135134     * backwards compatibility.
    136135     *
    137      * @since BuddyPress (1.5.0)
     136     * @since 1.5.0
    138137     *
    139138     * @see BP_Component::setup_globals() for a description of arguments.
     
    186185             * Filters the current PHP Class being used.
    187186             *
    188              * @since BuddyPress (1.5.0)
     187             * @since 1.5.0
    189188             *
    190189             * @param string $value Name of the class being used.
     
    203202                 * Filters the current group object being instantiated from previous filter.
    204203                 *
    205                  * @since BuddyPress (1.5.0)
     204                 * @since 1.5.0
    206205                 *
    207206                 * @param object $value Newly instantiated object for the group.
     
    261260         * Filters the list of illegal groups names/slugs.
    262261         *
    263          * @since BuddyPress (1.0.0)
     262         * @since 1.0.0
    264263         *
    265264         * @param array $value Array of illegal group names/slugs.
     
    291290         * Filters the preconfigured groups creation steps.
    292291         *
    293          * @since BuddyPress (1.1.0)
     292         * @since 1.1.0
    294293         *
    295294         * @param array $value Array of preconfigured group creation steps.
     
    326325         * Filters the list of valid groups statuses.
    327326         *
    328          * @since BuddyPress (1.1.0)
     327         * @since 1.1.0
    329328         *
    330329         * @param array $value Array of valid group statuses.
     
    343342     * Set up canonical stack for this component.
    344343     *
    345      * @since BuddyPress (2.1.0)
     344     * @since 2.1.0
    346345     */
    347346    public function setup_canonical_stack() {
     
    357356         * Filters the default groups extension.
    358357         *
    359          * @since BuddyPress (1.6.0)
     358         * @since 1.6.0
    360359         *
    361360         * @param string $value BP_GROUPS_DEFAULT_EXTENSION constant if defined,
     
    392391     * Set up component navigation.
    393392     *
    394      * @since BuddyPress (1.5.0)
     393     * @since 1.5.0
    395394     *
    396395     * @see BP_Component::setup_nav() for a description of arguments.
     
    622621             * Fires at the end of the groups navigation setup if user has access.
    623622             *
    624              * @since BuddyPress (1.0.2)
     623             * @since 1.0.2
    625624             *
    626625             * @param bool $user_has_access Whether or not user has access.
     
    741740     * Setup cache groups
    742741     *
    743      * @since BuddyPress (2.2.0)
     742     * @since 2.2.0
    744743     */
    745744    public function setup_cache_groups() {
     
    760759 * Bootstrap the Notifications component.
    761760 *
    762  * @since BuddyPress (1.5.0)
     761 * @since 1.5.0
    763762 */
    764763function bp_setup_groups() {
Note: See TracChangeset for help on using the changeset viewer.