Contents

Code Reference Classes BP_REST_Groups_Endpoint BP_REST_Groups_Endpoint::delete_item()

BP_REST_Groups_Endpoint::delete_item( WP_REST_Request $request )

Delete a group.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

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

591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
public function delete_item( $request ) {
    // Setting context.
    $request->set_param( 'context', 'edit' );
 
    // Get the group before it's deleted.
    $group    = $this->get_group_object( $request );
    $previous = $this->prepare_item_for_response( $group, $request );
 
    // Delete group forum.
    if ( isset( $request['delete_group_forum'] ) && true === $request['delete_group_forum'] ) {
        $forum_ids = bbp_get_group_forum_ids( $group->id );
        foreach ( $forum_ids as $forum_id ) {
            wp_delete_post( $forum_id, true );
        }
    }
 
    if ( ! groups_delete_group( $group->id ) ) {
        return new WP_Error(
            'bp_rest_group_cannot_delete',
            __( 'Could not delete the group.', 'buddyboss' ),
            array(
                'status' => 500,
            )
        );
    }
 
    // Build the response.
    $response = new WP_REST_Response();
    $response->set_data(
        array(
            'deleted'  => true,
            'previous' => $previous->get_data(),
        )
    );
 
    /**
     * Fires after a group is deleted via the REST API.
     *
     * @param object           $group    The deleted group.
     * @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_groups_delete_item', $group, $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-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::get_group_object()

Get group object.
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::prepare_item_for_response()

Prepares group data for return as an object.
bp-groups/classes/class-bp-rest-groups-endpoint.php: bp_rest_groups_delete_item

Fires after a group is deleted via the REST API.
bp-forums/functions.php: bbp_get_group_forum_ids()

Get forum ID’s for a group
bp-groups/bp-groups-functions.php: groups_delete_group()

Delete a group and all of its associated metadata.

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.