Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/27/2015 05:08:37 AM (6 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Friends Component.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-friends/bp-friends-functions.php

    r10037 r10147  
    11<?php
    2 
    32/**
    43 * BuddyPress Friends Functions.
     
    1312 */
    1413
    15 // Exit if accessed directly
     14// Exit if accessed directly.
    1615defined( 'ABSPATH' ) || exit;
    1716
     
    7574     * The two potential hooks are: friends_friendship_requested, friends_friendship_accepted.
    7675     *
    77      * @since BuddyPress (1.0.0)
     76     * @since 1.0.0
    7877     *
    7978     * @param int    $id                ID of the pending friendship connection.
     
    106105     * for the user who canceled the friendship.
    107106     *
    108      * @since BuddyPress (1.5.0)
     107     * @since 1.5.0
    109108     *
    110109     * @param int $friendship_id    ID of the friendship object, if any, between a pair of users.
     
    123122     * This is your last chance to do something while the friendship exists.
    124123     *
    125      * @since BuddyPress (1.0.0)
     124     * @since 1.0.0
    126125     *
    127126     * @param int $friendship_id    ID of the friendship object, if any, between a pair of users.
     
    137136         * Fires after the friendship connection is removed.
    138137         *
    139          * @since BuddyPress (1.8.0)
     138         * @since 1.8.0
    140139         *
    141140         * @param int $initiator_userid ID of the friendship initiator.
     
    173172         * Fires after a friendship is accepted.
    174173         *
    175          * @since BuddyPress (1.0.0)
     174         * @since 1.0.0
    176175         *
    177176         * @param int    $id                ID of the pending friendship object.
     
    203202         * Fires after a friendship request is rejected.
    204203         *
    205          * @since BuddyPress (1.0.0)
     204         * @since 1.0.0
    206205         *
    207206         * @param int                   $friendship_id ID of the pending friendship.
     
    236235         * Fires after a friendship request has been withdrawn.
    237236         *
    238          * @since BuddyPress (1.9.0)
     237         * @since 1.9.0
    239238         *
    240239         * @param int                   $friendship_id ID of the friendship.
     
    307306     * Filters the total friend count for a given user.
    308307     *
    309      * @since BuddyPress (1.2.0)
     308     * @since 1.2.0
    310309     *
    311310     * @param int $count Total friend count for a given user.
     
    412411     * Filters a user's most recently active friends.
    413412     *
    414      * @since BuddyPress (1.2.0)
     413     * @since 1.2.0
    415414     *
    416415     * @param array {
     
    442441     * Filters a user's friends listed in alphabetical order.
    443442     *
    444      * @since BuddyPress (1.2.0)
     443     * @since 1.2.0
    445444     *
    446445     * @return array {
     
    472471     * Filters a user's friends listed from newest to oldest.
    473472     *
    474      * @since BuddyPress (1.2.0)
     473     * @since 1.2.0
    475474     *
    476475     * @param array {
     
    502501 * user is not a group admin.
    503502 *
    504  * @since BuddyPress (1.0.0)
     503 * @since 1.0.0
    505504 *
    506505 * @param int $user_id  User ID whose friends to see can be invited. Default:
     
    525524     * Filters default arguments for list of friends a user can invite into this group.
    526525     *
    527      * @since BuddyPress (1.5.4)
     526     * @since 1.5.4
    528527     *
    529528     * @param array $value Array of default parameters for invite list.
     
    578577     * Filters the list of potential friends that can be invited to this group.
    579578     *
    580      * @since BuddyPress (1.5.4)
     579     * @since 1.5.4
    581580     *
    582581     * @param array|bool $friends  Array friends available to invite or false for no friends.
     
    695694     * Fires before deletion of friend-related data for a given user.
    696695     *
    697      * @since BuddyPress (1.5.0)
     696     * @since 1.5.0
    698697     *
    699698     * @param int $user_id ID for the user whose friend data is being removed.
     
    709708     * Fires after deletion of friend-related data for a given user.
    710709     *
    711      * @since BuddyPress (1.0.0)
     710     * @since 1.0.0
    712711     *
    713712     * @param int $user_id ID for the user whose friend data is being removed.
Note: See TracChangeset for help on using the changeset viewer.