bp_notifications_mark_notifications_by_type( int $user_id, string $component_name, string $component_action, int|bool $is_new = false )
Mark notifications read/unread for a user by type.
Description Description
Used when clearing out notifications for a specific component when the user has visited that component.
Parameters Parameters
- $user_id
-
(Required) ID of the user whose notifications are being deleted.
- $component_name
-
(Required) Name of the associated component.
- $component_action
-
(Required) Name of the associated action.
- $is_new
-
(Optional) 0 for read, 1 for unread.
Default value: false
Return Return
(int|false) True on success, false on failure.
Source Source
File: bp-notifications/bp-notifications-functions.php
function bp_notifications_mark_notifications_by_type( $user_id, $component_name, $component_action, $is_new = false ) {
return BP_Notifications_Notification::update(
array(
'is_new' => $is_new
),
array(
'user_id' => $user_id,
'component_name' => $component_name,
'component_action' => $component_action
)
);
}
Changelog Changelog
| Version | Description |
|---|---|
| 1.9.0 | Introduced. |