bp_activity_at_name_send_emails( BP_Activity_Activity $activity )

Sends emails and BP notifications for users @-mentioned in an activity item.

Description

Parameters

$activity: (Required) The BP_Activity_Activity object.

Source

File: bp-activity/bp-activity-filters.php

function bp_activity_at_name_send_emails( $activity ) {
    // Are mentions disabled?
    if ( ! bp_activity_do_mentions() ) {
        return;
    }
 
    // If our temporary variable doesn't exist, stop now.
    if ( empty( buddypress()->activity->mentioned_users ) )
        return;
 
    // Grab our temporary variable from bp_activity_at_name_filter_updates().
    $usernames = buddypress()->activity->mentioned_users;
 
    // Get rid of temporary variable.
    unset( buddypress()->activity->mentioned_users );
 
    // Send @mentions and setup BP notifications.
    foreach( (array) $usernames as $user_id => $username ) {
 
        /**
         * Filters BuddyPress' ability to send email notifications for @mentions.
         *
         * @since BuddyPress 1.6.0
         * @since BuddyPress 2.5.0 Introduced `$user_id` and `$activity` parameters.
         *
         * @param bool                 $value     Whether or not BuddyPress should send a notification to the mentioned users.
         * @param array                $usernames Array of users potentially notified.
         * @param int                  $user_id   ID of the current user being notified.
         * @param BP_Activity_Activity $activity  Activity object.
         */
        if ( apply_filters( 'bp_activity_at_name_do_notifications', true, $usernames, $user_id, $activity ) ) {
            bp_activity_at_message_notification( $activity->id, $user_id );
        }
 
        // Updates mention count for the user.
        bp_activity_update_mention_count_for_user( $user_id, $activity->id );
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.7.0	Introduced.

Uses

Uses
Uses	Description
bp-loader.php: buddypress()	The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-activity/bp-activity-functions.php: bp_activity_at_message_notification()	Send email and BP notifications when a user is mentioned in an update.
bp-activity/bp-activity-functions.php: bp_activity_update_mention_count_for_user()	Update the mention count for a given user.
bp-activity/bp-activity-functions.php: bp_activity_do_mentions()	Are mentions enabled or disabled?
bp-activity/bp-activity-filters.php: bp_activity_at_name_do_notifications	Filters BuddyPress’ ability to send email notifications for @mentions.

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.

Contents