Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
08/31/2015 06:51:35 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Activity component.

See #6576.

File:
1 edited

Legend:

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

    r9834 r10077  
    11<?php
    2 
    32/**
    43 * BuddyPress Activity Notifications.
     
    1615 * Send email and BP notifications when a user is mentioned in an update.
    1716 *
    18  * @since BuddyPress (1.2.0)
     17 * @since 1.2.0
    1918 *
    2019 * @uses bp_notifications_add_notification()
     
    103102         * Filters the user email that the @mention notification will be sent to.
    104103         *
    105          * @since BuddyPress (1.2.0)
     104         * @since 1.2.0
    106105         *
    107106         * @param string $to User email the notification is being sent to.
     
    112111         * Filters the @mention notification subject that will be sent to user.
    113112         *
    114          * @since BuddyPress (1.2.0)
     113         * @since 1.2.0
    115114         *
    116115         * @param string $subject     Email notification subject text.
     
    122121         * Filters the @mention notification message that will be sent to user.
    123122         *
    124          * @since BuddyPress (1.2.0)
     123         * @since 1.2.0
    125124         *
    126125         * @param string $message       Email notification message text.
     
    138137     * Fires after the sending of an @mention email notification.
    139138     *
    140      * @since BuddyPress (1.5.0)
     139     * @since 1.5.0
    141140     *
    142141     * @param BP_Activity_Activity $activity         Activity Item object.
     
    152151 * Send email and BP notifications when an activity item receives a comment.
    153152 *
    154  * @since BuddyPress (1.2.0)
     153 * @since 1.2.0
    155154 *
    156155 * @uses bp_get_user_meta()
     
    221220         * Filters the user email that the new comment notification will be sent to.
    222221         *
    223          * @since BuddyPress (1.2.0)
     222         * @since 1.2.0
    224223         *
    225224         * @param string $to User email the notification is being sent to.
     
    230229         * Filters the new comment notification subject that will be sent to user.
    231230         *
    232          * @since BuddyPress (1.2.0)
     231         * @since 1.2.0
    233232         *
    234233         * @param string $subject     Email notification subject text.
     
    240239         * Filters the new comment notification message that will be sent to user.
    241240         *
    242          * @since BuddyPress (1.2.0)
     241         * @since 1.2.0
    243242         *
    244243         * @param string $message       Email notification message text.
     
    255254         * Fires after the sending of a reply to an update email notification.
    256255         *
    257          * @since BuddyPress (1.5.0)
     256         * @since 1.5.0
    258257         *
    259258         * @param int    $user_id      ID of the original activity item author.
     
    309308         * Filters the user email that the new comment reply notification will be sent to.
    310309         *
    311          * @since BuddyPress (1.2.0)
     310         * @since 1.2.0
    312311         *
    313312         * @param string $to User email the notification is being sent to.
     
    318317         * Filters the new comment reply notification subject that will be sent to user.
    319318         *
    320          * @since BuddyPress (1.2.0)
     319         * @since 1.2.0
    321320         *
    322321         * @param string $subject     Email notification subject text.
     
    328327         * Filters the new comment reply notification message that will be sent to user.
    329328         *
    330          * @since BuddyPress (1.2.0)
     329         * @since 1.2.0
    331330         *
    332331         * @param string $message       Email notification message text.
     
    343342         * Fires after the sending of a reply to a reply email notification.
    344343         *
    345          * @since BuddyPress (1.5.0)
     344         * @since 1.5.0
    346345         *
    347346         * @param int    $user_id      ID of the parent activity item author.
     
    359358 * Helper method to map action arguments to function parameters.
    360359 *
    361  * @since BuddyPress (1.9.0)
     360 * @since 1.9.0
    362361 *
    363362 * @param int   $comment_id
     
    374373 * Format notifications related to activity.
    375374 *
    376  * @since BuddyPress (1.5.0)
     375 * @since 1.5.0
    377376 *
    378377 * @uses bp_loggedin_user_domain()
     
    420419         * or bp_activity_multiple_at_mentions_notification.
    421420         *
    422          * @since BuddyPress (1.5.0)
     421         * @since 1.5.0
    423422         *
    424423         * @param string $string          HTML anchor tag for the mention.
     
    438437         * or bp_activity_multiple_at_mentions_notification.
    439438         *
    440          * @since BuddyPress (1.5.0)
     439         * @since 1.5.0
    441440         *
    442441         * @param array  $array           Array holding the content and permalink for the mention notification.
     
    455454     * Fires right before returning the formatted activity notifications.
    456455     *
    457      * @since BuddyPress (1.2.0)
     456     * @since 1.2.0
    458457     *
    459458     * @param string $action            The type of activity item.
     
    475474 * 'bp_activity_at_name_send_emails' equivalent helper function.
    476475 *
    477  * @since BuddyPress (1.9.0)
     476 * @since 1.9.0
    478477 *
    479478 * @param object $activity
     
    501500 * Mark at-mention notifications as read when users visit their Mentions page.
    502501 *
    503  * @since BuddyPress (1.5.0)
     502 * @since 1.5.0
    504503 *
    505504 * @uses bp_notifications_mark_all_notifications_by_type()
     
    522521 * Mark at-mention notification as read when user visits the activity with the mention.
    523522 *
    524  * @since BuddyPress (2.0.0)
     523 * @since 2.0.0
    525524 *
    526525 * @param object BP_Activity_Activity
     
    544543 * Delete at-mention notifications when the corresponding activity item is deleted.
    545544 *
    546  * @since BuddyPress (2.0.0)
     545 * @since 2.0.0
    547546 *
    548547 * @param array $activity_ids_deleted IDs of deleted activity items.
Note: See TracChangeset for help on using the changeset viewer.