BP_REST_Group_Membership_Endpoint::update_item( WP_REST_Request $request )
Update user status on a group (add, remove, promote, demote or ban).
Description
Parameters
- $request
-
(Required) Full details about the request.
Return
(WP_REST_Response) | WP_Error
Source
File: bp-groups/classes/class-bp-rest-group-membership-endpoint.php
public function update_item( $request ) {
$user = bp_rest_get_user( $request['user_id'] );
$group = $this->groups_endpoint->get_group_object( $request['group_id'] );
$action = $request['action'];
$role = $request['role'];
$group_id = $group->id;
$group_member = new BP_Groups_Member( $user->ID, $group_id );
/**
* Fires before the promotion of a user to a new status.
*
* @param int $group_id ID of the group being promoted in.
* @param int $user_id ID of the user being promoted.
* @param string $status New status being promoted to.
*/
do_action( "groups_{$action}_member", $group_id, $user->ID, $role );
if ( 'promote' === $action ) {
if ( ! $group_member->promote( $role ) ) {
return new WP_Error(
'bp_rest_group_member_failed_to_promote',
__( 'Could not promote member.', 'buddyboss' ),
array(
'status' => 500,
)
);
}
} elseif ( 'demote' === $action && 'member' !== $role ) {
if ( ! $group_member->promote( $role ) ) {
return new WP_Error(
'bp_rest_group_member_failed_to_demote',
__( 'Could not demote member.', 'buddyboss' ),
array(
'status' => 500,
)
);
}
} elseif ( in_array( $action, array( 'demote', 'ban', 'unban' ), true ) ) {
if ( ! $group_member->$action() ) {
$messages = array(
'demote' => __( 'Could not demote member from the group.', 'buddyboss' ),
'ban' => __( 'Could not ban member from the group.', 'buddyboss' ),
'unban' => __( 'Could not unban member from the group.', 'buddyboss' ),
);
return new WP_Error(
'bp_rest_group_member_failed_to_' . $action,
$messages[ $action ],
array(
'status' => 500,
)
);
}
}
$after_action = array(
'promote' => 'promoted',
'demote' => 'demoted',
'ban' => 'banned',
'unban' => 'unbanned',
);
/**
* Fires after a group member has been updated.
*
* @param int $user_id ID of the user being updated.
* @param int $group_id ID of the group.
*/
do_action( "groups_{$after_action[$action]}_member", $user->ID, $group_id );
// Setting context.
$request->set_param( 'context', 'edit' );
$retval = $this->prepare_response_for_collection(
$this->prepare_item_for_response( $group_member, $request )
);
$response = rest_ensure_response( $retval );
/**
* Fires after a group member is updated via the REST API.
*
* @param WP_User $user The updated member.
* @param BP_Groups_Member $group_member The group member object.
* @param BP_Groups_Group $group The group object.
* @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_group_members_update_item', $user, $group_member, $group, $response, $request );
return $response;
}
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.