[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-groups/ -> bp-groups-notifications.php (summary)

BuddyPress Groups Notification Functions. These functions handle the recording, deleting and formatting of notifications for the user and for this specific component.

File Size: 1204 lines (50 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 16 functions

  groups_notification_group_updated()
  groups_notification_new_membership_request()
  groups_notification_membership_request_completed()
  groups_notification_promoted_member()
  groups_notification_group_invites()
  groups_format_notifications()
  bp_groups_delete_group_delete_all_notifications()
  bp_groups_uninvite_user_delete_group_invite_notification()
  bp_groups_delete_promotion_notifications()
  bp_groups_accept_invite_mark_notifications()
  bp_groups_accept_request_mark_notifications()
  bp_groups_screen_my_groups_mark_notifications()
  bp_groups_screen_invites_mark_notifications()
  bp_groups_screen_group_admin_requests_mark_notifications()
  bp_groups_remove_data_for_user_notifications()
  groups_screen_notification_settings()

Functions
Functions that are not part of a class:

groups_notification_group_updated( $group_id = 0, $old_group = null )   X-Ref
Notify all group members when a group is updated.

since: 1.0.0
param: int                  $group_id  ID of the group.
param: BP_Groups_Group|null $old_group Group before new details were saved.

groups_notification_new_membership_request( $requesting_user_id = 0, $admin_id = 0, $group_id = 0, $membership_id = 0 )   X-Ref
Notify group admin about new membership request.

since: 1.0.0
param: int $requesting_user_id ID of the user requesting group membership.
param: int $admin_id           ID of the group admin.
param: int $group_id           ID of the group.
param: int $membership_id      ID of the group membership object.

groups_notification_membership_request_completed( $requesting_user_id = 0, $group_id = 0, $accepted = true )   X-Ref
Notify member about their group membership request.

since: 1.0.0
param: int  $requesting_user_id ID of the user requesting group membership.
param: int  $group_id           ID of the group.
param: bool $accepted           Optional. Whether the membership request was accepted.

groups_notification_promoted_member( $user_id = 0, $group_id = 0 )   X-Ref
Notify group member they have been promoted.

since: 1.0.0
param: int $user_id  ID of the user.
param: int $group_id ID of the group.

groups_notification_group_invites( &$group, &$member, $inviter_user_id )   X-Ref
Notify a member they have been invited to a group.

since: 1.0.0
param: BP_Groups_Group      $group           Group object.
param: BP_Groups_Member|int $member          Member object or invited_user_id.
param: int                  $inviter_user_id ID of the user who sent the invite.

groups_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' )   X-Ref
Format notifications for the Groups component.

since: 1.0.0
return: string
param: string $action            The kind of notification being rendered.
param: int    $item_id           The primary item ID.
param: int    $secondary_item_id The secondary item ID.
param: int    $total_items       The total number of messaging-related notifications
param: string $format            'string' for BuddyBar-compatible notifications; 'array'

bp_groups_delete_group_delete_all_notifications( $group_id )   X-Ref
Remove all notifications for any member belonging to a specific group.

since: 1.9.0
param: int $group_id ID of the group.

bp_groups_uninvite_user_delete_group_invite_notification( $group_id = 0, $user_id = 0 )   X-Ref
Remove Group invite notification when a user is uninvited.

since: 5.0.0
param: int $group_id ID of the group being uninvited from.
param: int $user_id  ID of the user being uninvited.

bp_groups_delete_promotion_notifications( $user_id = 0, $group_id = 0 )   X-Ref
When a demotion takes place, delete any corresponding promotion notifications.

since: 2.0.0
param: int $user_id  ID of the user.
param: int $group_id ID of the group.

bp_groups_accept_invite_mark_notifications( $user_id, $group_id )   X-Ref
Mark notifications read when a member accepts a group invitation.

since: 1.9.0
param: int $user_id  ID of the user.
param: int $group_id ID of the group.

bp_groups_accept_request_mark_notifications( $user_id, $group_id )   X-Ref
Mark notifications read when a member's group membership request is granted.

since: 2.8.0
param: int $user_id  ID of the user.
param: int $group_id ID of the group.

bp_groups_screen_my_groups_mark_notifications()   X-Ref
Mark notifications read when a member views their group memberships.

since: 1.9.0

bp_groups_screen_invites_mark_notifications()   X-Ref
Mark group invitation notifications read when a member views their invitations.

since: 1.9.0

bp_groups_screen_group_admin_requests_mark_notifications()   X-Ref
Mark group join requests read when an admin or moderator visits the group administration area.

since: 1.9.0

bp_groups_remove_data_for_user_notifications( $user_id )   X-Ref
Delete new group membership notifications when a user is being deleted.

since: 1.9.0
param: int $user_id ID of the user.

groups_screen_notification_settings()   X-Ref
Render the group settings fields on the Notification Settings page.

since: 1.0.0



Generated: Sat Sep 21 01:01:46 2019 Cross-referenced by PHPXref 0.7.1