BP_REST_Group_Membership_Request_Endpoint::create_item_permissions_check( WP_REST_Request $request )

Checks if a given request has access to make a group membership request.

Description

Parameters

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

Return

(bool|WP_Error)

Source

File: bp-groups/classes/class-bp-rest-group-membership-request-endpoint.php

public function create_item_permissions_check( $request ) {
    $retval      = true;
    $user_id     = bp_loggedin_user_id();
    $user_id_arg = $request['user_id'] ? $request['user_id'] : bp_loggedin_user_id();
    $user        = bp_rest_get_user( $user_id_arg );
    $group       = $this->groups_endpoint->get_group_object( $request['group_id'] );
 
    // User must be logged in.
    if ( ! is_user_logged_in() ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you need to be logged in to create a membership request.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    // Check for valid user.
    if ( true === $retval && ! $user instanceof WP_User ) {
        $retval = new WP_Error(
            'bp_rest_group_member_invalid_id',
            __( 'Invalid member ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    // Check for valid group.
    if ( true === $retval && ! $group instanceof BP_Groups_Group ) {
        $retval = new WP_Error(
            'bp_rest_group_invalid_id',
            __( 'Invalid group ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    // Normal users can only extend invitations on their own behalf.
    if (
        true === $retval
        && ! bp_current_user_can( 'bp_moderate' )
        && $user_id !== $user_id_arg
    ) {
        $retval = new WP_Error(
            'bp_rest_group_membership_requests_cannot_create_item',
            __( 'User may not extend requests on behalf of another user.', 'buddyboss' ),
            array(
                'status' => 500,
            )
        );
    }
 
    /**
     * Filter the group membership request `create_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_group_membership_requests_create_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-groups/classes/class-bp-rest-group-membership-request-endpoint.php: bp_rest_group_membership_requests_create_item_permissions_check	Filter the group membership request `create_item` permissions check.
bp-core/bp-core-rest-api.php: bp_rest_get_user()	Get the user object, if the ID is valid.
bp-core/bp-core-template.php: bp_loggedin_user_id()	Get the ID of the currently logged-in user.
bp-core/bp-core-caps.php: bp_current_user_can()	Check whether the current user has a given capability.

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