Contents

Code Reference Classes BP_REST_Group_Invites_Endpoint BP_REST_Group_Invites_Endpoint::create_item_permissions_check()

BP_REST_Group_Invites_Endpoint::create_item_permissions_check( WP_REST_Request $request )

Checks if a given request has access to invite a member to a group.

Description

Parameters

$request

(Required) Full details about the request.

Return

(bool|WP_Error)

Source

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

444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
public function create_item_permissions_check( $request ) {
    $inviter_id_arg = $request['inviter_id'] ? $request['inviter_id'] : bp_loggedin_user_id();
    $group          = $this->groups_endpoint->get_group_object( $request['group_id'] );
    $user           = bp_rest_get_user( $request['user_id'] );
    $inviter        = bp_rest_get_user( $inviter_id_arg );
    $retval         = true;
 
    if ( ! is_user_logged_in() ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you need to be logged in to create an invitation.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    if ( true === $retval && empty( $group->id ) ) {
        $retval = new WP_Error(
            'bp_rest_group_invalid_id',
            __( 'Invalid group ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    if ( true === $retval && ( empty( $user->ID ) || empty( $inviter->ID ) || $user->ID === $inviter->ID ) ) {
        $retval = new WP_Error(
            'bp_rest_member_invalid_id',
            __( 'Invalid member ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    // Only a site admin or the user herself can extend invites.
    if ( true === $retval && ! bp_current_user_can( 'bp_moderate' ) && bp_loggedin_user_id() !== $inviter_id_arg ) {
        $retval = new WP_Error(
            'bp_rest_group_invite_cannot_create_item',
            __( 'Sorry, you are not allowed to create the invitation as requested.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    /**
     * Filter the group invites `create_item` permissions check.
     *
     * @param bool|WP_Error   $retval  Whether the request can continue.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    return apply_filters( 'bp_rest_group_invites_create_item_permissions_check', $retval, $request );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

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.