Contents

Code Reference Classes BP_REST_Group_Settings_Endpoint BP_REST_Group_Settings_Endpoint::update_item_permissions_check()

BP_REST_Group_Settings_Endpoint::update_item_permissions_check( WP_REST_Request $request )

Check if a given request has access to update account settings options.

Description

Parameters

$request

(Required) Full data about the request.

Return

(WP_Error|bool)

Source

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

336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
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
public function update_item_permissions_check( $request ) {
    $retval = true;
 
    $retval = true;
 
    if ( ! is_user_logged_in() ) {
        $retval = new WP_Error(
            'bp_rest_authorization_required',
            __( 'Sorry, you are not allowed to update 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 update the group settings.', 'buddyboss' ),
            array(
                'status' => rest_authorization_required_code(),
            )
        );
    }
 
    /**
     * Filter the group settings options `update_item` 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_update_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.