[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

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

BuddyPress Messages Notifications.

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

Defines 6 functions

  messages_format_notifications()
  bp_messages_message_sent_add_notification()
  bp_messages_screen_conversation_mark_notifications()
  bp_messages_mark_notification_on_mark_thread()
  bp_messages_message_delete_notifications()
  messages_screen_notification_settings()

Functions
Functions that are not part of a class:

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

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 notification HTML link or 'array' for separate link and text.
since: 1.0.0
return: string|array Formatted notifications.

bp_messages_message_sent_add_notification( $message )   X-Ref
Send notifications to message recipients.

param: BP_Messages_Message $message Message object.
since: 1.9.0

bp_messages_screen_conversation_mark_notifications()   X-Ref
Mark new message notification when member reads a message thread directly.

since: 1.9.0

bp_messages_mark_notification_on_mark_thread( $thread_id, $user_id = 0, $num_rows = 0 )   X-Ref
Mark new message notification as read when the corresponding message is mark read.

This callback covers mark-as-read bulk actions.

param: int $thread_id ID of the thread being marked as read.
param: int $user_id   ID of the user who read the thread.
param: int $num_rows  The number of affected rows by the "mark read" update query.
since: 3.0.0

bp_messages_message_delete_notifications( $thread_id, $message_ids )   X-Ref
When a message is deleted, delete corresponding notifications.

param: int   $thread_id   ID of the thread.
param: int[] $message_ids The list of message IDs to delete.
since: 2.0.0

messages_screen_notification_settings()   X-Ref
Render the markup for the Messages section of Settings > Notifications.

since: 1.0.0



Generated: Tue Dec 7 01:00:59 2021 Cross-referenced by PHPXref 0.7.1