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-functions.php

    r9907 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Functions.
     
    1312 */
    1413
    15 // Exit if accessed directly
     14// Exit if accessed directly.
    1615defined( 'ABSPATH' ) || exit;
    1716
     
    1918 * Check whether there is a Groups directory page in the $bp global.
    2019 *
    21  * @since BuddyPress (1.5.0)
     20 * @since 1.5.0
    2221 *
    2322 * @return bool True if set, False if empty.
     
    6261     * Filters a single group object.
    6362     *
    64      * @since BuddyPress (1.2.0)
     63     * @since 1.2.0
    6564     *
    6665     * @param BP_Groups_Group $group Single group object.
     
    7473 * Create a group.
    7574 *
    76  * @since BuddyPress (1.0.0)
     75 * @since 1.0.0
    7776 *
    7877 * @param array|string $args {
     
    172171         * Fires after the creation of a new group and a group creator needs to be made.
    173172         *
    174          * @since BuddyPress (1.5.0)
     173         * @since 1.5.0
    175174         *
    176175         * @param int              $id     ID of the newly created group.
     
    186185         * Fires after the update of a group.
    187186         *
    188          * @since BuddyPress (1.5.0)
     187         * @since 1.5.0
    189188         *
    190189         * @param int             $id    ID of the updated group.
     
    197196     * Fires after the creation or update of a group.
    198197     *
    199      * @since BuddyPress (1.0.0)
     198     * @since 1.0.0
    200199     *
    201200     * @param int             $id    ID of the newly created group.
     
    242241     * Fired after a group's details are updated.
    243242     *
    244      * @since BuddyPress (2.2.0)
     243     * @since 2.2.0
    245244     *
    246245     * @param int             $value          ID of the group.
     
    301300     * Fires after the update of a groups settings.
    302301     *
    303      * @since BuddyPress (1.0.0)
     302     * @since 1.0.0
    304303     *
    305304     * @param int $id ID of the group that was updated.
     
    313312 * Delete a group and all of its associated metadata.
    314313 *
    315  * @since BuddyPress (1.0.0)
     314 * @since 1.0.0
    316315 *
    317316 * @param int $group_id ID of the group to delete.
     
    324323     * Fires before the deletion of a group.
    325324     *
    326      * @since BuddyPress (1.5.0)
     325     * @since 1.5.0
    327326     *
    328327     * @param int $group_id ID of the group to be deleted.
     
    344343     * Fires after the deletion of a group.
    345344     *
    346      * @since BuddyPress (1.0.0)
     345     * @since 1.0.0
    347346     *
    348347     * @param int $group_id ID of the group that was deleted.
     
    407406 * Get a group ID by its slug.
    408407 *
    409  * @since BuddyPress (1.6.0)
     408 * @since 1.6.0
    410409 *
    411410 * @param string $group_slug The group's slug.
     
    450449     * Fires after a user leaves a group.
    451450     *
    452      * @since BuddyPress (1.0.0)
     451     * @since 1.0.0
    453452     *
    454453     * @param int $group_id ID of the group.
     
    515514     * Fires after a user joins a group.
    516515     *
    517      * @since BuddyPress (1.0.0)
     516     * @since 1.0.0
    518517     *
    519518     * @param int $group_id ID of the group.
     
    719718     * Filters the collection of groups based on parsed parameters.
    720719     *
    721      * @since BuddyPress (1.2.0)
     720     * @since 1.2.0
    722721     *
    723722     * @param BP_Groups_Group $groups Object of found groups based on parameters.
     
    791790 * Get the BP_Groups_Group object corresponding to the current group.
    792791 *
    793  * @since BuddyPress (1.5.0)
     792 * @since 1.5.0
    794793 *
    795794 * @return BP_Groups_Group The current group object.
     
    805804     * Filters the BP_Groups_Group object corresponding to the current group.
    806805     *
    807      * @since BuddyPress (1.5.0)
     806     * @since 1.5.0
    808807     *
    809808     * @param BP_Groups_Group $current_group Current BP_Groups_Group object.
     
    837836     * Filters the avatar upload directory path for a given group.
    838837     *
    839      * @since BuddyPress (1.1.0)
     838     * @since 1.1.0
    840839     *
    841840     * @param array $value Array of parts related to the groups avatar upload directory.
     
    896895 * Is the specified user the creator of the group?
    897896 *
    898  * @since BuddyPress (1.2.6)
     897 * @since 1.2.6
    899898 *
    900899 * @param int $user_id ID of the user.
     
    955954     * Filters the action for the new group activity update.
    956955     *
    957      * @since BuddyPress (1.2.0)
     956     * @since 1.2.0
    958957     *
    959958     * @param string $activity_action The new group activity update.
     
    964963     * Filters the content for the new group activity update.
    965964     *
    966      * @since BuddyPress (1.2.0)
     965     * @since 1.2.0
    967966     *
    968967     * @param string $activity_content The content of the update.
     
    983982     * Fires after posting of an Activity status update affiliated with a group.
    984983     *
    985      * @since BuddyPress (1.2.0)
     984     * @since 1.2.0
    986985     *
    987986     * @param string $content     The content of the update.
     
    10191018 * Get the total group invite count for a user.
    10201019 *
    1021  * @since BuddyPress (2.0.0)
     1020 * @since 2.0.0
    10221021 *
    10231022 * @param int $user_id The user ID.
     
    10841083         * Fires after the creation of a new group invite.
    10851084         *
    1086          * @since BuddyPress (1.0.0)
     1085         * @since 1.0.0
    10871086         *
    10881087         * @param array $args Array of parsed arguments for the group invite.
     
    11121111     * Fires after uninviting a user from a group.
    11131112     *
    1114      * @since BuddyPress (1.0.0)
     1113     * @since 1.0.0
    11151114     *
    11161115     * @param int $group_id ID of the group being uninvited from.
     
    11661165     * Fires after a user has accepted a group invite.
    11671166     *
    1168      * @since BuddyPress (1.0.0)
     1167     * @since 1.0.0
    11691168     *
    11701169     * @param int $user_id  ID of the user who accepted the group invite.
     
    11911190     * Fires after a user rejects a group invitation.
    11921191     *
    1193      * @since BuddyPress (1.0.0)
     1192     * @since 1.0.0
    11941193     *
    11951194     * @param int $user_id  ID of the user rejecting the invite.
     
    12161215     * Fires after the deletion of a group invitation.
    12171216     *
    1218      * @since BuddyPress (1.9.0)
     1217     * @since 1.9.0
    12191218     *
    12201219     * @param int $user_id  ID of the user whose invitation is being deleted.
     
    12541253     * Fires after the sending of invites for a group.
    12551254     *
    1256      * @since BuddyPress (1.0.0)
     1255     * @since 1.0.0
    12571256     *
    12581257     * @param int   $group_id      ID of the group who's being invited to.
     
    13281327     * Fires before the promotion of a user to a new status.
    13291328     *
    1330      * @since BuddyPress (1.6.0)
     1329     * @since 1.6.0
    13311330     *
    13321331     * @param int    $group_id ID of the group being promoted in.
     
    13571356     * Fires before the demotion of a user to 'member'.
    13581357     *
    1359      * @since BuddyPress (1.0.0)
     1358     * @since 1.0.0
    13601359     *
    13611360     * @param int $group_id ID of the group being demoted in.
     
    13851384     * Fires before the banning of a member from a group.
    13861385     *
    1387      * @since BuddyPress (1.0.0)
     1386     * @since 1.0.0
    13881387     *
    13891388     * @param int $group_id ID of the group being banned from.
     
    14131412     * Fires before the unbanning of a member from a group.
    14141413     *
    1415      * @since BuddyPress (1.0.0)
     1414     * @since 1.0.0
    14161415     *
    14171416     * @param int $group_id ID of the group being unbanned from.
     
    14511450     * Fires before the removal of a member from a group.
    14521451     *
    1453      * @since BuddyPress (1.2.6)
     1452     * @since 1.2.6
    14541453     *
    14551454     * @param int $group_id ID of the group being removed from.
     
    15071506         * Fires after the creation of a new membership request.
    15081507         *
    1509          * @since BuddyPress (1.0.0)
     1508         * @since 1.0.0
    15101509         *
    15111510         * @param int   $requesting_user_id  ID of the user requesting membership.
     
    15571556     * Fires after a group membership request has been accepted.
    15581557     *
    1559      * @since BuddyPress (1.0.0)
     1558     * @since 1.0.0
    15601559     *
    15611560     * @param int  $user_id  ID of the user who accepted membership.
     
    15891588     * Fires after a group membership request has been rejected.
    15901589     *
    1591      * @since BuddyPress (1.0.0)
     1590     * @since 1.0.0
    15921591     *
    15931592     * @param int  $user_id  ID of the user who rejected membership.
     
    16561655     * Fires after the acceptance of all pending membership requests to a group.
    16571656     *
    1658      * @since BuddyPress (1.0.2)
     1657     * @since 1.0.2
    16591658     *
    16601659     * @param int $group_id ID of the group whose pending memberships were accepted.
     
    17501749 * Add a piece of group metadata.
    17511750 *
    1752  * @since BuddyPress (2.0.0)
     1751 * @since 2.0.0
    17531752 *
    17541753 * @param int    $group_id   ID of the group.
    17551754 * @param string $meta_key   Metadata key.
    17561755 * @param mixed  $meta_value Metadata value.
    1757  * @param bool   $unique.    Optional. Whether to enforce a single metadata value
     1756 * @param bool   $unique     Optional. Whether to enforce a single metadata value
    17581757 *                           for the given key. If true, and the object already
    17591758 *                           has a value for the key, no change will be made.
     
    17751774 * Delete all group membership information for the specified user.
    17761775 *
    1777  * @since BuddyPress (1.0.0)
     1776 * @since 1.0.0
    17781777 *
    17791778 * @param int $user_id ID of the user.
     
    17851784     * Fires after the deletion of all data for a user.
    17861785     *
    1787      * @since BuddyPress (1.1.0)
     1786     * @since 1.1.0
    17881787     *
    17891788     * @param int $user_id ID of the user whose data is being deleted.
Note: See TracChangeset for help on using the changeset viewer.