BP_REST_Group_Membership_Endpoint::prepare_item_for_response( BP_Groups_Member $group_member, WP_REST_Request $request )

Prepares group member data for return as an object.

Description

Parameters

$group_member: (Required) Group member object.
$request: (Required) Full details about the request.

Return

(WP_REST_Response)

Source

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

public function prepare_item_for_response( $group_member, $request ) {
    $user        = bp_rest_get_user( $group_member->user_id );
    $context     = ! empty( $request['context'] ) ? $request['context'] : 'view';
    $member_data = $this->members_endpoint->user_data( $user, $context );
 
    // Merge both info.
    $data = array_merge(
        $member_data,
        array(
            'is_mod'        => (bool) $group_member->is_mod,
            'is_admin'      => (bool) $group_member->is_admin,
            'is_banned'     => (bool) $group_member->is_banned,
            'is_confirmed'  => (bool) $group_member->is_confirmed,
            'date_modified' => bp_rest_prepare_date_response( $group_member->date_modified ),
            'role'          => '',
            'plural_role'   => '',
        )
    );
 
    // BuddyBoss Platform support.
    if ( function_exists( 'bp_get_user_group_role_title' ) && ! empty( $request['group_id'] ) ) {
        $data['role'] = bp_get_user_group_role_title( $group_member->user_id, $request['group_id'] );
 
        // BuddyPress support.
    } elseif ( function_exists( 'bp_groups_get_group_roles' ) && ! empty( $request['group_id'] ) ) {
        $group_role = bp_groups_get_group_roles();
 
        if ( groups_is_user_admin( $group_member->user_id, $request['group_id'] ) ) {
            $data['role'] = $group_role['admin']->name;
        } elseif ( groups_is_user_mod( $group_member->user_id, $request['group_id'] ) ) {
            $data['role'] = $group_role['mod']->name;
        } elseif ( groups_is_user_member( $group_member->user_id, $request['group_id'] ) ) {
            $data['role'] = $group_role['member']->name;
        }
    }
 
    if ( function_exists( 'get_group_role_label' ) && ! empty( $request['group_id'] ) ) {
        $data['plural_role'] = $this->groups_endpoint->bp_get_group_member_section_title( (int) $request['group_id'], (int) $group_member->user_id );
        if ( empty( $data['plural_role'] ) ) {
            $data['plural_role'] = $data['role'];
        }
    } else {
        $data['plural_role'] = $data['role'];
    }
 
    $data     = $this->add_additional_fields_to_object( $data, $request );
    $data     = $this->filter_response_by_context( $data, $context );
    $response = rest_ensure_response( $data );
 
    $response->add_links( $this->prepare_links( $user, $request ) );
 
    /**
     * Filter a group member value returned from the API.
     *
     * @param WP_REST_Response $response The response data.
     * @param WP_REST_Request $request Request used to generate the response.
     * @param BP_Groups_Member $group_member Group member object.
     *
     * @since 0.1.0
     */
    return apply_filters( 'bp_rest_group_members_prepare_value', $response, $request, $group_member );
}

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: bp_groups_get_group_roles()	Get the Group roles.
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: BP_REST_Group_Membership_Endpoint::prepare_links()	Prepare links for the request.
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: bp_rest_group_members_prepare_value	Filter a group member value returned from the API.
bp-core/bp-core-rest-api.php: bp_rest_get_user()	Get the user object, if the ID is valid.
bp-core/bp-core-rest-api.php: bp_rest_prepare_date_response()	Convert the input date to RFC3339 format.
bp-groups/bp-groups-functions.php: bp_get_user_group_role_title()	Get the member’s group role
bp-groups/bp-groups-functions.php: groups_is_user_admin()	Check whether a user is an admin of a given group.
bp-groups/bp-groups-functions.php: groups_is_user_mod()	Check whether a user is a mod of a given group.
bp-groups/bp-groups-functions.php: groups_is_user_member()	Check whether a user is a member of a given group.

Show 4 more uses Hide more uses

Used By
Used By	Description
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: BP_REST_Group_Membership_Endpoint::get_items()	Retrieve group members.
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: BP_REST_Group_Membership_Endpoint::create_item()	Add member to a group.
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: BP_REST_Group_Membership_Endpoint::update_item()	Update user status on a group (add, remove, promote, demote or ban).
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: BP_REST_Group_Membership_Endpoint::delete_item()	Delete a group membership.

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.

Contents