BP_REST_XProfile_Field_Groups_Endpoint::get_xprofile_field_group_object( WP_REST_Request $request )

Get XProfile field group object.

Description

Parameters

$request: (Required) Full details about the request.

Return

(BP_XProfile_Group|string) XProfile field group object.

Source

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

public function get_xprofile_field_group_object( $request ) {
    $profile_group_id = is_numeric( $request ) ? $request : (int) $request['id'];
 
    $args = array(
        'profile_group_id'       => $profile_group_id,
        'user_id'                => $request['user_id'],
        'member_type'            => $request['member_type'],
        '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_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;
    }
 
    $field_group = current( bp_xprofile_get_groups( $args ) );
 
    if ( empty( $field_group->id ) ) {
        return '';
    }
 
    return $field_group;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version	Description
0.1.0	Introduced.

Uses

Uses
Uses	Description
bp-xprofile/bp-xprofile-functions.php: bp_xprofile_get_groups()	Fetch a set of field groups, populated with fields and field data.

Used By
Used By	Description
bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php: BP_REST_XProfile_Field_Groups_Endpoint::get_item()	Retrieve single XProfile field group.
bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php: BP_REST_XProfile_Field_Groups_Endpoint::create_item()	Create a XProfile field group.
bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php: BP_REST_XProfile_Field_Groups_Endpoint::update_item()	Update a XProfile field group.
bp-xprofile/classes/class-bp-rest-xprofile-field-groups-endpoint.php: BP_REST_XProfile_Field_Groups_Endpoint::delete_item()	Delete a XProfile field group.

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.

Contents