bp_activity_at_message_notification( int $activity_id, int $receiver_user_id )

Send email and BP notifications when a user is mentioned in an update.

Description

Parameters

$activity_id: (Required) The ID of the activity update.
$receiver_user_id: (Required) The ID of the user who is receiving the update.

Source

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

function bp_activity_at_message_notification( $activity_id, $receiver_user_id ) {
    $notifications = BP_Core_Notification::get_all_for_user( $receiver_user_id, 'all' );
 
    // Don't leave multiple notifications for the same activity item.
    foreach( $notifications as $notification ) {
        if ( $activity_id == $notification->item_id ) {
            return;
        }
    }
 
    $activity     = new BP_Activity_Activity( $activity_id );
    $email_type   = 'activity-at-message';
    $group_name   = '';
    $message_link = bp_activity_get_permalink( $activity_id );
    $poster_name  = bp_core_get_user_displayname( $activity->user_id );
 
    remove_filter( 'bp_get_activity_content_body', 'convert_smilies' );
    remove_filter( 'bp_get_activity_content_body', 'wpautop' );
    remove_filter( 'bp_get_activity_content_body', 'bp_activity_truncate_entry', 5 );
 
    /** This filter is documented in bp-activity/bp-activity-template.php */
    $content = apply_filters_ref_array( 'bp_get_activity_content_body', array( $activity->content, &$activity ) );
 
    add_filter( 'bp_get_activity_content_body', 'convert_smilies' );
    add_filter( 'bp_get_activity_content_body', 'wpautop' );
    add_filter( 'bp_get_activity_content_body', 'bp_activity_truncate_entry', 5 );
 
    // Now email the user with the contents of the message (if they have enabled email notifications).
    if ( 'no' != bp_get_user_meta( $receiver_user_id, 'notification_activity_new_mention', true ) ) {
        if ( bp_is_active( 'groups' ) && bp_is_group() ) {
            $email_type = 'groups-at-message';
            $group_name = bp_get_current_group_name();
        }
 
        $unsubscribe_args = array(
            'user_id'           => $receiver_user_id,
            'notification_type' => $email_type,
        );
 
        $args = array(
            'tokens' => array(
                'activity'         => $activity,
                'usermessage'      => wp_strip_all_tags( $content ),
                'group.name'       => $group_name,
                'mentioned.url'    => $message_link,
                'poster.name'      => $poster_name,
                'receiver-user.id' => $receiver_user_id,
                'unsubscribe'      => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
            ),
        );
 
        bp_send_email( $email_type, $receiver_user_id, $args );
    }
 
    /**
     * Fires after the sending of an @mention email notification.
     *
     * @since BuddyPress 1.5.0
     * @since BuddyPress 2.5.0 $subject, $message, $content arguments unset and deprecated.
     *
     * @param BP_Activity_Activity $activity         Activity Item object.
     * @param string               $deprecated       Removed in 2.5; now an empty string.
     * @param string               $deprecated       Removed in 2.5; now an empty string.
     * @param string               $deprecated       Removed in 2.5; now an empty string.
     * @param int                  $receiver_user_id The ID of the user who is receiving the update.
     */
    do_action( 'bp_activity_sent_mention_email', $activity, '', '', '', $receiver_user_id );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.2.0	Introduced.

Uses

Uses
Uses	Description
bp-groups/bp-groups-template.php: bp_get_current_group_name()	Returns the name of the current group.
bp-members/bp-members-functions.php: bp_core_get_user_displayname()	Fetch the display name for a user.
bp-core/bp-core-template.php: bp_is_group()	Does the current page belong to a single group?
bp-core/bp-core-template.php: bp_is_active()	Check whether a given component (or feature of a component) is active.
bp-core/classes/class-bp-core-notification.php: BP_Core_Notification::get_all_for_user()	Fetches all the notifications in the database for a specific user.
bp-core/bp-core-functions.php: bp_email_get_unsubscribe_link()	Creates unsubscribe link for notification emails.
bp-core/bp-core-functions.php: bp_send_email()	Send email, similar to WordPress’ wp_mail().
bp-core/bp-core-functions.php: bp_get_user_meta()	Get a piece of usermeta.
bp-activity/bp-activity-functions.php: bp_activity_sent_mention_email	Fires after the sending of an @mention email notification.
bp-activity/bp-activity-functions.php: bp_activity_get_permalink()	Get the permalink for a single activity item.
bp-activity/classes/class-bp-activity-activity.php: BP_Activity_Activity::__construct()	Constructor method.
bp-activity/bp-activity-template.php: bp_get_activity_content_body	Filters the activity content body.

Show 7 more uses Hide more uses

Used By
Used By	Description
bp-activity/bp-activity-filters.php: bp_activity_at_name_send_emails()	Sends emails and BP notifications for users @-mentioned in an activity item.

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