BP_REST_Document_Endpoint::get_items_permissions_check( WP_REST_Request $request )

Checks if a given request has access to get all users.

Description

Parameters

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

Return

(bool)

Source

File: bp-document/classes/class-bp-rest-document-endpoint.php

public function get_items_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(),
            )
        );
    }
 
    /**
     * Filter the members `get_items` 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_document_get_items_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-document/classes/class-bp-rest-document-endpoint.php: bp_rest_document_get_items_permissions_check	Filter the members `get_items` permissions check.
bp-groups/bp-groups-functions.php: groups_get_user_groups()	Get the IDs of the groups of which a specified user is a member.
bp-groups/bp-groups-functions.php: groups_get_group()	Fetch a single group object.
bp-groups/bp-groups-template.php: bp_get_group_status()	Get the status of the current group in the loop.
bp-core/bp-core-template.php: bp_is_active()	Check whether a given component (or feature of a component) is active.
bp-core/bp-core-template.php: bp_loggedin_user_id()	Get the ID of the currently logged-in user.
bp-core/bp-core-caps.php: bp_current_user_can()	Check whether the current user has a given capability.
bp-core/bp-core-options.php: bp_enable_private_network()	Enable private network for site owner.

Show 3 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.

Contents