BP_REST_Group_Membership_Endpoint::get_endpoint_args_for_method( string $method = WP_REST_Server::CREATABLE )

GET arguments for the endpoint’s CREATABLE, EDITABLE & DELETABLE methods.

Description

Parameters

$method

(Optional) HTTP method of the request.

Default value: WP_REST_Server::CREATABLE

Return

(array) Endpoint arguments.

Source

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

public function get_endpoint_args_for_method( $method = WP_REST_Server::CREATABLE ) {
    $key  = 'get_item';
    $args = array(
        'context' => $this->get_context_param(
            array(
                'default' => 'edit',
            )
        ),
    );
 
    if ( WP_REST_Server::CREATABLE === $method || WP_REST_Server::EDITABLE === $method ) {
        $group_roles = array_diff( array_keys( bp_groups_get_group_roles() ), array( 'banned' ) );
 
        $args['role'] = array(
            'description'       => __( 'Group role to assign the user to.', 'buddyboss' ),
            'default'           => 'member',
            'type'              => 'string',
            'enum'              => $group_roles,
            'sanitize_callback' => 'sanitize_key',
            'validate_callback' => 'rest_validate_request_arg',
        );
 
        if ( WP_REST_Server::CREATABLE === $method ) {
            $key             = 'create_item';
            $schema          = $this->get_item_schema();
            $args['user_id'] = array_merge(
                $schema['properties']['id'],
                array(
                    'description' => __( 'A unique numeric ID for the Member to add to the Group.', 'buddyboss' ),
                    'default'     => bp_loggedin_user_id(),
                    'required'    => true,
                    'readonly'    => false,
                )
            );
        }
 
        if ( WP_REST_Server::EDITABLE === $method ) {
            $key            = 'update_item';
            $args['action'] = array(
                'description'       => __( 'Action used to update a group member.', 'buddyboss' ),
                'default'           => 'promote',
                'type'              => 'string',
                'enum'              => array( 'promote', 'demote', 'ban', 'unban' ),
                'sanitize_callback' => 'sanitize_key',
                'validate_callback' => 'rest_validate_request_arg',
            );
        }
    } elseif ( WP_REST_Server::DELETABLE === $method ) {
        $key = 'delete_item';
    }
 
    /**
     * Filters the method query arguments.
     *
     * @param array $args Query arguments.
     * @param string $method HTTP method of the request.
     *
     * @since 0.1.0
     */
    return apply_filters( "bp_rest_group_members_{$key}_query_arguments", $args, $method );
}

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::get_item_schema()	Get the group member schema, conforming to JSON Schema.
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: bp_rest_group_members_{$key}_query_arguments	Filters the method query arguments.
bp-core/bp-core-template.php: bp_loggedin_user_id()	Get the ID of the currently logged-in user.

Used By
Used By	Description
bp-groups/classes/class-bp-rest-group-membership-endpoint.php: BP_REST_Group_Membership_Endpoint::register_routes()	Register the component routes.

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