Contents

Code Reference Classes BP_REST_Group_Settings_Endpoint BP_REST_Group_Settings_Endpoint::get_item_permissions_check()

BP_REST_Group_Settings_Endpoint::get_item_permissions_check( WP_REST_Request $request )

Check if a given request has access to group details.

Description

Parameters

$request

(Required) Full details about the request.

Return

(bool|WP_Error)

Source

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

191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
public function get_item_permissions_check( $request ) {
    $retval = true;
 
    if ( ! is_user_logged_in() ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you are not allowed to see the group settings.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    if ( true === $retval && ! bp_is_active( 'groups' ) ) {
        $retval = new WP_Error(
            'bp_rest_component_required',
            __( 'Sorry, Groups component was not enabled.', 'buddyboss' ),
            array(
                'status' => '404',
            )
        );
    }
 
    $group = $this->groups_endpoint->get_group_object( $request );
    if ( true === $retval && empty( $group->id ) ) {
        $retval = new WP_Error(
            'bp_rest_group_invalid_id',
            __( 'Invalid group ID.', 'buddyboss' ),
            array(
                'status' => 404,
            )
        );
    }
 
    // If group author does not match logged_in user, block update.
    if ( true === $retval && ! $this->groups_endpoint->can_user_delete_or_update( $group ) ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you are not allowed to see the group settings.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    /**
     *  Filter the group settings permissions check.
     *
     * @param bool|WP_Error   $retval  Returned value.
     * @param WP_REST_Request $request The request sent to the API.
     *
     * @since 0.1.0
     */
    return apply_filters( 'bp_rest_group_settings_get_item_permissions_check', $retval, $request );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
0.1.0 Introduced.

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.