BP_REST_XProfile_Field_Groups_Endpoint::update_item( WP_REST_Request $request )
Update a XProfile field group.
Description Description
Parameters Parameters
- $request
-
(Required) Full data about the request.
Return Return
(WP_REST_Response|WP_Error)
Source Source
File: bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php
public function update_item( $request ) { // Setting context. $request->set_param( 'context', 'edit' ); $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.', 'buddypress' ), array( 'status' => 404, ) ); } $args = array( 'field_group_id' => $field_group->id, 'name' => is_null( $request['name'] ) ? $field_group->name : $request['name'], 'description' => is_null( $request['description'] ) ? $field_group->description : $request['description'], 'can_delete' => is_null( $request['can_delete'] ) ? (bool) $field_group->can_delete : $request['can_delete'], ); $group_id = xprofile_insert_field_group( $args ); if ( ! $group_id ) { return new WP_Error( 'bp_rest_user_cannot_update_xprofile_field_group', __( 'Cannot update XProfile field group.', 'buddypress' ), array( 'status' => 500, ) ); } // Update the position if the group_order exists. if ( is_numeric( $request['group_order'] ) ) { xprofile_update_field_group_position( $group_id, $request['group_order'] ); } $field_group = $this->get_xprofile_field_group_object( $group_id ); // Update Additional fields. $fields_update = $this->update_additional_fields_for_object( $field_group, $request ); if ( is_wp_error( $fields_update ) ) { return $fields_update; } $retval = array( $this->prepare_response_for_collection( $this->prepare_item_for_response( $field_group, $request ) ), ); $response = rest_ensure_response( $retval ); /** * Fires after a XProfile field group is updated via the REST API. * * @since 5.0.0 * * @param BP_XProfile_Group $field_group Updated field group object. * @param WP_REST_Response $response The response data. * @param WP_REST_Request $request The request sent to the API. */ do_action( 'bp_rest_xprofile_field_groups_update_item', $field_group, $response, $request ); return $response; }
Changelog Changelog
Version | Description |
---|---|
5.0.0 | Introduced. |