Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
07/04/2015 10:23:19 PM (5 years ago)
Author:
tw2113
Message:

Docs cleanup for Friends component.

See #6400.

File:
1 edited

Legend:

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

    r9819 r9995  
    22
    33/**
    4  * BuddyPress Friends Activity Functions
     4 * BuddyPress Friends Activity Functions.
    55 *
    66 * These functions handle the recording, deleting and formatting of activity
     
    2323 *
    2424 * @param int $friendship_id ID of the friendship object.
    25  * @param int $initiator_id ID of the user who initiated the request.
    26  * @param int $friend_id ID of the request recipient.
     25 * @param int $initiator_id  ID of the user who initiated the request.
     26 * @param int $friend_id     ID of the request recipient.
     27 *
     28 * @return bool
    2729 */
    2830function friends_notification_new_request( $friendship_id, $initiator_id, $friend_id ) {
     
    7173     * @since BuddyPress (1.2.0)
    7274     *
    73      * @param string $subject Subject line to be used in friend request email.
     75     * @param string $subject        Subject line to be used in friend request email.
    7476     * @param string $initiator_name Name of the person requesting friendship.
    7577     */
     
    8183     * @since BuddyPress (1.2.0)
    8284     *
    83      * @param string $message Message to be used in friend request email.
    84      * @param string $initiator_name Name of the person requesting friendship.
    85      * @param string $initiator_link Profile link of person requesting friendship.
     85     * @param string $message           Message to be used in friend request email.
     86     * @param string $initiator_name    Name of the person requesting friendship.
     87     * @param string $initiator_link    Profile link of person requesting friendship.
    8688     * @param string $all_requests_link User's friends request management link.
    87      * @param string $settings_link Email recipient's settings management link.
     89     * @param string $settings_link     Email recipient's settings management link.
    8890     */
    8991    $message = apply_filters( 'friends_notification_new_request_message', $message, $initiator_name, $initiator_link, $all_requests_link, $settings_link );
     
    9698     * @since BuddyPress (1.5.0)
    9799     *
    98      * @param int    $friend_id ID of the request recipient.
    99      * @param string $subject Text for the friend request subject field.
    100      * @param string $message Text for the friend request message field.
     100     * @param int    $friend_id     ID of the request recipient.
     101     * @param string $subject       Text for the friend request subject field.
     102     * @param string $message       Text for the friend request message field.
    101103     * @param int    $friendship_id ID of the friendship object.
    102      * @param int    $initiator_id ID of the friendship requester.
     104     * @param int    $initiator_id  ID of the friendship requester.
    103105     */
    104106    do_action( 'bp_friends_sent_request_email', $friend_id, $subject, $message, $friendship_id, $initiator_id );
     
    113115 *
    114116 * @param int $friendship_id ID of the friendship object.
    115  * @param int $initiator_id ID of the user who initiated the request.
    116  * @param int $friend_id ID of the request recipient.
     117 * @param int $initiator_id  ID of the user who initiated the request.
     118 * @param int $friend_id     ID of the request recipient.
     119 *
     120 * @return bool
    117121 */
    118122function friends_notification_accepted_request( $friendship_id, $initiator_id, $friend_id ) {
     
    158162     * @since BuddyPress (1.2.0)
    159163     *
    160      * @param string $subject Subject line to be used in friend request accepted email.
     164     * @param string $subject     Subject line to be used in friend request accepted email.
    161165     * @param string $friend_name Name of the person who accepted the friendship request.
    162166     */
     
    168172     * @since BuddyPress (1.2.0)
    169173     *
    170      * @param string $message Message to be used in friend request email.
    171      * @param string $friend_name Name of the person who accepted the friendship request.
    172      * @param string $friend_link Profile link of person who accepted the friendship request.
     174     * @param string $message       Message to be used in friend request email.
     175     * @param string $friend_name   Name of the person who accepted the friendship request.
     176     * @param string $friend_link   Profile link of person who accepted the friendship request.
    173177     * @param string $settings_link Email recipient's settings management link.
    174178     */
     
    182186     * @since BuddyPress (1.5.0)
    183187     *
    184      * @param int    $initiator_id ID of the friendship requester.
    185      * @param string $subject Text for the friend request subject field.
    186      * @param string $message Text for the friend request message field.
     188     * @param int    $initiator_id  ID of the friendship requester.
     189     * @param string $subject       Text for the friend request subject field.
     190     * @param string $message       Text for the friend request message field.
    187191     * @param int    $friendship_id ID of the friendship object.
    188      * @param int    $friend_id ID of the request recipient.
     192     * @param int    $friend_id     ID of the request recipient.
    189193     */
    190194    do_action( 'bp_friends_sent_accepted_email', $initiator_id, $subject, $message, $friendship_id, $friend_id );
     
    197201 * Notification formatting callback for bp-friends notifications.
    198202 *
    199  * @param string $action The kind of notification being rendered.
    200  * @param int $item_id The primary item ID.
    201  * @param int $secondary_item_id The secondary item ID.
    202  * @param int $total_items The total number of messaging-related notifications
    203  *        waiting for the user.
    204  * @param string $format 'string' for BuddyBar-compatible notifications;
    205  *        'array' for WP Toolbar. Default: 'string'.
     203 * @param string $action            The kind of notification being rendered.
     204 * @param int    $item_id           The primary item ID.
     205 * @param int    $secondary_item_id The secondary item ID.
     206 * @param int    $total_items       The total number of messaging-related notifications
     207 *                                  waiting for the user.
     208 * @param string $format            'string' for BuddyBar-compatible notifications;
     209 *                                  'array' for WP Toolbar. Default: 'string'.
     210 *
    206211 * @return array|string
    207212 */
     
    328333 *
    329334 * @since BuddyPress (1.9.0)
    330  * @param int $friendship_id The unique ID of the friendship
    331  * @param int $initiator_user_id The friendship initiator user ID
    332  * @param int $friend_user_id The friendship request receiver user ID
     335 * @param int $friendship_id     The unique ID of the friendship.
     336 * @param int $initiator_user_id The friendship initiator user ID.
     337 * @param int $friend_user_id    The friendship request receiver user ID.
    333338 */
    334339function bp_friends_friendship_requested_notification( $friendship_id, $initiator_user_id, $friend_user_id ) {
     
    352357 * @since BuddyPress (1.9.0)
    353358 *
    354  * @param int $friendship_id (not used)
     359 * @param int    $friendship_id (not used)
    355360 * @param object $friendship
    356361 */
     
    366371 *
    367372 * @since BuddyPress (1.9.0)
    368  * @param int $friendship_id The unique ID of the friendship
    369  * @param int $initiator_user_id The friendship initiator user ID
    370  * @param int $friend_user_id The friendship request receiver user ID
     373 *
     374 * @param int $friendship_id     The unique ID of the friendship.
     375 * @param int $initiator_user_id The friendship initiator user ID.
     376 * @param int $friend_user_id    The friendship request receiver user ID.
    371377 */
    372378function bp_friends_add_friendship_accepted_notification( $friendship_id, $initiator_user_id, $friend_user_id ) {
     
    394400
    395401/**
    396  * Remove friend request notice when a member withdraws their friend request
    397  *
    398  * @since BuddyPress (1.9.0)
    399  *
    400  * @param int $friendship_id (not used)
     402 * Remove friend request notice when a member withdraws their friend request.
     403 *
     404 * @since BuddyPress (1.9.0)
     405 *
     406 * @param int    $friendship_id (not used)
    401407 * @param object $friendship
    402408 */
     
    409415
    410416/**
    411  * Remove friendship requests FROM user, used primarily when a user is deleted
    412  *
    413  * @since BuddyPress (1.9.0)
     417 * Remove friendship requests FROM user, used primarily when a user is deleted.
     418 *
     419 * @since BuddyPress (1.9.0)
     420 *
    414421 * @param int $user_id
    415422 */
Note: See TracChangeset for help on using the changeset viewer.