Contents

Code Reference Classes BP_Notifications_Notification BP_Notifications_Notification::delete()

BP_Notifications_Notification::delete( array $args = array() )

Delete notifications.

Description

See also

Parameters

$args

(Optional) Associative array of columns/values, to determine which rows should be deleted. Of the format array( 'item_id' => 7, 'component_action' => 'members', ).

Default value: array()

Return

(int|false) Number of rows deleted on success, false on failure.

Source

File: bp-notifications/classes/class-bp-notifications-notification.php 

	public static function delete( $args = array() ) {
		$where = self::get_query_clauses( $args );

		/**
		 * Fires before the deletion of a notification item.
		 *
		 * @since BuddyPress 2.0.0
		 *
		 * @param array $args Associative array of columns/values, to determine
		 *                    which rows should be deleted. Of the format
		 *                    array( 'item_id' => 7, 'component_action' => 'members' ).
		 */
		do_action( 'bp_notification_before_delete', $args );

		return self::_delete( $where['data'], $where['format'] );
	}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.9.0 Introduced.
Used By
Used By Description
bp-notifications/classes/class-bp-rest-notifications-endpoint.php: BP_REST_Notifications_Endpoint::delete_item()

Delete a notification.
bp-notifications/bp-notifications-functions.php: bp_notifications_delete_notifications_from_user()

Delete all notifications from a user.
bp-notifications/bp-notifications-functions.php: bp_notifications_delete_notifications_on_user_delete()

Delete a user’s notifications when the user is deleted.
bp-notifications/bp-notifications-functions.php: bp_notifications_delete_notifications_by_type()

Delete notifications for a user by type.
bp-notifications/bp-notifications-functions.php: bp_notifications_delete_notifications_by_item_id()

Delete notifications for an item ID.
bp-notifications/bp-notifications-functions.php: bp_notifications_delete_all_notifications_by_type()

Delete all notifications by type.
bp-notifications/bp-notifications-functions.php: bp_notifications_delete_notification()

Delete a specific notification by its ID.
bp-notifications/classes/class-bp-notifications-notification.php: BP_Notifications_Notification::delete_by_id()

Delete a single notification by ID.
Show 3 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.