bp_notifications_mark_notifications_by_item_id( int $user_id, int $item_id, string $component_name, string $component_action, int|bool $secondary_item_id = false, int|bool $is_new = false )

Mark notifications read/unread for an item ID.

Description

Used when clearing out notifications for a specific component when the user has visited that component.

Parameters

$user_id

(int) (Required) ID of the user whose notifications are being deleted.

$item_id

(int) (Required) ID of the associated item.

$component_name

(string) (Required) Name of the associated component.

$component_action

(string) (Required) Name of the associated action.

$secondary_item_id

(int|bool) (Optional) ID of the secondary associated item.

Default value: false

$is_new

(int|bool) (Optional) 0 for read, 1 for unread.

Default value: false

Return

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

Source

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

function bp_notifications_mark_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false, $is_new = false ) {
	return BP_Notifications_Notification::update(
		array(
			'is_new' => $is_new
		),
		array(
			'user_id'           => $user_id,
			'item_id'           => $item_id,
			'secondary_item_id' => $secondary_item_id,
			'component_name'    => $component_name,
			'component_action'  => $component_action
		)
	);
}

Changelog

Changelog
Version Description
BuddyPress 1.9.0 Introduced.

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.