Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/13/2015 02:02:56 AM (11 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Core component.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-core/bp-core-caps.php

    r10052 r10108  
    11<?php
    2 
    32/**
    43 * BuddyPress Capabilities.
     
    1918 * WordPress's RBAC, so should our capability functions here.
    2019 *
    21  * @since BuddyPress (2.1.0)
     20 * @since 2.1.0
    2221 *
    2322 * @return array
     
    3433     * Filters the list of editable roles.
    3534     *
    36      * @since BuddyPress (2.1.0)
     35     * @since 2.1.0
    3736     *
    3837     * @param array $roles List of roles.
     
    4342     * Filters the array of roles from the currently loaded blog.
    4443     *
    45      * @since BuddyPress (2.1.0)
     44     * @since 2.1.0
    4645     *
    4746     * @param array    $roles    Available roles.
     
    5655 * This is called on plugin activation.
    5756 *
    58  * @since BuddyPress (1.6.0)
     57 * @since 1.6.0
    5958 *
    6059 * @uses get_role() To get the administrator, default and moderator roles.
     
    8281     * This is called on plugin activation.
    8382     *
    84      * @since BuddyPress (1.6.0)
     83     * @since 1.6.0
    8584     */
    8685    do_action( 'bp_add_caps' );
     
    9291 * This is called on plugin deactivation.
    9392 *
    94  * @since BuddyPress (1.6.0)
     93 * @since 1.6.0
    9594 *
    9695 * @uses get_role() To get the administrator and default roles.
     
    118117     * This is called on plugin deactivation.
    119118     *
    120      * @since BuddyPress (1.6.0)
     119     * @since 1.6.0
    121120     */
    122121    do_action( 'bp_remove_caps' );
     
    126125 * Map community caps to built in WordPress caps.
    127126 *
    128  * @since BuddyPress (1.6.0)
     127 * @since 1.6.0
    129128 *
    130129 * @see WP_User::has_cap() for description of the arguments passed to the
     
    145144     * Filters the community caps mapping to be built in WordPress caps.
    146145     *
    147      * @since BuddyPress (1.6.0)
     146     * @since 1.6.0
    148147     *
    149148     * @param array  $caps    Returns the user's actual capabilities.
     
    158157 * Return community capabilities.
    159158 *
    160  * @since BuddyPress (1.6.0)
     159 * @since 1.6.0
    161160 *
    162161 * @uses apply_filters() Calls 'bp_get_community_caps' with the capabilities.
     
    172171     * Filters community capabilities.
    173172     *
    174      * @since BuddyPress (1.6.0)
     173     * @since 1.6.0
    175174     *
    176175     * @param array $caps Array of capabilities to add. Empty by default.
     
    182181 * Return an array of capabilities based on the role that is being requested.
    183182 *
    184  * @since BuddyPress (1.6.0)
     183 * @since 1.6.0
    185184 *
    186185 * @uses apply_filters() Allow return value to be filtered.
     
    217216     * Filters the array of capabilities based on the role that is being requested.
    218217     *
    219      * @since BuddyPress (1.6.0)
     218     * @since 1.6.0
    220219     *
    221220     * @param array  $caps Array of capabilities to return.
     
    231230 * already have a role or capability on.
    232231 *
    233  * @since BuddyPress (1.6.0)
     232 * @since 1.6.0
    234233 *
    235234 * @global BuddyPress $bp Global BuddyPress settings object.
     
    266265 * Check whether the current user has a given capability.
    267266 *
    268  * @since BuddyPress (1.6.0)
    269  * @since BuddyPress (2.4.0) Second argument modified to accept an array, rather than `$blog_id`.
     267 * @since 1.6.0
     268 * @since 2.4.0 Second argument modified to accept an array, rather than `$blog_id`.
    270269 *
    271270 * @param string    $capability Capability or role name.
     
    304303     * Filters whether or not the current user has a given capability.
    305304     *
    306      * @since BuddyPress (1.6.0)
    307      * @since BuddyPress (2.4.0) Pass `$args` variable.
     305     * @since 1.6.0
     306     * @since 2.4.0 Pass `$args` variable.
    308307     *
    309308     * @param bool   $retval     Whether or not the current user has the capability.
     
    334333 *
    335334 * @access private
    336  * @since BuddyPress (1.6.0)
     335 * @since 1.6.0
    337336 *
    338337 * @see WP_User::has_cap()
     
    374373 * This is called on plugin activation.
    375374 *
    376  * @since BuddyPress (1.6.0)
     375 * @since 1.6.0
    377376 * @deprecated 1.7.0
    378377 */
     
    386385 * This is called on plugin deactivation.
    387386 *
    388  * @since BuddyPress (1.6.0)
     387 * @since 1.6.0
    389388 * @deprecated 1.7.0
    390389 */
     
    400399 * sites that have global communities enabled.
    401400 *
    402  * @since BuddyPress (1.6)
     401 * @since 1.6.0
    403402 * @deprecated 1.7.0
    404403 */
     
    410409 * The moderator role for BuddyPress users.
    411410 *
    412  * @since BuddyPress (1.6.0)
     411 * @since 1.6.0
    413412 * @deprecated 1.7.0
    414413 */
Note: See TracChangeset for help on using the changeset viewer.