BP_REST_Group_Membership_Request_Endpoint::create_item( WP_REST_Request $request )

Request membership to a group.

Description

Parameters

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

Return

(WP_REST_Response) | WP_Error

Source

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

public function create_item( $request ) {
    $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'] );
 
    // Avoid duplicate requests.
    if ( groups_check_for_membership_request( $user->ID, $group->id ) ) {
        return new WP_Error(
            'bp_rest_group_membership_requests_duplicate_request',
            __( 'There is already a request to this member.', 'buddyboss' ),
            array(
                'status' => 500,
            )
        );
    }
 
    $request_id = groups_send_membership_request(
        array(
            'group_id' => $group->id,
            'user_id'  => $user->ID,
            'content'  => $request['message'],
        )
    );
 
    if ( ! $request_id ) {
        return new WP_Error(
            'bp_rest_group_membership_requests_cannot_create_item',
            __( 'Could not send membership request to this group.', 'buddyboss' ),
            array(
                'status' => 500,
            )
        );
    }
 
    // Setting context.
    $request->set_param( 'context', 'edit' );
 
    $invite = new BP_Invitation( $request_id );
 
    $retval = $this->prepare_response_for_collection(
        $this->prepare_item_for_response( $invite, $request )
    );
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires after a group membership request is made via the REST API.
     *
     * @param WP_User $user The user.
     * @param BP_Invitation $invite The invitation object.
     * @param BP_Groups_Group $group The group object.
     * @param WP_REST_Response $response The response data.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    do_action( 'bp_rest_group_membership_requests_create_item', $user, $invite, $group, $response, $request );
 
    return $response;
}

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_Request_Endpoint::prepare_item_for_response()	Prepares group invitation data to return as an object.
bp-groups/classes/class-bp-rest-group-membership-request-endpoint.php: bp_rest_group_membership_requests_create_item	Fires after a group membership request is made via the REST API.
bp-core/bp-core-rest-api.php: bp_rest_get_user()	Get the user object, if the ID is valid.
bp-core/classes/class-bp-invitation.php: BP_Invitation::__construct()	Constructor method.
bp-groups/bp-groups-functions.php: groups_check_for_membership_request()	Check whether a user has an outstanding membership request for a given group.
bp-groups/bp-groups-functions.php: groups_send_membership_request()	Create a group membership request.
bp-core/bp-core-template.php: bp_loggedin_user_id()	Get the ID of the currently logged-in user.

Show 2 more uses Hide more uses

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