[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

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

BuddyPress Friends Activity Functions. These functions handle the recording, deleting and formatting of activity for the user and for this specific component.

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

Defines 10 functions

  friends_format_notifications()
  friends_clear_friend_notifications()
  bp_friends_mark_friendship_request_notifications_by_type()
  bp_friends_mark_friendship_accepted_notifications_by_type()
  bp_friends_friendship_requested_notification()
  bp_friends_mark_friendship_rejected_notifications_by_item_id()
  bp_friends_add_friendship_accepted_notification()
  bp_friends_mark_friendship_withdrawn_notifications_by_item_id()
  bp_friends_remove_notifications_data()
  friends_screen_notification_settings()

Functions
Functions that are not part of a class:

friends_format_notifications( $action, $item_id, $secondary_item_id, $total_items, $format = 'string' )   X-Ref
Notification formatting callback for bp-friends notifications.

since: 1.0.0
return: array|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;

friends_clear_friend_notifications()   X-Ref
Clear friend-related notifications when ?new=1

since: 1.2.0

bp_friends_mark_friendship_request_notifications_by_type()   X-Ref
Delete any friendship request notifications for the logged in user.

since: 1.9.0

bp_friends_mark_friendship_accepted_notifications_by_type()   X-Ref
Delete any friendship acceptance notifications for the logged in user.

since: 1.9.0

bp_friends_friendship_requested_notification( $friendship_id, $initiator_user_id, $friend_user_id )   X-Ref
Notify one use that another user has requested their virtual friendship.

since: 1.9.0
param: int $friendship_id     The unique ID of the friendship.
param: int $initiator_user_id The friendship initiator user ID.
param: int $friend_user_id    The friendship request receiver user ID.

bp_friends_mark_friendship_rejected_notifications_by_item_id( $friendship_id, $friendship )   X-Ref
Remove friend request notice when a member rejects another members

since: 1.9.0
param: int    $friendship_id Friendship ID (not used).
param: object $friendship    Friendship object.

bp_friends_add_friendship_accepted_notification( $friendship_id, $initiator_user_id, $friend_user_id )   X-Ref
Notify a member when another member accepts their virtual friendship request.

since: 1.9.0
param: int $friendship_id     The unique ID of the friendship.
param: int $initiator_user_id The friendship initiator user ID.
param: int $friend_user_id    The friendship request receiver user ID.

bp_friends_mark_friendship_withdrawn_notifications_by_item_id( $friendship_id, $friendship )   X-Ref
Remove friend request notice when a member withdraws their friend request.

since: 1.9.0
param: int    $friendship_id Friendship ID (not used).
param: object $friendship    Friendship Object.

bp_friends_remove_notifications_data( $user_id = 0 )   X-Ref
Remove friendship requests FROM user, used primarily when a user is deleted.

since: 1.9.0
param: int $user_id ID of the user whose notifications are removed.

friends_screen_notification_settings()   X-Ref
Add Friends-related settings to the Settings > Notifications page.

since: 1.0.0



Generated: Sun Jul 21 01:01:44 2019 Cross-referenced by PHPXref 0.7.1