BP_REST_Messages_Endpoint::get_item_permissions_check( WP_REST_Request $request )

Check if a given request has access to a thread item.

Description

Parameters

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

Return

(WP_Error|bool)

Source

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

public function get_item_permissions_check( $request ) {
    $retval = true;
 
    if ( ! is_user_logged_in() ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you are not allowed to see this thread.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    $thread = $this->get_thread_object( $request['id'] );
 
    if ( true === $retval && empty( $thread->thread_id ) ) {
        $retval = new WP_Error(
            'bp_rest_invalid_id',
            __( 'Sorry, this thread does not exist.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    if ( true === $retval && bp_current_user_can( 'bp_moderate' ) ) {
        $retval = true;
    } else {
        $id = messages_check_thread_access( $thread->thread_id );
        if ( true === $retval && is_null( $id ) ) {
            $retval = new WP_Error(
                'bp_rest_authorization_required',
                __( 'Sorry, you are not allowed to see this thread.', 'buddyboss' ),
                array(
                    'status' => rest_authorization_required_code(),
                )
            );
        }
 
        if ( true === $retval ) {
            $retval = true;
        }
    }
 
    /**
     * Filter the messages `get_item` 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_messages_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-messages/classes/class-bp-rest-messages-endpoint.php: BP_REST_Messages_Endpoint::get_thread_object()	Get thread object.
bp-messages/classes/class-bp-rest-messages-endpoint.php: bp_rest_messages_get_item_permissions_check	Filter the messages `get_item` permissions check.
bp-messages/bp-messages-functions.php: messages_check_thread_access()	Check whether a user has access to a thread.
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-messages/classes/class-bp-rest-messages-endpoint.php: BP_REST_Messages_Endpoint::delete_item_permissions_check()	Check if a given request has access to delete a thread.
bp-messages/classes/class-bp-rest-messages-endpoint.php: BP_REST_Messages_Endpoint::update_item_permissions_check()	Check if a given request has access to update a message.

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