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

    r9970 r10148  
    11<?php
    2 
    32/**
    43 * BuddyPress Groups Notification Functions.
     
    1110 */
    1211
    13 // Exit if accessed directly
     12// Exit if accessed directly.
    1413defined( 'ABSPATH' ) || exit;
    1514
     
    1918 * Notify all group members when a group is updated.
    2019 *
    21  * @since BuddyPress (1.0.0)
     20 * @since 1.0.0
    2221 *
    2322 * @param int                  $group_id  ID of the group.
     
    5150     * Filters the bullet points listing updated items in the email notification after a group is updated.
    5251     *
    53      * @since BuddyPress (2.2.0)
     52     * @since 2.2.0
    5453     *
    5554     * @param array $changed Array of bullet points.
     
    9493         * Filters the user email that the group update notification will be sent to.
    9594         *
    96          * @since BuddyPress (1.2.0)
     95         * @since 1.2.0
    9796         *
    9897         * @param string $to User email the notification is being sent to.
     
    103102         * Filters the group update notification subject that will be sent to user.
    104103         *
    105          * @since BuddyPress (1.2.0)
     104         * @since 1.2.0
    106105         *
    107106         * @param string          $subject Email notification subject text.
     
    113112         * Filters the group update notification message that will be sent to user.
    114113         *
    115          * @since BuddyPress (1.2.0)
     114         * @since 1.2.0
    116115         *
    117116         * @param string          $message       Email notification message text.
     
    132131     * See https://buddypress.trac.wordpress.org/ticket/3644 for blank message parameter.
    133132     *
    134      * @since BuddyPress (1.5.0)
     133     * @since 1.5.0
    135134     *
    136135     * @param array  $user_ids Array of user IDs to notify about the update.
     
    145144 * Notify group admin about new membership request.
    146145 *
    147  * @since BuddyPress (1.0.0)
     146 * @since 1.0.0
    148147 *
    149148 * @param int $requesting_user_id ID of the user requesting group membership.
     
    234233     * Filters the user email that the group membership request will be sent to.
    235234     *
    236      * @since BuddyPress (1.2.0)
     235     * @since 1.2.0
    237236     *
    238237     * @param string $to User email the request is being sent to.
     
    243242     * Filters the group membership request subject that will be sent to user.
    244243     *
    245      * @since BuddyPress (1.2.0)
     244     * @since 1.2.0
    246245     *
    247246     * @param string          $subject Membership request email subject text.
     
    253252     * Filters the group membership request message that will be sent to user.
    254253     *
    255      * @since BuddyPress (1.2.0)
     254     * @since 1.2.0
    256255     *
    257256     * @param string          $message              Membership request email message text.
     
    269268     * Fires after the notification is sent that a member has requested group membership.
    270269     *
    271      * @since BuddyPress (1.5.0)
     270     * @since 1.5.0
    272271     *
    273272     * @param int    $admin_id           ID of the group administrator.
     
    284283 * Notify member about their group membership request.
    285284 *
    286  * @since BuddyPress (1.0.0)
     285 * @since 1.0.0
    287286 *
    288287 * @param int  $requesting_user_id ID of the user requesting group membership.
     
    353352     * Filters the user email that the group membership request result will be sent to.
    354353     *
    355      * @since BuddyPress (1.2.0)
     354     * @since 1.2.0
    356355     *
    357356     * @param string $to User email the request result is being sent to.
     
    362361     * Filters the group membership request result subject that will be sent to user.
    363362     *
    364      * @since BuddyPress (1.2.0)
     363     * @since 1.2.0
    365364     *
    366365     * @param string          $subject Membership request result email subject text.
     
    372371     * Filters the group membership request result message that will be sent to user.
    373372     *
    374      * @since BuddyPress (1.2.0)
     373     * @since 1.2.0
    375374     *
    376375     * @param string          $message       Membership request result email message text.
     
    386385     * Fires after the notification is sent that a membership has been approved.
    387386     *
    388      * @since BuddyPress (1.5.0)
     387     * @since 1.5.0
    389388     *
    390389     * @param int    $requesting_user_id ID of the user whose membership was approved.
     
    401400 * Notify group member they have been promoted.
    402401 *
    403  * @since BuddyPress (1.0.0)
     402 * @since 1.0.0
    404403 *
    405404 * @param int $user_id  ID of the user.
     
    459458     * Filters the user email that the group promotion notification will be sent to.
    460459     *
    461      * @since BuddyPress (1.2.0)
     460     * @since 1.2.0
    462461     *
    463462     * @param string $to User email the promotion notification is being sent to.
     
    468467     * Filters the group promotion notification subject that will be sent to user.
    469468     *
    470      * @since BuddyPress (1.2.0)
     469     * @since 1.2.0
    471470     *
    472471     * @param string          $subject Promotion notification email subject text.
     
    478477     * Filters the group promotion notification message that will be sent to user.
    479478     *
    480      * @since BuddyPress (1.2.0)
     479     * @since 1.2.0
    481480     *
    482481     * @param string          $message       Promotion notification email message text.
     
    493492     * Fires after the notification is sent that a member has been promoted.
    494493     *
    495      * @since BuddyPress (1.5.0)
     494     * @since 1.5.0
    496495     *
    497496     * @param int    $user_id  ID of the user who was promoted.
     
    507506 * Notify a member they have been invited to a group.
    508507 *
    509  * @since BuddyPress (1.0.0)
     508 * @since 1.0.0
    510509 *
    511510 * @param BP_Groups_Group  $group           Group object.
     
    575574     * Filters the user email that the group invite notification will be sent to.
    576575     *
    577      * @since BuddyPress (1.2.0)
     576     * @since 1.2.0
    578577     *
    579578     * @param string $to User email the invite notification is being sent to.
     
    584583     * Filters the group invite notification subject that will be sent to user.
    585584     *
    586      * @since BuddyPress (1.2.0)
     585     * @since 1.2.0
    587586     *
    588587     * @param string          $subject Invite notification email subject text.
     
    594593     * Filters the group invite notification message that will be sent to user.
    595594     *
    596      * @since BuddyPress (1.2.0)
     595     * @since 1.2.0
    597596     *
    598597     * @param string          $message       Invite notification email message text.
     
    611610     * Fires after the notification is sent that a member has been invited to a group.
    612611     *
    613      * @since BuddyPress (1.5.0)
     612     * @since 1.5.0
    614613     *
    615614     * @param int             $invited_user_id  ID of the user who was invited.
     
    626625 * Format notifications for the Groups component.
    627626 *
    628  * @since BuddyPress (1.0.0)
     627 * @since 1.0.0
    629628 *
    630629 * @param string $action            The kind of notification being rendered.
     
    665664                     * Complete filter - bp_groups_multiple_new_membership_requests_notification.
    666665                     *
    667                      * @since BuddyPress (1.0.0)
     666                     * @since 1.0.0
    668667                     *
    669668                     * @param string $string            HTML anchor tag for request.
     
    683682                     * Complete filter - bp_groups_multiple_new_membership_requests_notification.
    684683                     *
    685                      * @since BuddyPress (1.0.0)
     684                     * @since 1.0.0
    686685                     *
    687686                     * @param array  $array             Array holding permalink and content for notification.
     
    710709                     * Complete filter - bp_groups_single_new_membership_request_notification.
    711710                     *
    712                      * @since BuddyPress (1.0.0)
     711                     * @since 1.0.0
    713712                     *
    714713                     * @param string $string            HTML anchor tag for request.
     
    728727                     * Complete filter - bp_groups_single_new_membership_request_notification.
    729728                     *
    730                      * @since BuddyPress (1.0.0)
     729                     * @since 1.0.0
    731730                     *
    732731                     * @param array  $array             Array holding permalink and content for notification.
     
    764763                     * Complete filter - bp_groups_multiple_membership_request_accepted_notification.
    765764                     *
    766                      * @since BuddyPress (1.0.0)
     765                     * @since 1.0.0
    767766                     *
    768767                     * @param string $string            HTML anchor tag for notification.
     
    779778                     * Complete filter - bp_groups_multiple_membership_request_accepted_notification.
    780779                     *
    781                      * @since BuddyPress (1.0.0)
     780                     * @since 1.0.0
    782781                     *
    783782                     * @param array  $array             Array holding permalink and content for notification
     
    803802                     * Complete filter - bp_groups_single_membership_request_accepted_notification.
    804803                     *
    805                      * @since BuddyPress (1.0.0)
     804                     * @since 1.0.0
    806805                     *
    807806                     * @param string $string            HTML anchor tag for notification.
     
    818817                     * Complete filter - bp_groups_single_membership_request_accepted_notification.
    819818                     *
    820                      * @since BuddyPress (1.0.0)
     819                     * @since 1.0.0
    821820                     *
    822821                     * @param array  $array             Array holding permalink and content for notification.
     
    853852                     * Complete filter - bp_groups_multiple_membership_request_rejected_notification.
    854853                     *
    855                      * @since BuddyPress (1.0.0)
     854                     * @since 1.0.0
    856855                     *
    857856                     * @param string $string            HTML anchor tag for notification.
     
    868867                     * Complete filter - bp_groups_multiple_membership_request_rejected_notification.
    869868                     *
    870                      * @since BuddyPress (1.0.0)
     869                     * @since 1.0.0
    871870                     *
    872871                     * @param array  $array             Array holding permalink and content for notification.
     
    891890                     * Complete filter - bp_groups_single_membership_request_rejected_notification.
    892891                     *
    893                      * @since BuddyPress (1.0.0)
     892                     * @since 1.0.0
    894893                     *
    895894                     * @param string $string            HTML anchor tag for notification.
     
    906905                     * Complete filter - bp_groups_single_membership_request_rejected_notification.
    907906                     *
    908                      * @since BuddyPress (1.0.0)
     907                     * @since 1.0.0
    909908                     *
    910909                     * @param array  $array             Array holding permalink and content for notification.
     
    940939                     * Complete filter - bp_groups_multiple_member_promoted_to_admin_notification.
    941940                     *
    942                      * @since BuddyPress (1.0.0)
     941                     * @since 1.0.0
    943942                     *
    944943                     * @param string $string            HTML anchor tag for notification.
     
    953952                     * Complete filter - bp_groups_multiple_member_promoted_to_admin_notification.
    954953                     *
    955                      * @since BuddyPress (1.0.0)
     954                     * @since 1.0.0
    956955                     *
    957956                     * @param array  $array             Array holding permalink and content for notification.
     
    974973                     * Complete filter - bp_groups_single_member_promoted_to_admin_notification.
    975974                     *
    976                      * @since BuddyPress (1.0.0)
     975                     * @since 1.0.0
    977976                     *
    978977                     * @param string $string            HTML anchor tag for notification.
     
    988987                     * Complete filter - bp_groups_single_member_promoted_to_admin_notification.
    989988                     *
    990                      * @since BuddyPress (1.0.0)
     989                     * @since 1.0.0
    991990                     *
    992991                     * @param array  $array             Array holding permalink and content for notification.
     
    10221021                     * Complete filter - bp_groups_multiple_member_promoted_to_mod_notification.
    10231022                     *
    1024                      * @since BuddyPress (1.0.0)
     1023                     * @since 1.0.0
    10251024                     *
    10261025                     * @param string $string            HTML anchor tag for notification.
     
    10561055                     * Complete filter - bp_groups_single_member_promoted_to_mod_notification.
    10571056                     *
    1058                      * @since BuddyPress (1.0.0)
     1057                     * @since 1.0.0
    10591058                     *
    10601059                     * @param string $string            HTML anchor tag for notification.
     
    10701069                     * Complete filter - bp_groups_single_member_promoted_to_mod_notification.
    10711070                     *
    1072                      * @since BuddyPress (1.0.0)
     1071                     * @since 1.0.0
    10731072                     *
    10741073                     * @param array  $array             Array holding permalink and content for notification.
     
    11041103                     * Complete filter - bp_groups_multiple_group_invite_notification.
    11051104                     *
    1106                      * @since BuddyPress (1.0.0)
     1105                     * @since 1.0.0
    11071106                     *
    11081107                     * @param string $string            HTML anchor tag for notification.
     
    11171116                     * Complete filter - bp_groups_multiple_group_invite_notification.
    11181117                     *
    1119                      * @since BuddyPress (1.0.0)
     1118                     * @since 1.0.0
    11201119                     *
    11211120                     * @param array  $array             Array holding permalink and content for notification.
     
    11381137                     * Complete filter - bp_groups_single_group_invite_notification.
    11391138                     *
    1140                      * @since BuddyPress (1.0.0)
     1139                     * @since 1.0.0
    11411140                     *
    11421141                     * @param string $string            HTML anchor tag for notification.
     
    11521151                     * Complete filter - bp_groups_single_group_invite_notification.
    11531152                     *
    1154                      * @since BuddyPress (1.0.0)
     1153                     * @since 1.0.0
    11551154                     *
    11561155                     * @param array  $array             Array holding permalink and content for notification.
     
    11741173             * Filters plugin-added group-related custom component_actions.
    11751174             *
    1176              * @since BuddyPress (2.4.0)
     1175             * @since 2.4.0
    11771176             *
    11781177             * @param string $notification      Null value.
     
    11961195     * Fires right before returning the formatted group notifications.
    11971196     *
    1198      * @since BuddyPress (1.0.0)
     1197     * @since 1.0.0
    11991198     *
    12001199     * @param string $action            The type of notification being rendered.
     
    12111210 * Remove all notifications for any member belonging to a specific group.
    12121211 *
    1213  * @since BuddyPress (1.9.0)
     1212 * @since 1.9.0
    12141213 *
    12151214 * @param int $group_id ID of the group.
     
    12251224 * When a demotion takes place, delete any corresponding promotion notifications.
    12261225 *
    1227  * @since BuddyPress (2.0.0)
     1226 * @since 2.0.0
    12281227 *
    12291228 * @param int $user_id  ID of the user.
     
    12411240 * Mark notifications read when a member accepts a group invitation.
    12421241 *
    1243  * @since BuddyPress (1.9.0)
     1242 * @since 1.9.0
    12441243 *
    12451244 * @param int $user_id  ID of the user.
     
    12581257 * Mark notifications read when a member views their group memberships.
    12591258 *
    1260  * @since BuddyPress (1.9.0)
     1259 * @since 1.9.0
    12611260 */
    12621261function bp_groups_screen_my_groups_mark_notifications() {
     
    12821281 * Mark group invitation notifications read when a member views their invitations.
    12831282 *
    1284  * @since BuddyPress (1.9.0)
     1283 * @since 1.9.0
    12851284 */
    12861285function bp_groups_screen_invites_mark_notifications() {
     
    12941293 * Mark group join requests read when an admin or moderator visits the group administration area.
    12951294 *
    1296  * @since BuddyPress (1.9.0)
     1295 * @since 1.9.0
    12971296 */
    12981297function bp_groups_screen_group_admin_requests_mark_notifications() {
     
    13061305 * Delete new group membership notifications when a user is being deleted.
    13071306 *
    1308  * @since BuddyPress (1.9.0)
     1307 * @since 1.9.0
    13091308 *
    13101309 * @param int $user_id ID of the user.
Note: See TracChangeset for help on using the changeset viewer.