BP_REST_Messages_Endpoint: get_collection_params ()
获取消息集合的查询参数。
描述
返回
(数组)
源
文件:bp-messages /类/ class-bp-rest-messages-endpoint.php
Public function get_collection_params() {$params = parent::get_collection_params();$ params['环境'](“违约”)=“视图”;$boxes = array(' sendbox ', '收件箱');If (bp_is_active('messages', 'star')) {$boxes[] = '星号';} $params['box'] = array('description' => __('通过box过滤结果。', 'buddyboss'), 'default' => 'inbox', 'type' => 'string', 'enum' => $boxes, 'sanitize_callback' => 'sanitize_key', 'validate_callback' => 'rest_validate_request_arg');$params['type'] = array('description' => __('根据线程状态过滤结果。', 'buddyboss'), 'default' => 'all', 'type' => 'string', 'enum' => array('all', 'read', 'unread'), 'sanitize_callback' => 'sanitize_key', 'validate_callback' => 'rest_validate_request_arg',);$params['user_id'] = array('description' => __('限制结果由特定用户创建的消息。', 'buddyboss'), 'default' => bp_loggedin_user_id(), 'type' => 'integer', 'required' => true, 'sanitize_callback' => 'absint', 'validate_callback' => 'rest_validate_request_arg',); /** * Filters the collection query params. * * @param array $params Query params. */ return apply_filters( 'bp_rest_messages_collection_params', $params ); }
更新日志
版本 | 描述 |
---|---|
0.1.0 | 介绍了。 |