bp_has_message_threads(|字符串数组args美元=数组())
检索用于在收件箱/发送框/通知中显示的私有消息线程。
描述
类似于WordPress的have_posts()函数,这个函数负责查询数据库,并通过成员的收件箱/发件箱/通知的单个模板部分检索私有消息以显示在主题中。
参数
- args美元
-
(数组|字符串)(可选)数组的参数。都是可选的。
- “user_id”
(int)正在加载线程的用户ID。默认值:登录用户的ID。 - “盒子”
(字符串)当前“框”视图。如果没有提供这里,则将从URL推断出当前视图。 - “per_page”
(int)每页返回的结果数。默认值:10。 - “马克斯”
(int)最大结果返回。默认值:false。 - “类型”
(字符串)要返回的消息类型。默认值:'all', 'read', 'unread' - “search_term”
(字符串)限制结果的条件。默认值:$_REQUEST['s']的值。 - “page_arg”
(字符串)用于分页参数的URL参数。默认值:'MPAGE'。 - 'meta_query'
(大批)元查询参数。仅适用于$box不是'notice '的情况。详见WP_Meta_Query。
默认值:数组()
- “user_id”
返回
(保龄球)如果有线程要显示,则为True,否则为false。
源
文件:bp-messages / bp-messages-template.php
函数bp_has_message_threads($ args = array()){global $ messages_template;//用户正在查看的默认框。$ current_action = bp_current_action();切换($ current_action){案例'通知':案例'收件箱':$ default_box = $ current_action;休息;默认值:$ default_box ='收件箱';休息;} //用户id // @todo显示了达到这一目标的主持人的用户?$ user_id = bp_displayed_user_id()?:bp_loggedin_user_id();//搜索条款。 $search_terms = isset( $_REQUEST['s'] ) ? stripslashes( $_REQUEST['s'] ) : ''; // Parse the arguments. $r = bp_parse_args( $args, array( 'user_id' => $user_id, 'box' => $default_box, 'per_page' => 10, 'max' => false, 'type' => 'all', 'search_terms' => $search_terms, 'include' => false, 'page_arg' => 'mpage', // See https://buddypress.trac.wordpress.org/ticket/3679. 'meta_query' => array() ), 'has_message_threads' ); // Load the messages loop global up with messages. $messages_template = new BP_Messages_Box_Template( $r ); /** * Filters if there are any message threads to display in inbox/sentbox/notices. * * @since BuddyPress 1.1.0 * * @param bool $value Whether or not the message has threads. * @param BP_Messages_Box_Template $messages_template Current message box template object. * @param array $r Array of parsed arguments passed into function. */ return apply_filters( 'bp_has_message_threads', $messages_template->has_threads(), $messages_template, $r ); }
更新日志
版本 | 描述 |
---|---|
BuddyPress 1.0.0 | 介绍了。 |