Contents

Code Reference Classes BP_REST_Groups_Endpoint BP_REST_Groups_Endpoint::update_item()

BP_REST_Groups_Endpoint::update_item( WP_REST_Request $request )

Update a group.

Description

Parameters

$request

(Required) Full details about the request.

Return

(WP_REST_Response) | WP_Error

Source

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

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
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
public function update_item( $request ) {
    // Setting context.
    $request->set_param( 'context', 'edit' );
 
    $group_id = groups_create_group( $this->prepare_item_for_database( $request ) );
 
    if ( ! is_numeric( $group_id ) ) {
        return new WP_Error(
            'bp_rest_user_cannot_update_group',
            __( 'Cannot update existing 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;
    }
 
    $retval = $this->prepare_response_for_collection(
        $this->prepare_item_for_response( $group, $request )
    );
 
    $response = rest_ensure_response( $retval );
 
    /**
     * Fires after a group is updated via the REST API.
     *
     * @param BP_Groups_Group  $group    The updated 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_update_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_update_item

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

Create a group.

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.