BP_REST_Components_Endpoint::get_items_permissions_check( WP_REST_Request $request )

Check if a given request has access to list components.

Description

Parameters

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

Return

(bool|WP_Error)

Source

File: bp-core/classes/class-bp-rest-components-endpoint.php

public function get_items_permissions_check( $request ) {
    $retval = true;
 
    if ( ! ( is_user_logged_in() && bp_current_user_can( 'bp_moderate' ) ) ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you do not have access to list components.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    /**
     * Filter the components `get_items` permissions check.
     *
     * @param bool|WP_Error $retval Returned value.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    return apply_filters( 'bp_rest_components_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-core/classes/class-bp-rest-components-endpoint.php: bp_rest_components_get_items_permissions_check	Filter the components `get_items` permissions check.
bp-core/bp-core-caps.php: bp_current_user_can()	Check whether the current user has a given capability.

Used By
Used By	Description
bp-core/classes/class-bp-rest-components-endpoint.php: BP_REST_Components_Endpoint::update_item_permissions_check()	Check if a given request has access to update a component.

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