Contents

Code Reference Classes BP_REST_Group_Membership_Endpoint BP_REST_Group_Membership_Endpoint::create_item()

BP_REST_Group_Membership_Endpoint::create_item( WP_REST_Request $request )

Add member 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-endpoint.php

275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
public function create_item( $request ) {
    $user  = bp_rest_get_user( $request['user_id'] );
    $group = $this->groups_endpoint->get_group_object( $request['group_id'] );
 
    if ( ! $request['context'] || 'view' === $request['context'] ) {
        if ( ! groups_join_group( $group->id, $user->ID ) ) {
            return new WP_Error(
                'bp_rest_group_member_failed_to_join',
                __( 'Could not join the group.', 'buddyboss' ),
                array(
                    'status' => 500,
                )
            );
        }
 
        // Get the group member.
        $group_member = new BP_Groups_Member( $user->ID, $group->id );
    } else {
        $role         = $request['role'];
        $group_id     = $group->id;
        $group_member = new BP_Groups_Member( $user->ID, $group_id );
 
        // Add member to the group.
        $group_member->group_id      = $group_id;
        $group_member->user_id       = $user->ID;
        $group_member->is_admin      = 0;
        $group_member->date_modified = bp_core_current_time();
        $group_member->is_confirmed  = 1;
        $saved                       = $group_member->save();
 
        if ( ! $saved ) {
            return new WP_Error(
                'bp_rest_group_member_failed_to_join',
                __( 'Could not add member to the group.', 'buddyboss' ),
                array(
                    'status' => 500,
                )
            );
        }
 
        // If new role set, promote it too.
        if ( $saved && 'member' !== $role ) {
            // Make sure to update the group role.
            if ( groups_promote_member( $user->ID, $group_id, $role ) ) {
                $group_member = new BP_Groups_Member( $user->ID, $group_id );
            }
        }
    }
 
    // Setting context.
    $request->set_param( 'context', 'edit' );
 
    $retval = $this->prepare_response_for_collection(
        $this->prepare_item_for_response( $group_member, $request )
    );
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires after a member is added to a group via the REST API.
     *
     * @param WP_User $user The user.
     * @param BP_Groups_Member $group_member The group member 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_members_create_item', $user, $group_member, $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-endpoint.php: BP_REST_Group_Membership_Endpoint::prepare_item_for_response()

Prepares group member data for return as an object.
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: bp_rest_group_members_create_item

Fires after a member is added to a group 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-groups/classes/class-bp-groups-member.php: BP_Groups_Member::__construct()

Constructor method.
bp-groups/bp-groups-functions.php: groups_promote_member()

Promote a member to a new status within a group.
bp-groups/bp-groups-functions.php: groups_join_group()

Add a user to a group.
bp-core/bp-core-functions.php: bp_core_current_time()

Get the current GMT time to save into the DB.
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.