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

Delete notifications for an item ID.

Description Description

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

Top ↑

Parameters Parameters


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


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


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


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


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

Default value: false

Top ↑

Return Return

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

Source Source

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

function bp_notifications_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false ) {
	return BP_Notifications_Notification::delete( array(
		'user_id'           => $user_id,
		'item_id'           => $item_id,
		'secondary_item_id' => $secondary_item_id,
		'component_name'    => $component_name,
		'component_action'  => $component_action,
	) );

Top ↑

Changelog Changelog

Version Description
1.9.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.