Contents

Code Reference Classes BP_REST_Groups_Endpoint BP_REST_Groups_Endpoint::create_item()

BP_REST_Groups_Endpoint::create_item( WP_REST_Request $request )

Create 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-groups-endpoint.php

359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
public function create_item( $request ) {
 
    // Setting context.
    $request->set_param( 'context', 'edit' );
 
    // If no group name.
    if ( empty( $request['name'] ) ) {
        return new WP_Error(
            'bp_rest_create_group_empty_name',
            __( 'Please, enter the name of group.', 'buddyboss' ),
            array(
                'status' => 400,
            )
        );
    }
 
    $group_id = groups_create_group( $this->prepare_item_for_database( $request ) );
 
    if ( ! is_numeric( $group_id ) ) {
        return new WP_Error(
            'bp_rest_user_cannot_create_group',
            __( 'Cannot create new group.', 'buddyboss' ),
            array(
                'status' => 500,
            )
        );
    }
 
    $group         = $this->get_group_object( $group_id );
    $fields_update = $this->update_additional_fields_for_object( $group, $request );
 
    if ( is_wp_error( $fields_update ) ) {
        return $fields_update;
    }
 
    // Set group type(s).
    if ( ! empty( $request['types'] ) ) {
        bp_groups_set_group_type( $group_id, $request['types'] );
    }
 
    $retval = $this->prepare_response_for_collection(
        $this->prepare_item_for_response( $group, $request )
    );
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires after a group is created via the REST API.
     *
     * @param BP_Groups_Group  $group    The created group.
     * @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_groups_create_item', $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-groups-endpoint.php: BP_REST_Groups_Endpoint::prepare_item_for_database()

Prepare a group for create or update.
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::get_group_object()

Get group object.
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::prepare_item_for_response()

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

Fires after a group is created via the REST API.
bp-groups/bp-groups-functions.php: bp_groups_set_group_type()

Set type for a group.
bp-groups/bp-groups-functions.php: groups_create_group()

Create a group.
Show 1 more use 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.