BP_REST_Group_Membership_Endpoint::get_item_schema()
Get the group member schema, conforming to JSON Schema.
Description
Return
(array)
Source
File: bp-groups/classes/class-bp-rest-group-membership-endpoint.php
public function get_item_schema() {
// Get schema from members.
$schema = $this->members_endpoint->get_item_schema();
// Set title to this endpoint.
$schema['title'] = 'bp_group_members';
$schema['properties']['is_mod'] = array(
'context' => array( 'view', 'edit' ),
'description' => __( 'Whether the member is a group moderator.', 'buddyboss' ),
'type' => 'boolean',
);
$schema['properties']['is_banned'] = array(
'context' => array( 'view', 'edit' ),
'description' => __( 'Whether the member has been banned from the group.', 'buddyboss' ),
'type' => 'boolean',
);
$schema['properties']['is_admin'] = array(
'context' => array( 'view', 'edit' ),
'description' => __( 'Whether the member is a group administrator.', 'buddyboss' ),
'type' => 'boolean',
);
$schema['properties']['is_confirmed'] = array(
'context' => array( 'view', 'edit' ),
'description' => __( 'Whether the membership of this user has been confirmed.', 'buddyboss' ),
'type' => 'boolean',
);
$schema['properties']['date_modified'] = array(
'context' => array( 'view', 'edit' ),
'description' => __( "The date of the last time the membership of this user was modified, in the site's timezone.", 'buddyboss' ),
'type' => 'string',
'format' => 'date-time',
);
$schema['properties']['role'] = array(
'context' => array( 'view', 'edit' ),
'description' => __( 'Current member\'s role label in the group.', 'buddyboss' ),
'type' => 'string',
'readonly' => true,
);
$schema['properties']['plural_role'] = array(
'context' => array( 'view', 'edit' ),
'description' => __( 'Current member\'s role label in the plural form in the group.', 'buddyboss' ),
'type' => 'string',
'readonly' => true,
);
/**
* Filters the group membership schema.
*
* @param array $schema The endpoint schema.
*/
return apply_filters( 'bp_rest_group_members_schema', $this->add_additional_fields_schema( $schema ) );
}
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.