bp_notifications_mark_notification( int $id, int|bool $is_new = false )

Mark notification read/unread for a user by ID.

Description

Used when clearing out notifications for a specific notification item.

Parameters

$id

(Required) ID of the notification.

$is_new

(Optional) 0 for read, 1 for unread.

Default value: false

Return

(false|int) True on success, false on failure.

Source

File: bp-notifications/bp-notifications-functions.php

function bp_notifications_mark_notification( $id, $is_new = false ) {
	if ( ! bp_notifications_check_notification_access( bp_displayed_user_id(), $id ) ) {
		return false;
	}

	return BP_Notifications_Notification::update(
		array( 'is_new' => $is_new ),
		array( 'id'     => $id     )
	);
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.9.0	Introduced.

Uses

Uses
Uses	Description
bp-notifications/bp-notifications-functions.php: bp_notifications_check_notification_access()	Check if a user has access to a specific notification.
bp-notifications/classes/class-bp-notifications-notification.php: BP_Notifications_Notification::update()	Update notifications.
bp-core/bp-core-template.php: bp_displayed_user_id()	Get the ID of the currently displayed user.

Used By
Used By	Description
bp-notifications/screens/read.php: bp_notifications_action_mark_unread()	Handle marking single notifications as unread.
bp-notifications/screens/unread.php: bp_notifications_action_mark_read()	Handle marking single notifications as read.
bp-notifications/actions/bulk-manage.php: bp_notifications_action_bulk_manage()	Handles bulk management (mark as read/unread, delete) of notifications.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.

Contents