Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/27/2015 05:08:37 AM (9 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-notifications.php

    r9995 r10147  
    11<?php
    2 
    32/**
    43 * BuddyPress Friends Activity Functions.
     
    1110 */
    1211
    13 // Exit if accessed directly
     12// Exit if accessed directly.
    1413defined( 'ABSPATH' ) || exit;
    1514
     
    6261     * Filters the email address for who is getting the friend request.
    6362     *
    64      * @since BuddyPress (1.2.0)
     63     * @since 1.2.0
    6564     *
    6665     * @param string $to Email address for who is getting the friend request.
     
    7170     * Filters the subject for the friend request email.
    7271     *
    73      * @since BuddyPress (1.2.0)
     72     * @since 1.2.0
    7473     *
    7574     * @param string $subject        Subject line to be used in friend request email.
     
    8180     * Filters the message for the friend request email.
    8281     *
    83      * @since BuddyPress (1.2.0)
     82     * @since 1.2.0
    8483     *
    8584     * @param string $message           Message to be used in friend request email.
     
    9695     * Fires after the new friend request email is sent.
    9796     *
    98      * @since BuddyPress (1.5.0)
     97     * @since 1.5.0
    9998     *
    10099     * @param int    $friend_id     ID of the request recipient.
     
    151150     * Filters the email address for whose friend request got accepted.
    152151     *
    153      * @since BuddyPress (1.2.0)
     152     * @since 1.2.0
    154153     *
    155154     * @param string $to Email address for whose friend request got accepted.
     
    160159     * Filters the subject for the friend request accepted email.
    161160     *
    162      * @since BuddyPress (1.2.0)
     161     * @since 1.2.0
    163162     *
    164163     * @param string $subject     Subject line to be used in friend request accepted email.
     
    170169     * Filters the message for the friend request accepted email.
    171170     *
    172      * @since BuddyPress (1.2.0)
     171     * @since 1.2.0
    173172     *
    174173     * @param string $message       Message to be used in friend request email.
     
    184183     * Fires after the friend request accepted email is sent.
    185184     *
    186      * @since BuddyPress (1.5.0)
     185     * @since 1.5.0
    187186     *
    188187     * @param int    $initiator_id  ID of the friendship requester.
     
    261260         *   - bp_friends_multiple_friendship_request_notification
    262261         *
    263          * @since BuddyPress (1.0.0)
     262         * @since 1.0.0
    264263         *
    265264         * @param string|array $value       Depending on format, an HTML link to new requests profile
     
    281280     * Fires at the end of the bp-friends notification format callback.
    282281     *
    283      * @since BuddyPress (1.0.0)
     282     * @since 1.0.0
    284283     *
    285284     * @param string       $action            The kind of notification being rendered.
     
    308307 * Delete any friendship request notifications for the logged in user.
    309308 *
    310  * @since BuddyPress (1.9.0)
     309 * @since 1.9.0
    311310 */
    312311function bp_friends_mark_friendship_request_notifications_by_type() {
     
    320319 * Delete any friendship acceptance notifications for the logged in user.
    321320 *
    322  * @since BuddyPress (1.9.0)
     321 * @since 1.9.0
    323322 */
    324323function bp_friends_mark_friendship_accepted_notifications_by_type() {
     
    332331 * Notify one use that another user has requested their virtual friendship.
    333332 *
    334  * @since BuddyPress (1.9.0)
     333 * @since 1.9.0
    335334 * @param int $friendship_id     The unique ID of the friendship.
    336335 * @param int $initiator_user_id The friendship initiator user ID.
     
    355354 * Remove friend request notice when a member rejects another members
    356355 *
    357  * @since BuddyPress (1.9.0)
     356 * @since 1.9.0
    358357 *
    359358 * @param int    $friendship_id (not used)
     
    370369 * Notify a member when another member accepts their virtual friendship request.
    371370 *
    372  * @since BuddyPress (1.9.0)
     371 * @since 1.9.0
    373372 *
    374373 * @param int $friendship_id     The unique ID of the friendship.
     
    402401 * Remove friend request notice when a member withdraws their friend request.
    403402 *
    404  * @since BuddyPress (1.9.0)
     403 * @since 1.9.0
    405404 *
    406405 * @param int    $friendship_id (not used)
     
    417416 * Remove friendship requests FROM user, used primarily when a user is deleted.
    418417 *
    419  * @since BuddyPress (1.9.0)
     418 * @since 1.9.0
    420419 *
    421420 * @param int $user_id
Note: See TracChangeset for help on using the changeset viewer.