[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-core/deprecated/ -> 1.9.php (summary)

BuddyPress Member Notifications Backwards compatibility functions and filters used for member notifications. Use bp-notifications instead.

File Size: 267 lines (8 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 9 functions

  bp_core_add_notification()
  bp_core_delete_notification()
  bp_core_get_notification()
  bp_core_get_notifications_for_user()
  bp_core_delete_notifications_by_type()
  bp_core_delete_notifications_by_item_id()
  bp_core_delete_all_notifications_by_type()
  bp_core_delete_notifications_from_user()
  bp_core_check_notification_access()

Functions
Functions that are not part of a class:

bp_core_add_notification( $item_id, $user_id, $component_name, $component_action, $secondary_item_id = 0, $date_notified = false, $is_new = 1 )   X-Ref
Add a notification for a specific user, from a specific component.

since: 1.0.0
return: int|boolean True on success, false on failure.
param: string       $item_id
param: int          $user_id
param: string       $component_name
param: string       $component_action
param: int          $secondary_item_id
param: false|string $date_notified
param: int          $is_new

bp_core_delete_notification( $id )   X-Ref
Delete a specific notification by its ID.

since: 1.0.0
return: false|integer True on success, false on failure.
param: int $id ID of notification.

bp_core_get_notification( $id )   X-Ref
Get a specific notification by its ID.

since: 1.0.0
return: false|BP_Core_Notification
param: int $id ID of notification.

bp_core_get_notifications_for_user( $user_id, $format = 'string' )   X-Ref
Get notifications for a specific user.

since: 1.0.0
return: boolean Object or array on success, false on failure.
param: int $user_id ID of user.
param: string $format

bp_core_delete_notifications_by_type( $user_id, $component_name, $component_action )   X-Ref
Delete notifications for a user by type.

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

since: 1.0.0
return: false|int True on success, false on failure.
param: int $user_id
param: string $component_name
param: string $component_action

bp_core_delete_notifications_by_item_id( $user_id, $item_id, $component_name, $component_action, $secondary_item_id = false )   X-Ref
Delete notifications for an item ID.

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

since: 1.0.0
return: false|int True on success, false on failure.
param: int $user_id
param: string $component_name
param: string $component_action

bp_core_delete_all_notifications_by_type( $item_id, $component_name, $component_action = false, $secondary_item_id = false )   X-Ref
Delete all notifications for by type.

since: 1.0.0
return: boolean True on success, false on failure.
param: int          $user_id
param: string       $component_name
param: false|string $component_action

bp_core_delete_notifications_from_user( $user_id, $component_name, $component_action )   X-Ref
Delete all notifications for a user.

Used when clearing out all notifications for a user, when deleted or spammed

since: 1.0.0
return: false|int True on success, false on failure.
param: int $user_id
param: string $component_name
param: string $component_action

bp_core_check_notification_access( $user_id, $notification_id )   X-Ref
Check if a user has access to a specific notification.

Used before deleting a notification for a user.

since: 1.0.0
return: boolean True on success, false on failure.
param: int $user_id
param: int $notification_id



Generated: Thu Sep 19 01:01:39 2019 Cross-referenced by PHPXref 0.7.1