BP_REST_Attachments_Group_Avatar_Endpoint::delete_item( WP_REST_Request $request )
Delete an existing group avatar.
Description
Parameters
- $request
-
(Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-groups/classes/class-bp-rest-attachments-group-avatar-endpoint.php
public function delete_item( $request ) { $request->set_param( 'context', 'edit' ); $group_id = (int) $this->group->id; if ( ! bp_get_group_has_avatar( $group_id ) ) { return new WP_Error( 'bp_rest_attachments_group_avatar_no_uploaded_avatar', __( 'Sorry, there are no uploaded avatars for this group on this site.', 'buddyboss' ), array( 'status' => 404, ) ); } $args = array(); foreach ( array( 'full', 'thumb' ) as $type ) { $args[ $type ] = bp_core_fetch_avatar( array( 'object' => $this->object, 'type' => $type, 'item_id' => $group_id, 'html' => false, ) ); } // Get the avatar object before deleting it. $avatar = $this->get_avatar_object( $args ); $deleted = bp_core_delete_existing_avatar( array( 'object' => $this->object, 'item_id' => $group_id, ) ); if ( ! $deleted ) { return new WP_Error( 'bp_rest_attachments_group_avatar_delete_failed', __( 'Sorry, there was a problem deleting this group avatar.', 'buddyboss' ), array( 'status' => 500, ) ); } // Build the response. $response = new WP_REST_Response(); $response->set_data( array( 'deleted' => true, 'previous' => $avatar, ) ); /** * Fires after a group avatar is deleted via the REST API. * * @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_attachments_group_avatar_delete_item', $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.