Contents

Code Reference Classes BP_Notifications_Notification BP_Notifications_Notification::update()

BP_Notifications_Notification::update( array $update_args = array(), array $where_args = array() )

Update notifications.

Description

See also

Parameters

$update_args

(Optional) Associative array of fields to update, and the values to update them to. Of the format array( 'user_id' => 4, 'component_name' => 'groups', ).

Default value: array()

$where_args

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

Default value: array()

Return

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

Source

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

	public static function update( $update_args = array(), $where_args = array() ) {
		$update = self::get_query_clauses( $update_args );
		$where  = self::get_query_clauses( $where_args  );

		/**
		 * Fires before the update of a notification item.
		 *
		 * @since BuddyPress 2.3.0
		 *
		 * @param array $update_args See BP_Notifications_Notification::update().
		 * @param array $where_args  See BP_Notifications_Notification::update().
		 */
		do_action( 'bp_notification_before_update', $update_args, $where_args );

		return self::_update(
			$update['data'],
			$where['data'],
			$update['format'],
			$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-activity/bp-activity-notifications.php: bp_activity_remove_screen_notifications_single_post()

Mark notifications as read when a user visits an single post.
bp-notifications/classes/class-bp-rest-notifications-endpoint.php: BP_REST_Notifications_Endpoint::update_item()

Update a notification.
bp-notifications/bp-notifications-functions.php: bp_notifications_mark_notifications_by_type()

Mark notifications read/unread for a user by type.
bp-notifications/bp-notifications-functions.php: bp_notifications_mark_notifications_by_item_id()

Mark notifications read/unread for an item ID.
bp-notifications/bp-notifications-functions.php: bp_notifications_mark_all_notifications_by_type()

Mark all notifications read/unread by type.
bp-notifications/bp-notifications-functions.php: bp_notifications_mark_notifications_from_user()

Mark all notifications read/unread from a user.
bp-notifications/bp-notifications-functions.php: bp_notifications_mark_notification()

Mark notification read/unread for a user by ID.
bp-notifications/classes/class-bp-notifications-notification.php: BP_Notifications_Notification::mark_all_for_user()

Mark all user notifications as read.
bp-notifications/classes/class-bp-notifications-notification.php: BP_Notifications_Notification::mark_all_from_user()

Mark all notifications from a user as read.
bp-notifications/classes/class-bp-notifications-notification.php: BP_Notifications_Notification::mark_all_by_type()

Mark all notifications for all users as read by item id, and optional secondary item id, and component name and action.
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.
bp-activity/bp-activity-notifications.php: bp_activity_remove_screen_notifications_for_non_mentions()

Mark non-mention notifications as read when user visits our read permalink.
Show 7 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.