Contents

Code Reference Classes BP_REST_XProfile_Fields_Endpoint BP_REST_XProfile_Fields_Endpoint::get_items()

BP_REST_XProfile_Fields_Endpoint::get_items( WP_REST_Request $request )

Retrieve XProfile fields.

Description

Parameters

$request

(Required) Full data about the request.

Return

(WP_REST_Response)

Source

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

138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
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
222
223
224
225
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_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'],
        'fetch_fields'           => true,
    );
 
    if ( empty( $request['member_type'] ) ) {
        $args['member_type'] = 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_fields_get_items_query_args', $args, $request );
 
    // Actually, query it.
    $field_groups = bp_xprofile_get_groups( $args );
 
    $retval = array();
    foreach ( $field_groups as $group ) {
        foreach ( $group->fields as $field ) {
 
            /**
             * Added support for display name format support from platform.
             */
            // Get the current display settings from BuddyBoss > Settings > Profiles > Display Name Format.
            $current_value = bp_get_option( 'bp-display-name-format' );
 
            // If First Name selected then do not add last name field.
            if ( 'first_name' === $current_value && function_exists( 'bp_xprofile_lastname_field_id' ) && bp_xprofile_lastname_field_id() === $field->id ) {
                if ( function_exists( 'bp_hide_last_name' ) && false === bp_hide_last_name() ) {
                    continue;
                }
                // If Nick Name selected then do not add first & last name field.
            } elseif ( 'nickname' === $current_value && function_exists( 'bp_xprofile_lastname_field_id' ) && bp_xprofile_lastname_field_id() === $field->id ) {
                if ( function_exists( 'bp_hide_nickname_last_name' ) && false === bp_hide_nickname_last_name() ) {
                    continue;
                }
            } elseif ( 'nickname' === $current_value && function_exists( 'bp_xprofile_firstname_field_id' ) && bp_xprofile_firstname_field_id() === $field->id ) {
                if ( function_exists( 'bp_hide_nickname_first_name' ) && false === bp_hide_nickname_first_name() ) {
                    continue;
                }
            }
 
            if ( function_exists( 'bp_member_type_enable_disable' ) && false === bp_member_type_enable_disable() ) {
                if ( function_exists( 'bp_get_xprofile_member_type_field_id' ) && bp_get_xprofile_member_type_field_id() === $field->id ) {
                    continue;
                }
            }
            /**
             * --Added support for display name format support from platform.
             */
 
            $retval[] = $this->prepare_response_for_collection(
                $this->prepare_item_for_response( $field, $request )
            );
        }
    }
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires after a list of field 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_fields_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-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::prepare_item_for_response()

Prepares single XProfile field data to return as an object.
bp-xprofile/classes/class-bp-rest-xprofile-update-endpoint.php: bp_rest_xprofile_fields_get_items_query_args

Filter the query arguments for the request.
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: bp_rest_xprofile_fields_get_items

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

Whether or not profile field is hidden.
bp-members/bp-members-functions.php: bp_get_xprofile_member_type_field_id()

Return the member type xprofile field id.
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_get_groups()

Fetch a set of field groups, populated with fields and field data.
bp-core/bp-core-options.php: bp_member_type_enable_disable()

Is member type disabled?
Show 2 more uses Hide more uses

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.