BP_REST_Groups_Endpoint::get_item_permissions_check( WP_REST_Request $request )
Check if a given request has access to get information about a specific group.
Description Description
Parameters Parameters
- $request
-
(Required) Full details about the request.
Return Return
(true|WP_Error)
Source Source
File: bp-groups/classes/class-bp-rest-groups-endpoint.php
public function get_item_permissions_check( $request ) {
$retval = true;
$group = $this->get_group_object( $request );
if ( empty( $group->id ) ) {
$retval = new WP_Error(
'bp_rest_group_invalid_id',
__( 'Invalid group ID.', 'buddypress' ),
array(
'status' => 404,
)
);
}
if ( true === $retval && ! $this->can_see( $group ) ) {
$retval = new WP_Error(
'bp_rest_authorization_required',
__( 'Sorry, you cannot view the group.', 'buddypress' ),
array(
'status' => rest_authorization_required_code(),
)
);
}
/**
* Filter the groups `get_item` permissions check.
*
* @since 5.0.0
*
* @param bool|WP_Error $retval Returned value.
* @param WP_REST_Request $request The request sent to the API.
*/
return apply_filters( 'bp_rest_groups_get_item_permissions_check', $retval, $request );
}
Changelog Changelog
| Version | Description |
|---|---|
| 5.0.0 | Introduced. |