Contents

Code Reference Classes BP_REST_Groups_Endpoint BP_REST_Groups_Endpoint::get_group_object()

BP_REST_Groups_Endpoint::get_group_object( WP_REST_Request $request )

Get group object.

Description

Parameters

$request

(Required) Full details about the request.

Return

(bool|BP_Groups_Group)

Source

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

1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
public function get_group_object( $request ) {
    if ( ! empty( $request['group_id'] ) ) {
        $group_id = (int) $request['group_id'];
    } elseif ( is_numeric( $request ) ) {
        $group_id = $request;
    } else {
        $group_id = (int) $request['id'];
    }
 
    $group = groups_get_group( $group_id );
 
    if ( empty( $group ) || empty( $group->id ) ) {
        return false;
    }
 
    return $group;
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

Uses

Uses
Uses Description
bp-groups/bp-groups-functions.php: groups_get_group()

Fetch a single group object.
Used By
Used By Description
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::delete_item()

Delete a group.
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::delete_item_permissions_check()

Check if a given request has access to delete a group.
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_item()

Retrieve a group.
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::get_item_permissions_check()

Check if a given request has access to get information about a specific group.
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::create_item()

Create a group.
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::update_item()

Update a group.
bp-groups/classes/class-bp-rest-groups-endpoint.php: BP_REST_Groups_Endpoint::update_item_permissions_check()

Check if a given request has access to update a group.
Show 3 more used by Hide more used by

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.