BP_REST_XProfile_Fields_Endpoint::get_item_permissions_check( WP_REST_Request $request )

Check if a given request has access to get information about a specific XProfile field.

Description

Parameters

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

Return

(bool)

Source

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

public function get_item_permissions_check( $request ) {
    $retval = true;
 
    if ( function_exists( 'bp_enable_private_network' ) && true !== bp_enable_private_network() && ! is_user_logged_in() ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, Restrict access to only logged-in members.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    $field = $this->get_xprofile_field_object( $request );
    if ( true === $retval && empty( $field->id ) ) {
        $retval = new WP_Error(
            'bp_rest_invalid_id',
            __( 'Invalid field ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    if ( true === $retval ) {
        $retval = $this->get_xprofile_field_display_permission( $retval, $field->id );
    }
 
    /**
     * Filter the XProfile fields `get_item` permissions check.
     *
     * @param bool $retval Returned value.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    return apply_filters( 'bp_rest_xprofile_fields_get_item_permissions_check', $retval, $request );
}

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::get_xprofile_field_object()	Get XProfile field object.
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: BP_REST_XProfile_Fields_Endpoint::get_xprofile_field_display_permission()	Check display setting permission from platform.
bp-xprofile/classes/class-bp-rest-xprofile-fields-endpoint.php: bp_rest_xprofile_fields_get_item_permissions_check	Filter the XProfile fields `get_item` permissions check.
bp-core/bp-core-options.php: bp_enable_private_network()	Enable private network for site owner.

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