Contents

Code Reference Classes BP_REST_XProfile_Fields_Endpoint BP_REST_XProfile_Fields_Endpoint::delete_item()

BP_REST_XProfile_Fields_Endpoint::delete_item( WP_REST_Request $request )

Delete a XProfile field.

Description

Parameters

$request

(Required) Full data about the request.

Return

(WP_REST_Response|WP_Error)

Source

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

713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
public function delete_item( $request ) {
    // Setting context.
    $request->set_param( 'context', 'edit' );
 
    // Get the field before it's deleted.
    $field    = new BP_XProfile_Field( (int) $request->get_param( 'id' ) );
    $previous = $this->prepare_item_for_response( $field, $request );
 
    if ( ! $field->delete( $request['delete_data'] ) ) {
        return new WP_Error(
            'bp_rest_xprofile_field_cannot_delete',
            __( 'Could not delete XProfile field.', '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 XProfile field is deleted via the REST API.
     *
     * @param BP_XProfile_Field $field Deleted field object.
     * @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_fields_delete_item', $field, $response, $request );
 
    return $response;
}

Expand full source code Collapse full source code

Changelog

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.