BP_REST_Topics_Endpoint::get_item_permissions_check( WP_REST_Request $request )

Check if a given request has access to list topic.

Description

Parameters

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

Return

(bool|WP_Error)

Source

File: bp-forums/classes/class-bp-rest-topics-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(),
            )
        );
    }
 
    $topic = get_post( $request['id'] );
 
    if ( true === $retval && empty( $topic->ID ) ) {
        $retval = new WP_Error(
            'bp_rest_topic_invalid_id',
            __( 'Invalid topic ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    if ( true === $retval && ( ! isset( $topic->post_type ) || 'topic' !== $topic->post_type ) ) {
        $retval = new WP_Error(
            'bp_rest_topic_invalid_id',
            __( 'Invalid topic ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    if ( isset( $topic->post_type ) ) {
        $post_type = get_post_type_object( $topic->post_type );
 
        if ( true === $retval && ! current_user_can( $post_type->cap->read_post, $topic->ID ) ) {
            $retval = new WP_Error(
                'bp_rest_authorization_required',
                __( 'Sorry, you are not allowed to access this topic.', 'buddyboss' ),
                array(
                    'status' => rest_authorization_required_code(),
                )
            );
        }
    }
 
    /**
     * Filter the topic `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_topic_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-forums/classes/class-bp-rest-topics-endpoint.php: bp_rest_topic_get_item_permissions_check	Filter the topic `get_item` permissions check.
bp-core/bp-core-options.php: bp_enable_private_network()	Enable private network for site owner.

Used By
Used By	Description
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::update_item_permissions_check()	Check if a given request has access to update a topic.
bp-forums/classes/class-bp-rest-topics-endpoint.php: BP_REST_Topics_Endpoint::delete_item_permissions_check()	Check if a given request has access to delete a topic.

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