Contents

Code Reference Functions bp_notifications_delete_notifications_by_type()

bp_notifications_delete_notifications_by_type( int $user_id, string $component_name, string $component_action )

Delete notifications for a user by type.

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.

$component_name

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

$component_action

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

Return

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

Source

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

function bp_notifications_delete_notifications_by_type( $user_id, $component_name, $component_action ) {
	return BP_Notifications_Notification::delete( array(
		'user_id'          => $user_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.

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.