BP_REST_XProfile_Field_Groups_Endpoint::delete_item( WP_REST_Request $request )

Delete a XProfile field group.

Description

Parameters

$request: (Required) Full data about the request.

Return

(WP_REST_Response|WP_Error)

Source

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

public function delete_item( $request ) {
    // Setting context.
    $request->set_param( 'context', 'edit' );
 
    // Get the field group before it's deleted.
    $field_group = $this->get_xprofile_field_group_object( $request );
 
    if ( empty( $field_group->id ) ) {
        return new WP_Error(
            'bp_rest_invalid_id',
            __( 'Invalid field group ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    if ( ! xprofile_delete_field_group( $field_group->id ) ) {
        return new WP_Error(
            'bp_rest_xprofile_field_group_cannot_delete',
            __( 'Could not delete XProfile field group.', 'buddyboss' ),
            array(
                'status' => 500,
            )
        );
    }
 
    // Build the response.
    $previous = $this->prepare_item_for_response( $field_group, $request );
    $response = new WP_REST_Response();
    $response->set_data(
        array(
            'deleted'  => true,
            'previous' => $previous->get_data(),
        )
    );
 
    /**
     * Fires after a field group is deleted via the REST API.
     *
     * @param BP_XProfile_Group $field_group Deleted field 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_xprofile_field_groups_delete_item', $field_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-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php: BP_REST_XProfile_Field_Groups_Endpoint::get_xprofile_field_group_object()	Get XProfile field group object.
bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php: BP_REST_XProfile_Field_Groups_Endpoint::prepare_item_for_response()	Prepares single XProfile field group data for return as an object.
bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php: bp_rest_xprofile_field_groups_delete_item	Fires after a field group is deleted via the REST API.
bp-xprofile/bp-xprofile-functions.php: xprofile_delete_field_group()	Delete a specific profile field group.

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