bp_activity_new_comment_notification( int $comment_id, int $commenter_id, array $params = array() )

Send email and BP notifications when an activity item receives a comment.

Description

Parameters

$comment_id

(Required) The comment id.

$commenter_id

(Required) The ID of the user who posted the comment.

$params

(Optional) bp_activity_new_comment().

Default value: array()

Source

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

function bp_activity_new_comment_notification( $comment_id = 0, $commenter_id = 0, $params = array() ) {
    $original_activity = new BP_Activity_Activity( $params['activity_id'] );
    $poster_name       = bp_core_get_user_displayname( $commenter_id );
    $thread_link       = bp_activity_get_permalink( $params['activity_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( $params['content'], &$original_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 );
 
    if ( $original_activity->user_id != $commenter_id ) {
 
        // Send an email if the user hasn't opted-out.
        if ( 'no' != bp_get_user_meta( $original_activity->user_id, 'notification_activity_new_reply', true ) ) {
 
            $unsubscribe_args = array(
                'user_id'           => $original_activity->user_id,
                'notification_type' => 'activity-comment',
            );
 
            $args = array(
                'tokens' => array(
                    'comment.id'                => $comment_id,
                    'commenter.id'              => $commenter_id,
                    'usermessage'               => wp_strip_all_tags( $content ),
                    'original_activity.user_id' => $original_activity->user_id,
                    'poster.name'               => $poster_name,
                    'thread.url'                => esc_url( $thread_link ),
                    'unsubscribe'               => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
                ),
            );
 
            bp_send_email( 'activity-comment', $original_activity->user_id, $args );
        }
 
        /**
         * Fires at the point that notifications should be sent for activity comments.
         *
         * @since BuddyPress 2.6.0
         *
         * @param BP_Activity_Activity $original_activity The original activity.
         * @param int                  $comment_id        ID for the newly received comment.
         * @param int                  $commenter_id      ID of the user who made the comment.
         * @param array                $params            Arguments used with the original activity comment.
         */
        do_action( 'bp_activity_sent_reply_to_update_notification', $original_activity, $comment_id, $commenter_id, $params );
    }
 
 
    /*
     * If this is a reply to another comment, send an email notification to the
     * author of the immediate parent comment.
     */
    if ( empty( $params['parent_id'] ) || ( $params['activity_id'] == $params['parent_id'] ) ) {
        return;
    }
 
    $parent_comment = new BP_Activity_Activity( $params['parent_id'] );
 
    if ( $parent_comment->user_id != $commenter_id && $original_activity->user_id != $parent_comment->user_id ) {
 
        // Send an email if the user hasn't opted-out.
        if ( 'no' != bp_get_user_meta( $parent_comment->user_id, 'notification_activity_new_reply', true ) ) {
 
            $unsubscribe_args = array(
                'user_id'           => $parent_comment->user_id,
                'notification_type' => 'activity-comment-author',
            );
 
            $args = array(
                'tokens' => array(
                    'comment.id'             => $comment_id,
                    'commenter.id'           => $commenter_id,
                    'usermessage'            => wp_strip_all_tags( $content ),
                    'parent-comment-user.id' => $parent_comment->user_id,
                    'poster.name'            => $poster_name,
                    'thread.url'             => esc_url( $thread_link ),
                    'unsubscribe'            => esc_url( bp_email_get_unsubscribe_link( $unsubscribe_args ) ),
                ),
            );
 
            bp_send_email( 'activity-comment-author', $parent_comment->user_id, $args );
        }
 
        /**
         * Fires at the point that notifications should be sent for comments on activity replies.
         *
         * @since BuddyPress 2.6.0
         *
         * @param BP_Activity_Activity $parent_comment The parent activity.
         * @param int                  $comment_id     ID for the newly received comment.
         * @param int                  $commenter_id   ID of the user who made the comment.
         * @param array                $params         Arguments used with the original activity comment.
         */
        do_action( 'bp_activity_sent_reply_to_reply_notification', $parent_comment, $comment_id, $commenter_id, $params );
    }
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 2.5.0 Updated to use new email APIs.	BuddyPress 2.5.0 Updated to use new email APIs.
BuddyPress 1.2.0	Introduced.

Uses

Uses
Uses	Description
bp-members/bp-members-functions.php: bp_core_get_user_displayname()	Fetch the display name for a 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_reply_to_update_notification	Fires at the point that notifications should be sent for activity comments.
bp-activity/bp-activity-functions.php: bp_activity_sent_reply_to_reply_notification	Fires at the point that notifications should be sent for comments on activity replies.
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 4 more uses Hide more uses

Used By
Used By	Description
bp-activity/bp-activity-functions.php: bp_activity_new_comment_notification_helper()	Helper method to map action arguments to function parameters.

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