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
		)
	);
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.9.0	Introduced.

Uses

Uses
Uses	Description
bp-notifications/classes/class-bp-notifications-notification.php: BP_Notifications_Notification::update()	Update notifications.

Used By
Used By	Description
bp-forums/notifications.php: bbp_buddypress_mark_notifications()	Mark notifications as read when reading a topic
bp-messages/bp-messages-notifications.php: bp_messages_screen_conversation_mark_notifications()	Mark new message notification when member reads a message thread directly.
bp-messages/bp-messages-notifications.php: bp_messages_mark_notification_on_mark_thread()	Mark new message notification as read when the corresponding message is mark read.
bp-groups/bp-groups-notifications.php: bp_groups_accept_invite_mark_notifications()	Mark notifications read when a member accepts a group invitation.
bp-groups/bp-groups-notifications.php: bp_groups_accept_request_mark_notifications()	Mark notifications read when a member’s group membership request is granted.
bp-friends/bp-friends-notifications.php: bp_friends_mark_friendship_rejected_notifications_by_item_id()	Remove friend request notice when a member rejects another members
bp-friends/bp-friends-notifications.php: bp_friends_add_friendship_accepted_notification()	Notify a member when another member accepts their virtual friendship request.
bp-templates/bp-nouveau/includes/messages/ajax.php: bp_nouveau_ajax_messages_thread_read()	AJAX mark message as read.
bp-activity/bp-activity-notifications.php: bp_activity_remove_screen_notifications_single_activity_permalink()	Mark notifications as read when a user visits an activity permalink.

Show 4 more used by Hide more used by

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