| [ Index ] |
PHP Cross Reference of BuddyPress |
[Source view] [Print] [Project Stats]
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 |
| 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. 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 since: 1.0.0 |
| bp_core_delete_notification( $id ) X-Ref |
| Delete a specific notification by its ID. return: false|integer True on success, false on failure. param: int $id ID of notification. since: 1.0.0 |
| bp_core_get_notification( $id ) X-Ref |
| Get a specific notification by its ID. return: false|BP_Core_Notification param: int $id ID of notification. since: 1.0.0 |
| bp_core_get_notifications_for_user( $user_id, $format = 'string' ) X-Ref |
| Get notifications for a specific user. return: boolean Object or array on success, false on failure. param: int $user_id ID of user. param: string $format since: 1.0.0 |
| 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. return: false|int True on success, false on failure. param: int $user_id param: string $component_name param: string $component_action since: 1.0.0 |
| 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. return: false|int True on success, false on failure. param: int $user_id param: string $component_name param: string $component_action since: 1.0.0 |
| 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. return: boolean True on success, false on failure. param: int $user_id param: string $component_name param: false|string $component_action since: 1.0.0 |
| 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. return: false|int True on success, false on failure. param: int $user_id param: string $component_name param: string $component_action since: 1.0.0 |
| 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. return: boolean True on success, false on failure. param: int $user_id param: int $notification_id since: 1.0.0 |
| Generated: Thu Nov 21 01:00:57 2024 | Cross-referenced by PHPXref 0.7.1 |