BP_REST_XProfile_Fields_Endpoint::create_item( WP_REST_Request $request )
Create 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 create_item( $request ) { // Setting context. $request->set_param( 'context', 'edit' ); $args = array( 'field_group_id' => $request['group_id'], 'parent_id' => $request['parent_id'], 'type' => $request['type'], 'name' => $request['name'], 'description' => $request['description'], 'is_required' => $request['required'], 'can_delete' => $request['can_delete'], 'order_by' => $request['order_by'], 'is_default_option' => $request['is_default_option'], 'option_order' => $request['option_order'], '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_create_item_query_args', $args, $request ); $field_id = xprofile_insert_field( $args ); if ( ! $field_id ) { return new WP_Error( 'bp_rest_user_cannot_create_xprofile_field', __( 'Cannot create new 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 ); // Create 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 created via the REST API. * * @param BP_XProfile_Field $field Created 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_create_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.