BP_REST_Messages_Endpoint:: get_item (WP_REST_Request美元的请求)
检索线程。
描述
参数
- 美元的请求
-
(WP_REST_Request)(必需)请求的全部细节。
返回
(WP_REST_Response)| WP_Error
源
文件:bp-messages /类/ class-bp-rest-messages-endpoint.php
公共函数get_item(请求){$ args =数组(“user_id”= > $请求(“user_id”),“盒子”= > $请求(“盒子”),“类型”= > $请求“类型”,“页面”= > $请求(“页面”),“per_page”= > $请求(“per_page”),“search_term”= >请求['搜索'],美元);//包含星号消息的meta_query。如果(“主演”= = = $ args(“盒子”)){$ args [' meta_query '] =数组(/ / phpcs:忽略数组(“关键”= >“starred_by_user”,“价值”= > args [' user_id '],美元),);} /** *过滤请求的查询参数。* * @param array $args查询变量的关键值数组。@param WP_REST_Request $request发送给API的请求。* * @since 0.1.0 */ $args = apply_filters('bp_rest_messages_get_items_query_args', $args, $request);Add_filter ('bp_messages_default_per_page', array($this, 'bp_rest_messages_default_per_page'));//实际上,查询它。$messages_box = new BP_Messages_Box_Template($args); remove_filter( 'bp_messages_default_per_page', array( $this, 'bp_rest_messages_default_per_page' ) ); $retval = array(); if ( ! empty( $messages_box->threads ) ) { foreach ( (array) $messages_box->threads as $thread ) { $retval[] = $this->prepare_response_for_collection( $this->prepare_item_for_response( $thread, $request ) ); } } // Added header for the unread count for box=inbox. $response = rest_ensure_response( $retval ); $response = bp_rest_response_add_total_headers( $response, $messages_box->total_thread_count, $args['per_page'] ); /** * Fires after a thread is fetched via the REST API. * * @param BP_Messages_Box_Template $messages_box Fetched thread. * @param WP_REST_Response $response The response data. * @param WP_REST_Request $request The request sent to the API. * * @since 0.1.0 */ do_action( 'bp_rest_messages_get_items', $messages_box, $response, $request ); return $response; }
更新日志
版本 | 描述 |
---|---|
0.1.0 | 介绍了。 |