BP_REST_XProfile_Field_Groups_Endpoint::prepare_item_for_response( BP_XProfile_Group $group, WP_REST_Request $request )
Prepares single XProfile field group data for return as an object.
Description Description
Parameters Parameters
- $group
-
(Required) XProfile field group data.
- $request
-
(Required) Full data about the request.
Return Return
(WP_REST_Response)
Source Source
File: bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php
public function prepare_item_for_response( $group, $request ) {
$data = array(
'id' => (int) $group->id,
'name' => $group->name,
'description' => array(
'raw' => $group->description,
'rendered' => apply_filters( 'bp_get_the_profile_field_description', $group->description ),
),
'group_order' => (int) $group->group_order,
'can_delete' => (bool) $group->can_delete,
);
// If the fields have been requested, we populate them.
if ( $request['fetch_fields'] ) {
$data['fields'] = array();
foreach ( $group->fields as $field ) {
$data['fields'][] = $this->fields_endpoint->assemble_response_data( $field, $request );
}
}
$context = ! empty( $request['context'] ) ? $request['context'] : 'view';
$data = $this->add_additional_fields_to_object( $data, $request );
$data = $this->filter_response_by_context( $data, $context );
$response = rest_ensure_response( $data );
$response->add_links( $this->prepare_links( $group ) );
/**
* Filter the XProfile field group returned from the API.
*
* @since 5.0.0
*
* @param WP_REST_Response $response The response data.
* @param WP_REST_Request $request Request used to generate the response.
* @param BP_XProfile_Group $group XProfile field group.
*/
return apply_filters( 'bp_rest_xprofile_field_groups_prepare_value', $response, $request, $group );
}
Changelog Changelog
| Version | Description |
|---|---|
| 5.0.0 | Introduced. |