BP_REST_Document_Endpoint::get_item_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_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(),
            )
        );
    }
 
    $document = new BP_Document( $request['id'] );
 
    if ( true === $retval && empty( $document->id ) ) {
        $retval = new WP_Error(
            'bp_rest_document_invalid_id',
            __( 'Invalid document ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    if (
        true === $retval
        && 'public' !== $document->privacy
        && true === $this->bp_rest_check_privacy_restriction( $document )
    ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, Restrict access to view this document.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    /**
     * Filter the document `get_item` permissions check.
     *
     * @since 0.1.0
     *
     * @param WP_REST_Request $request The request sent to the API.
     * @param bool            $retval  Returned value.
     */
    return apply_filters( 'bp_rest_document_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-document/classes/class-bp-rest-document-endpoint.php: BP_REST_Document_Endpoint::bp_rest_check_privacy_restriction()	Check user access based on the privacy for the single document.
bp-document/classes/class-bp-rest-document-endpoint.php: bp_rest_document_get_item_permissions_check	Filter the document `get_item` permissions check.
bp-document/classes/class-bp-document.php: BP_Document::__construct()	Constructor method.
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