BP_REST_XProfile_Fields_Endpoint::get_xprofile_field_object( WP_REST_Request $request )

Get XProfile field object.

Description

Parameters

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

Return

(BP_XProfile_Field|string) XProfile field object|string.

Source

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

public function get_xprofile_field_object( $request ) {
    if ( is_numeric( $request ) ) {
        $field_id = $request;
        $user_id  = null;
    } else {
        $field_id = $request->get_param( 'id' );
        $user_id  = $request->get_param( 'user_id' );
    }
 
    $field = xprofile_get_field( $field_id, $user_id );
 
    if ( empty( $field ) ) {
        return '';
    }
 
    return $field;
}

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: xprofile_get_field()	Get a profile field object.

Used By
Used By	Description
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::update_item()	Update a XProfile field.
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::delete_item_permissions_check()	Check if a given request has access to delete a XProfile field.
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::get_item()	Retrieve single XProfile field.
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::get_item_permissions_check()	Check if a given request has access to get information about a specific XProfile field.
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::create_item()	Create a XProfile field.

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