BP_REST_XProfile_Field_Groups_Endpoint::get_items( WP_REST_Request $request )
Retrieve XProfile groups.
Description
Parameters
- $request
-
(WP_REST_Request) (Required) Full data about the request.
Return
(WP_REST_Response)
Source
File: bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php
public function get_items( $request ) { $args = array( 'profile_group_id' => $request['profile_group_id'], 'user_id' => $request['user_id'], 'member_type' => $request['member_type'], 'hide_empty_groups' => $request['hide_empty_groups'], 'hide_empty_fields' => $request['hide_empty_fields'], 'fetch_fields' => $request['fetch_fields'], 'fetch_field_data' => $request['fetch_field_data'], 'fetch_visibility_level' => $request['fetch_visibility_level'], 'exclude_groups' => $request['exclude_groups'], 'exclude_fields' => $request['exclude_fields'], 'update_meta_cache' => $request['update_meta_cache'], ); if ( empty( $request['member_type'] ) ) { $args['member_type'] = null; } if ( empty( $request['exclude_fields'] ) ) { $args['exclude_fields'] = false; } if ( empty( $request['exclude_groups'] ) ) { $args['exclude_groups'] = false; } /** * 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_field_groups_get_items_query_args', $args, $request ); // Actually, query it. $field_groups = bp_xprofile_get_groups( $args ); $retval = array(); foreach ( (array) $field_groups as $item ) { $retval[] = $this->prepare_response_for_collection( $this->prepare_item_for_response( $item, $request ) ); } $response = rest_ensure_response( $retval ); /** * Fires after a list of field groups are fetched via the REST API. * * @param array $field_groups Fetched field groups. * @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_field_groups_get_items', $field_groups, $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.