BP_REST_Groups_Endpoint::delete_item( WP_REST_Request $request )
Delete a group.
Description
Parameters
- $request
-
(WP_REST_Request) (Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-groups/classes/class-bp-rest-groups-endpoint.php
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; }
Changelog
Version | Description |
---|---|
0.1.0 | Introduced. |
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.