Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/17/2014 01:49:22 AM (5 years ago)
Author:
boonebgorges
Message:

Improved inline documentation in bp-groups

See #5022

File:
1 edited

Legend:

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

    r8576 r9027  
    1717
    1818/**
    19  * Notify all group members when a group is updated
     19 * Notify all group members when a group is updated.
    2020 *
    2121 * @since BuddyPress (1.0.0)
    2222 *
    23  * @param int $group_id
     23 * @param int $group_id ID of the group.
    2424 */
    2525function groups_notification_group_updated( $group_id = 0 ) {
     
    6969
    7070/**
    71  * Notify group admin about new membership request
     71 * Notify group admin about new membership request.
    7272 *
    7373 * @since BuddyPress (1.0.0)
    7474 *
    75  * @param int $requesting_user_id
    76  * @param int $admin_id
    77  * @param int $group_id
    78  * @param int $membership_id
    79  * @return boolean
     75 * @param int $requesting_user_id ID of the user requesting group membership.
     76 * @param int $admin_id ID of the group admin.
     77 * @param int $group_id ID of the group.
     78 * @param int $membership_id ID of the group membership object.
     79 * @return bool|null False on failure.
    8080 */
    8181function groups_notification_new_membership_request( $requesting_user_id = 0, $admin_id = 0, $group_id = 0, $membership_id = 0 ) {
     
    145145
    146146/**
    147  * Notify member about their group membership request
     147 * Notify member about their group membership request.
    148148 *
    149149 * @since BuddyPress (1.0.0)
    150150 *
    151  * @param type $requesting_user_id
    152  * @param type $group_id
    153  * @param type $accepted
     151 * @param int $requesting_user_id ID of the user requesting group membership.
     152 * @param int $group_id ID of the group.
     153 * @param bool $accepted Optional. Whether the membership request was accepted.
     154 *        Default: true.
    154155 * @return boolean
    155156 */
     
    224225
    225226/**
    226  * Notify group member they have been promoted
     227 * Notify group member they have been promoted.
    227228 *
    228229 * @since BuddyPress (1.0.0)
    229230 *
    230  * @param int $user_id
    231  * @param int $group_id
    232  * @return boolean
     231 * @param int $user_id ID of the user.
     232 * @param int $group_id ID of the group.
     233 * @return bool|null False on failure.
    233234 */
    234235function groups_notification_promoted_member( $user_id = 0, $group_id = 0 ) {
     
    292293
    293294/**
    294  * Notify a member they have been invitated to a group
     295 * Notify a member they have been invited to a group.
    295296 *
    296297 * @since BuddyPress (1.0.0)
    297298 *
    298  * @param object $group
    299  * @param object $member
    300  * @param int $inviter_user_id
    301  * @return boolean
     299 * @param BP_Groups_Group $group Group object.
     300 * @param BP_Groups_Member $member Member object.
     301 * @param int $inviter_user_id ID of the user who sent the invite.
     302 * @return bool|null False on failure.
    302303 */
    303304function groups_notification_group_invites( &$group, &$member, $inviter_user_id ) {
     
    375376 * @since BuddyPress (1.0.0)
    376377 *
    377  * @param string $action The kind of notification being rendered
    378  * @param int $item_id The primary item id
    379  * @param int $secondary_item_id The secondary item id
    380  * @param int $total_items The total number of messaging-related notifications waiting for the user
    381  * @param string $format 'string' for BuddyBar-compatible notifications; 'array' for WP Toolbar
     378 * @param string $action The kind of notification being rendered.
     379 * @param int $item_id The primary item ID.
     380 * @param int $secondary_item_id The secondary item ID.
     381 * @param int $total_items The total number of messaging-related notifications
     382 *        waiting for the user.
     383 * @param string $format 'string' for BuddyBar-compatible notifications; 'array'
     384 *        for WP Toolbar. Default: 'string'.
     385 * @return string
    382386 */
    383387function groups_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' ) {
     
    611615
    612616/**
    613  * Remove all notifications for any member belonging to a specific group
     617 * Remove all notifications for any member belonging to a specific group.
    614618 *
    615619 * @since BuddyPress (1.9.0)
     620 *
     621 * @param int $group_id ID of the group.
    616622 */
    617623function bp_groups_delete_group_delete_all_notifications( $group_id ) {
     
    626632 *
    627633 * @since BuddyPress (2.0.0)
     634 *
     635 * @param int $user_id ID of the user.
     636 * @param int $group_id ID of the group.
    628637 */
    629638function bp_groups_delete_promotion_notifications( $user_id = 0, $group_id = 0 ) {
     
    636645
    637646/**
    638  * Mark notifications read when a member accepts a group invitation
     647 * Mark notifications read when a member accepts a group invitation.
    639648 *
    640649 * @since BuddyPress (1.9.0)
    641  * @param int $user_id
    642  * @param int $group_id
     650 *
     651 * @param int $user_id ID of the user.
     652 * @param int $group_id ID of the group.
    643653 */
    644654function bp_groups_accept_invite_mark_notifications( $user_id, $group_id ) {
     
    652662
    653663/**
    654  * Mark notifications read when a member views their group memberships
     664 * Mark notifications read when a member views their group memberships.
    655665 *
    656666 * @since BuddyPress (1.9.0)
     
    676686
    677687/**
    678  * Mark group invitation notifications read when a member views their invitations
     688 * Mark group invitation notifications read when a member views their invitations.
    679689 *
    680690 * @since BuddyPress (1.9.0)
     
    688698
    689699/**
    690  * Mark group join requests read when an admin or moderator visits the group
    691  * administration area.
     700 * Mark group join requests read when an admin or moderator visits the group administration area.
    692701 *
    693702 * @since BuddyPress (1.9.0)
     
    704713 *
    705714 * @since BuddyPress (1.9.0)
    706  * @param int $user_id
     715 *
     716 * @param int $user_id ID of the user.
    707717 */
    708718function bp_groups_remove_data_for_user_notifications( $user_id ) {
Note: See TracChangeset for help on using the changeset viewer.