Contents

Code Reference Classes BP_REST_XProfile_Field_Groups_Endpoint BP_REST_XProfile_Field_Groups_Endpoint::get_items()

BP_REST_XProfile_Field_Groups_Endpoint::get_items( WP_REST_Request $request )

Retrieve XProfile groups.

Description

Parameters

$request

(Required) Full data about the request.

Return

(WP_REST_Response)

Source

File: bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php

160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
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;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Uses

Uses
Uses Description
bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php: BP_REST_XProfile_Field_Groups_Endpoint::prepare_item_for_response()

Prepares single XProfile field group data for return as an object.
bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php: bp_rest_xprofile_field_groups_get_items_query_args

Filter the query arguments for the request.
bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php: bp_rest_xprofile_field_groups_get_items

Fires after a list of field groups are fetched via the REST API.
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_get_groups()

Fetch a set of field groups, populated with fields and field data.

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.