BP_REST_XProfile_Fields_Endpoint::update_item( WP_REST_Request $request )
Update 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
public function update_item( $request ) { // Setting context. $request->set_param( 'context', 'edit' ); $field = $this->get_xprofile_field_object( $request ); if ( empty( $field->id ) ) { return new WP_Error( 'bp_rest_invalid_id', __( 'Invalid profile field ID.', 'buddyboss' ), array( 'status' => 404, ) ); } $args = array( 'field_id' => $field->id, 'field_group_id' => is_null( $request['group_id'] ) ? $field->group_id : $request['group_id'], 'parent_id' => is_null( $request['parent_id'] ) ? $field->parent_id : $request['parent_id'], 'type' => is_null( $request['type'] ) ? $field->type : $request['type'], 'name' => is_null( $request['name'] ) ? $field->name : $request['name'], 'description' => is_null( $request['description'] ) ? $field->description : $request['description'], 'is_required' => is_null( $request['required'] ) ? $field->is_required : $request['required'], 'can_delete' => $request['can_delete'], // Set to true by default. 'order_by' => is_null( $request['order_by'] ) ? $field->order_by : $request['order_by'], 'is_default_option' => is_null( $request['is_default_option'] ) ? $field->is_default_option : $request['is_default_option'], 'option_order' => is_null( $request['option_order'] ) ? $field->option_order : $request['option_order'], 'field_order' => is_null( $request['field_order'] ) ? $field->field_order : $request['field_order'], ); /** * Filter the query arguments for the request. * * @param array $args Key value array of query var to query value. * @param WP_REST_Request $request The request sent to the API. * * @since 0.1.0 */ $args = apply_filters( 'bp_rest_xprofile_fields_update_item_query_args', $args, $request ); // Specific check to make sure the Full Name xprofile field will remain undeletable. if ( bp_xprofile_fullname_field_id() === $field->id ) { $args['can_delete'] = false; } $field_id = xprofile_insert_field( $args ); if ( ! $field_id ) { return new WP_Error( 'bp_rest_user_cannot_update_xprofile_field', __( 'Cannot update XProfile field.', 'buddyboss' ), array( 'status' => 500, ) ); } // Define visibility and autolink field properties. $this->set_additional_field_properties( $field_id, $request ); $field = $this->get_xprofile_field_object( $field_id ); // Update Additional fields. $fields_update = $this->update_additional_fields_for_object( $field, $request ); if ( is_wp_error( $fields_update ) ) { return $fields_update; } $retval = $this->prepare_response_for_collection( $this->prepare_item_for_response( $field, $request ) ); $response = rest_ensure_response( $retval ); /** * Fires after a XProfile field is updated via the REST API. * * @param BP_XProfile_Field $field Updated 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_update_item', $field, $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.