bp_activity_delete_comment( int $activity_id, int $comment_id )

Delete an activity comment.

Description

Parameters

$activity_id: (Required) The ID of the "root" activity, ie the comment's oldest ancestor.
$comment_id: (Required) The ID of the comment to be deleted.

Return

(bool) True on success, false on failure.

Source

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

function bp_activity_delete_comment( $activity_id, $comment_id ) {
    $deleted = false;
 
    /**
     * Filters whether BuddyPress should delete an activity comment or not.
     *
     * You may want to hook into this filter if you want to override this function and
     * handle the deletion of child comments differently. Make sure you return false.
     *
     * @since BuddyPress 1.2.0
     * @since BuddyPress 2.5.0 Add the deleted parameter (passed by reference)
     *
     * @param bool $value       Whether BuddyPress should continue or not.
     * @param int  $activity_id ID of the root activity item being deleted.
     * @param int  $comment_id  ID of the comment being deleted.
     * @param bool $deleted     Whether the activity comment has been deleted or not.
     */
    if ( ! apply_filters_ref_array( 'bp_activity_delete_comment_pre', array( true, $activity_id, $comment_id, &$deleted ) ) ) {
        return $deleted;
    }
 
    // Check if comment still exists.
    $comment = new BP_Activity_Activity( $comment_id );
    if ( empty( $comment->id ) ) {
        return false;
    }
 
    // Delete any children of this comment.
    bp_activity_delete_children( $activity_id, $comment_id );
 
    // Delete the actual comment.
    if ( ! bp_activity_delete( array( 'id' => $comment_id, 'type' => 'activity_comment' ) ) ) {
        return false;
    } else {
        $deleted = true;
    }
 
    // Purge comment cache for the root activity update.
    wp_cache_delete( $activity_id, 'bp_activity_comments' );
 
    // Recalculate the comment tree.
    BP_Activity_Activity::rebuild_activity_comment_tree( $activity_id );
 
    /**
     * Fires at the end of the deletion of an activity comment, before returning success.
     *
     * @since BuddyPress 1.2.0
     *
     * @param int $activity_id ID of the activity that has had a comment deleted from.
     * @param int $comment_id  ID of the comment that was deleted.
     */
    do_action( 'bp_activity_delete_comment', $activity_id, $comment_id );
 
    return $deleted;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
BuddyPress 1.2.0	Introduced.

Uses

Uses
Uses	Description
bp-activity/bp-activity-functions.php: bp_activity_delete_children()	Delete an activity comment’s children.
bp-activity/bp-activity-functions.php: bp_activity_delete_comment_pre	Filters whether BuddyPress should delete an activity comment or not.
bp-activity/bp-activity-functions.php: bp_activity_delete_comment	Fires at the end of the deletion of an activity comment, before returning success.
bp-activity/bp-activity-functions.php: bp_activity_delete()	Delete activity item(s).
bp-activity/classes/class-bp-activity-activity.php: BP_Activity_Activity::rebuild_activity_comment_tree()	Rebuild nested comment tree under an activity or activity comment.
bp-activity/classes/class-bp-activity-activity.php: BP_Activity_Activity::__construct()	Constructor method.

Show 1 more use Hide more uses

Used By
Used By	Description
bp-document/classes/class-bp-document.php: BP_Document::delete()	Delete document items from the database.
bp-activity/classes/class-bp-rest-activity-endpoint.php: BP_REST_Activity_Endpoint::delete_item()	Delete activity.
bp-media/bp-media-functions.php: bp_media_import_reset_media_albums()	Reset all media albums related data in tables
bp-media/bp-media-functions.php: bp_media_import_reset_media()	Reset all media related data in tables
bp-media/classes/class-bp-media.php: BP_Media::delete()	Delete media items from the database.
bp-templates/bp-nouveau/includes/activity/ajax.php: bp_nouveau_ajax_delete_activity()	Deletes an Activity item/Activity comment item received via a POST request.
bp-activity/bp-activity-admin.php: bp_activity_admin_load()	Set up the Activity admin page.
bp-activity/classes/class-bp-akismet.php: BP_Akismet::check_activity()	Check if the activity item is spam or ham.

Show 3 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.

Contents