BP_REST_Forums_Endpoint::update_item_permissions_check( WP_REST_Request $request )

Check if a given request has access to update a forum.

Description

Parameters

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

Return

(bool|WP_Error)

Source

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

public function update_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 subscribe/unsubscribe the forum.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    if ( true === $retval && ! bbp_is_subscriptions_active() ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Subscription was disabled.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    $forum = get_post( $request['id'] );
 
    if ( empty( $forum->ID ) ) {
        $retval = new WP_Error(
            'bp_rest_forum_invalid_id',
            __( 'Invalid forum ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    if ( true === $retval && ( ! isset( $forum->post_type ) || 'forum' !== $forum->post_type ) ) {
        $retval = new WP_Error(
            'bp_rest_forum_invalid_id',
            __( 'Invalid forum ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    $user_id = bbp_get_user_id( 0, true, true );
 
    if ( true === $retval && ! current_user_can( 'edit_user', $user_id ) ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'You don\'t have the permission to update favorites.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    /**
     * Filter the forum `update_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_forum_update_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-forums-endpoint.php: bp_rest_forum_update_item_permissions_check	Filter the forum `update_item` permissions check.
bp-forums/core/options.php: bbp_is_subscriptions_active()	Checks if subscription feature is enabled.
bp-forums/users/template.php: bbp_get_user_id()	Return a validated user id

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