BP_REST_Signup_Endpoint::get_item_permissions_check( WP_REST_Request $request )

Check if a given request has access to get a signup.

Description

Parameters

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

Return

(WP_Error|bool)

Source

File: bp-members/classes/class-bp-rest-signup-endpoint.php

public function get_item_permissions_check( $request ) {
    $retval = true;
    $signup = $this->get_signup_object( $request['id'] );
 
    if ( ! is_user_logged_in() ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you need to be logged in to perform this action.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    if ( true === $retval && empty( $signup ) ) {
        $retval = new WP_Error(
            'bp_rest_invalid_id',
            __( 'Invalid signup id.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    if ( true === $retval && ! bp_current_user_can( 'bp_moderate' ) ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you are not authorized to perform this action.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    /**
     * Filter the signup `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_signup_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-members/classes/class-bp-rest-signup-endpoint.php: BP_REST_Signup_Endpoint::get_signup_object()	Get signup object.
bp-members/classes/class-bp-rest-signup-endpoint.php: bp_rest_signup_get_item_permissions_check	Filter the signup `get_item` 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-members/classes/class-bp-rest-signup-endpoint.php: BP_REST_Signup_Endpoint::delete_item_permissions_check()	Check if a given request has access to delete a signup.

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