Contents

Code Reference Classes BP_REST_Activity_Endpoint BP_REST_Activity_Endpoint::delete_item()

BP_REST_Activity_Endpoint::delete_item( WP_REST_Request $request )

Delete activity.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

File: bp-activity/classes/class-bp-rest-activity-endpoint.php

841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
public function delete_item( $request ) {
    // Setting context.
    $request->set_param( 'context', 'edit' );
 
    // Get the activity before it's deleted.
    $activity = $this->get_activity_object( $request );
    $previous = $this->prepare_item_for_response( $activity, $request );
 
    if ( 'activity_comment' === $activity->type ) {
        $retval = bp_activity_delete_comment( $activity->item_id, $activity->id );
    } else {
        $retval = bp_activity_delete(
            array(
                'id' => $activity->id,
            )
        );
    }
 
    if ( ! $retval ) {
        return new WP_Error(
            'bp_rest_activity_cannot_delete',
            __( 'Could not delete the activity.', 'buddyboss' ),
            array(
                'status' => 500,
            )
        );
    }
 
    // Build the response.
    $response = new WP_REST_Response();
    $response->set_data(
        array(
            'deleted'  => true,
            'previous' => $previous->get_data(),
        )
    );
 
    /**
     * Fires after an activity is deleted via the REST API.
     *
     * @param BP_Activity_Activity $activity The deleted activity.
     * @param WP_REST_Response     $response The response data.
     * @param WP_REST_Request      $request  The request sent to the API.
     *
     * @since 0.1.0
     */
    do_action( 'bp_rest_activity_delete_item', $activity, $response, $request );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Uses

Uses
Uses Description
bp-activity/classes/class-bp-rest-activity-endpoint.php: BP_REST_Activity_Endpoint::get_activity_object()

Get activity object.
bp-activity/classes/class-bp-rest-activity-endpoint.php: BP_REST_Activity_Endpoint::prepare_item_for_response()

Prepares activity data for return as an object.
bp-activity/classes/class-bp-rest-activity-endpoint.php: bp_rest_activity_delete_item

Fires after an activity is deleted via the REST API.
bp-activity/bp-activity-functions.php: bp_activity_delete_comment()

Delete an activity comment.
bp-activity/bp-activity-functions.php: bp_activity_delete()

Delete activity item(s).

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.