BP_REST_Group_Messages_Endpoint::get_collection_params()
Get the query params for Messages collections.
Description
Return
(array)
Source
File: bp-messages/classes/class-bp-rest-group-messages-endpoint.php
public function get_collection_params() {
$params = parent::get_collection_params();
$params['context']['default'] = 'edit';
unset( $params['page'], $params['per_page'], $params['search'] );
$params['group_id'] = array(
'description' => __( 'A unique numeric ID for the Group.', 'buddyboss' ),
'type' => 'integer',
'required' => true,
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
);
$params['message'] = array(
'description' => __( 'Content of the Message to add to the Thread.', 'buddyboss' ),
'type' => 'string',
'required' => true,
'validate_callback' => 'rest_validate_request_arg',
);
$params['users'] = array(
'description' => __( 'Group thread users individual or all.', 'buddyboss' ),
'type' => 'string',
'required' => true,
'enum' => array( 'all', 'individual' ),
'validate_callback' => 'rest_validate_request_arg',
);
$params['users_list'] = array(
'description' => __( 'Limit result to messages created by a specific user.', 'buddyboss' ),
'type' => 'array',
'items' => array( 'type' => 'integer' ),
'sanitize_callback' => 'bp_rest_sanitize_string_list',
'validate_callback' => 'rest_validate_request_arg',
);
$params['type'] = array(
'description' => __( 'Type of message, Group thread or private reply.', 'buddyboss' ),
'type' => 'string',
'required' => true,
'enum' => array( 'open', 'private' ),
'validate_callback' => 'rest_validate_request_arg',
);
/**
* Filters the collection query params.
*
* @param array $params Query params.
*/
return apply_filters( 'bp_rest_messages_group_collection_params', $params );
}
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.