Contents

Code Reference Functions bp_notifications_add_notification()

bp_notifications_add_notification( array $args = array() )

Add a notification for a specific user, from a specific component.

Description

Parameters

$args

(Optional) Array of arguments describing the notification. All are optional.

  • 'user_id'
    (int) ID of the user to associate the notification with.
  • 'item_id'
    (int) ID of the item to associate the notification with.
  • 'secondary_item_id'
    (int) ID of the secondary item to associate the notification with.
  • 'component_name'
    (string) Name of the component to associate the notification with.
  • 'component_action'
    (string) Name of the action to associate the notification with.
  • 'date_notified'
    (string) Timestamp for the notification.

Default value: array()

Return

(int|bool) ID of the newly created notification on success, false on failure.

Source

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

34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
function bp_notifications_add_notification( $args = array() ) {
 
    $r = bp_parse_args( $args, array(
        'user_id'           => 0,
        'item_id'           => 0,
        'secondary_item_id' => 0,
        'component_name'    => '',
        'component_action'  => '',
        'date_notified'     => bp_core_current_time(),
        'is_new'            => 1,
        'allow_duplicate'   => false,
    ), 'notifications_add_notification' );
 
    // Check for existing duplicate notifications.
    if ( ! $r['allow_duplicate'] ) {
        // Date_notified, allow_duplicate don't count toward
        // duplicate status.
        $existing = BP_Notifications_Notification::get( array(
            'user_id'           => $r['user_id'],
            'item_id'           => $r['item_id'],
            'secondary_item_id' => $r['secondary_item_id'],
            'component_name'    => $r['component_name'],
            'component_action'  => $r['component_action'],
            'is_new'            => $r['is_new'],
        ) );
 
        if ( ! empty( $existing ) ) {
            return false;
        }
    }
 
    // Setup the new notification.
    $notification                    = new BP_Notifications_Notification;
    $notification->user_id           = $r['user_id'];
    $notification->item_id           = $r['item_id'];
    $notification->secondary_item_id = $r['secondary_item_id'];
    $notification->component_name    = $r['component_name'];
    $notification->component_action  = $r['component_action'];
    $notification->date_notified     = $r['date_notified'];
    $notification->is_new            = $r['is_new'];
 
    // Save the new notification.
    return $notification->save();
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.9.0 Introduced.

Uses

Uses
Uses Description
bp-notifications/classes/class-bp-notifications-notification.php: BP_Notifications_Notification::get()

Get notifications, based on provided filter parameters.
bp-notifications/classes/class-bp-notifications-notification.php: BP_Notifications_Notification::__construct()

Constructor method.
bp-core/bp-core-functions.php: bp_core_current_time()

Get the current GMT time to save into the DB.
bp-core/bp-core-functions.php: bp_parse_args()

Merge user defined arguments into defaults array.
Used By
Used By Description
bp-notifications/classes/class-bp-rest-notifications-endpoint.php: BP_REST_Notifications_Endpoint::create_item()

Create a notification.
bp-forums/notifications.php: bbp_buddypress_add_topic_notification()

Hooked into the new topic function, this notification action is responsible for notifying topic.
bp-forums/notifications.php: bbp_buddypress_add_notification()

Hooked into the new reply function, this notification action is responsible for notifying topic and hierarchical reply authors of topic replies.
bp-messages/bp-messages-notifications.php: bp_messages_message_sent_add_notification()

Send notifications to message recipients.
bp-groups/bp-groups-notifications.php: groups_notification_new_membership_request()

Notify group admin about new membership request.
bp-groups/bp-groups-notifications.php: groups_notification_membership_request_completed()

Notify member about their group membership request.
bp-groups/bp-groups-notifications.php: groups_notification_promoted_member()

Notify group member they have been promoted.
bp-groups/bp-groups-notifications.php: groups_notification_group_invites()

Notify a member they have been invited to a group.
bp-friends/bp-friends-notifications.php: bp_friends_friendship_requested_notification()

Notify one use that another user has requested their virtual friendship.
bp-friends/bp-friends-notifications.php: bp_friends_add_friendship_accepted_notification()

Notify a member when another member accepts their virtual friendship request.
bp-core/deprecated/buddypress/1.9.php: bp_core_add_notification()

Add a notification for a specific user, from a specific component.
bp-activity/bp-activity-notifications.php: bp_activity_update_reply_add_notification()

Notify a member one of their activity received a reply.
bp-activity/bp-activity-notifications.php: bp_activity_comment_reply_add_notification()

Notify a member one of their activity comment received a reply.
bp-activity/bp-activity-notifications.php: bp_activity_add_notification_for_synced_blog_comment()

Add a notification for post comments to the post author or post commenter.
bp-activity/bp-activity-notifications.php: bp_activity_at_mention_add_notification()

Notify a member when their nicename is mentioned in an activity feed item.
Show 10 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.