彭家二少

2020年9月06日星期日站长/

WordPress 自定义查询 WP_Query 所有参数详细注释

WordPress 中文资源不算少，但真正完整全面的中文资源却不多。比如 WP＿Query 这个万能的文章查询类，就很难找到完整、全面的资源。下面是在官方文章的相关资源里看到的，有人把 WP＿Query 所有的参数做了一个总结，然后注释了一下，可惜是英文的，幸运的是我能看得懂，所有就顺便翻译了一下，供有需要的朋友查阅使用。有翻译不正确的地方，欢迎在留言中提出，我会及时更正。

下面的代码是 WP＿Query 类的简单介绍，更全面详细的文档请参考 WP＿Query 官方文档。喜欢图形界面的朋友还可以使用 Genetate WP 提供的 WP＿Query Generator 来生成需要的代码。

  1. <?php  
  2. /** 
  3. * WordPress 查询综合参考 
  4. * 编译：luetkemj - luetkemj.com 
  5. * 
  6. * 官方文档: http://codex.wordpress.org/Class_Reference/WP_Query 
  7. * 源代码: http://core.trac.wordpress.org/browser/tags/3.5.1/wp-includes/query.php 
  8. */  
  9.   
  10. $args = array(  
  11.   
  12. /** 
  13. * 作者参数 - 显示某些作者发表的文章 
  14. */  
  15. 'author' => '1,2,3,' //(整数) - 作者ID [使用减号 (-) 排除某个作者 ID， 如： 'author' => '-1,-2,-3,']  
  16. 'author_name' => 'luetkemj', //(字符串) - 使用 'user_nicename' 用户昵称，(不是名称)  
  17.   
  18. /** 
  19. * 分类参数 - 显示某个分类里面的文章 
  20. */  
  21. 'cat' => 5,//(整数) - 分类id  
  22. 'category_name' => 'staff', 'news', //(字符串) - 分类别名(不是名称)  
  23. 'category__and' => array( 2, 6 ), //(数组) - 分类id  
  24. 'category__in' => array( 2, 6 ), //(数组) - 分类id  
  25. 'category__not_in' => array( 2, 6 ), //(数组) - 分类id  
  26.   
  27. /** 
  28. * 标签参数 - 显示含有某些标签的文章 
  29. */  
  30. 'tag' => 'cooking', //(字符串) - 标签别名  
  31. 'tag_id' => 5, //(整数) -标签id  
  32. 'tag__and' => array( 2, 6), //(数组) - 标签id  
  33. 'tag__in' => array( 2, 6), //(数组) - 标签id  
  34. 'tag__not_in' => array( 2, 6), //(数组) - 标签id  
  35. 'tag_slug__and' => array( 'red', 'blue'), //(数组) - 标签别名  
  36. 'tag_slug__in' => array( 'red', 'blue'), //(数组) - 标签别名  
  37.   
  38. /** 
  39. * 自定义分类法参数 - 显示某些自定义分类法里面的文章 
  40. * 重要提示: tax_query 使用多维数组 
  41. * 这种查询结构允许我们查询多个自定义分类法 
  42. */  
  43. 'tax_query' => array( //(数组) - 使用自定义分类法查询参数 (3.1及以后版本可用).  
  44.   'relation' => 'AND', //(字符串) - 可用的值有 'AND' 或 'OR' 和 SQL 的 JOIN 作用是相同的  
  45.   array(  
  46.     'taxonomy' => 'color', //(字符串) - 自定义分类法  
  47.     'field' => 'slug', //(字符串) - 使用别名还是分类作为查询条件 ('id' 或 'slug')  
  48.     'terms' => array( 'red', 'blue' ), //(整数/字符串/数组) - 自定义分类法分类条目  
  49.     'include_children' => true, //(布尔值) - 是否包含自分类，默认为真  
  50.     'operator' => 'IN' //(字符串) - 测试条件，可用值为 'IN', 'NOT IN', 'AND'.  
  51.   ),  
  52.   array(  
  53.     'taxonomy' => 'actor',  
  54.     'field' => 'id',  
  55.     'terms' => array( 103, 115, 206 ),  
  56.     'include_children' => false,  
  57.     'operator' => 'NOT IN'  
  58.    )  
  59. ),  
  60.   
  61. /** 
  62. * 文章 & 页面参数- 基于文章或页面参数显示文章 
  63. */  
  64. 'p' => 1, //(整数) - 文章id  
  65. 'name' => 'hello-world', //(字符串) - 文章别名  
  66. 'page_id' => 1, //(整数) - 页面id  
  67. 'pagename' => 'sample-page', //(字符串) - 页面别名  
  68. 'pagename' => 'contact_us/canada', //(字符串) - 用斜杠‘/’分割的父页面别名/子页面别名来显示子页面  
  69. 'post_parent' => 1, //(整数) - 页面id，只返回子页面，只对有子页面的页面有效  
  70. 'post__in' => array(1,2,3), //(数组) - 需要显示的文章的id  
  71. 'post__not_in' => array(1,2,3), //(数组) - 需要排除的文章的id  
  72. //注意：不能在同一个查询里同时使用 'post__in' 和 'post__not_in'  
  73.   
  74. /** 
  75. * 文章类型 & 状态参数 - 显示某些文章类型里面的文章 
  76. */  
  77. 'post_type' => array( //(字符串/ 数组) - 文章类型，根据文章类型获取文章，默认为'post'  
  78.     'post', // - 文章  
  79.     'page', // - 页面  
  80.     'revision', // - 文章版本  
  81.     'attachment', // - 附件，默认 WP_Query 设置了发布状态为 'post_status'=>'published', 但是附件默认为 'post_status'=>'inherit'，所以你需要设置状态为 'inherit' 或'any'.  
  82.     'my-post-type', // - 自定义文章类型 (例如：movies)  
  83. ),  
  84. 'post_status' => array( //(字符串 / 数组) - 使用文章状态，根据文章状态获取文章，默认为 'publish'  
  85.     'publish', // - 已发布的文章或页面  
  86.     'pending', // -等待复审的文章  
  87.     'draft', // - 处于草稿状态的文章  
  88.     'auto-draft', // - 自动保存为草稿的文章  
  89.     'future', // - 定时发布的文章  
  90.     'private', // - 未登录用户不能查看的私有文章  
  91.     'inherit', // - 版本. 具体参考 get_children.  
  92.     'trash' // - 回收站中的文章 (2.9和以后的版本可用).  
  93. ),  
  94.   
  95. //注意：The 'any' 关键字可以用在 post_type 和 post_status 查询，但是不能在数组中使用  
  96. 'post_type' => 'any', // - 获取所有文章类型里面的文章，除了版本和文章类型参数'exclude_from_search'设置为true的文章类型  
  97. 'post_status' => 'any', // - 获取处于所有文章状态的文章，除了版本和文章类型参数'exclude_from_search'设置为true的文章类型  
  98.   
  99. /** 
  100. * 分页参数 
  101. */  
  102. 'posts_per_page' => 10, //(整数) - 每页显示的文章数量 (2.1和以后的版本可用)， 使用'posts_per_page'=-1 显示所有文章，如果查询处于订阅源中，WordPress用 'posts_per_rss' 选项覆盖了这里的设置，需要使用这个限制，尝试使用 'post_limits' 过滤器，或使用 'pre_option_posts_per_rss'过滤器返回 -1  
  103. 'posts_per_archive_page' => 10, //(整数) - n每页显示的文章数量 - 只在存档页面使用，在存档页面和搜索结果页面覆盖了 showposts 和 posts_per_page 参数  
  104. 'nopaging' => false, //(布尔值) - 在一页显示所有文章或使用分页，默认值为 'false', 使用分页  
  105. 'paged' => get_query_var('paged'), //(整数) - 页数，分页时显示第几页  
  106. //注意：使用 get_query_var('page'); 如果查询在设置为首页的页面模版中工作，查询参数 'page' 拥有文章分页或内容中使用 <!--nextpage--> 快捷代码的分页。  
  107.   
  108. /** 
  109. * 偏移参数 
  110. */  
  111. 'offset' => 3, //(int) - 跳过的文章数量  
  112.   
  113. /** 
  114. * 排序 & 排序方式参数 - 对获取的文章进行排序 
  115. */  
  116. 'order' => 'DESC', //(字符串) - 设置 'order_by' 参数升序或降序排列. 默认为'DESC'.  
  117. //Possible Values:  
  118. //'ASC' - 升序排列，从小到大 (1, 2, 3; a, b, c).  
  119. //'DESC' - 降序排列，从大到小 (3, 2, 1; c, b, a).  
  120. 'orderby' => 'date', //(字符串) - 排序依据. 默认为 'date'.  
  121. //可用的参数有://  
  122. //'none' - 不排序 (2.8和以后的版本可用)  
  123. //'ID' - 根据ID排序，注意ID是大写的  
  124. //'author' - 根据作者排序  
  125. //'title' - 根据标题排序  
  126. //'date' - 根据发表时间排序  
  127. //'modified' - 根据最后修改时间排序  
  128. //'parent' - 根据父页面排序  
  129. //'rand' - 随机排序  
  130. //'comment_count' - 根据评论数量排序 (2.9和以后的版本可用).  
  131. //'menu_order' - 根据页面序号排序. 通常在页面中使用 (编辑页面时有一个页面序号的字段) 和附件 ( 插入 / 上传媒体相册对话框中的数字), 但是不能对文章类型 'menu_order' 使用数字值 (默认都为 0).  
  132. //'meta_value' - 注意'meta_key=keyname' 必须也出现在查询中. 注意排序是按照字母表顺序进行的。(如：words),但是数字排序可能会有问题 (如：1, 3, 34, 4, 56, 6, etc, 而不是你希望的：1, 3, 4, 6, 34, 56)。  
  133. //'meta_value_num' - 根据数字meta值排序 (2.8和以后的版本中可用). 同时需要注意'meta_key=keyname' 也要在查询中声明。这个值和上面说明的 'meta_value' 一样，只不过值允许使用数字排序。  
  134. //'title menu_order' - 同时使用 menu_order 和 title 排序 更多信息请参考：http://wordpress.stackexchange.com/questions/2969/order-by-menu-order-and-title  
  135. //'post__in' - 使用 post__in 数组中制定的 ID 顺序 (3.5以后的版本中可用).  
  136.   
  137. /** 
  138. * 置顶文章参数 - 显示或忽略置顶文章 
  139. */  
  140. 'ignore_sticky_posts' => false, //(布尔值) - 是否忽略置顶文章，默认为假不忽略. 在返回文章的开头忽略/排除置顶文章,但是置顶文章还是会在自然查询中列出。  
  141. //注意：关于置顶文章的更多信息，请参考：http://codex.wordpress.org/Class_Reference/WP_Query#Sticky_Post_Parameters  
  142.   
  143. /** 
  144. * 时间参数 - 显示某个时间段内的文章 
  145. */  
  146. 'year' => 2012, //(int) - 4 个数字的年份 (如：2011)  
  147. 'monthnum' => 3, //(int) - 月份数字 (从 1 到 12)  
  148. 'w' => 25, //(int) - 一年中的第几周 (从 0 到 53)， 使用 MySQL WEEK 命令，此模式和"start_of_week" 选项相关  
  149. 'day' => 17, //(int) - 月中的天数 (从 1 到 31)  
  150. 'hour' => 13, //(int) - 小时 (从 0 到 23).  
  151. 'minute' => 19, //(int) - 分钟 (从 0 到 60).  
  152. 'second' => 30, //(int) - 秒 (从 0 到 60).  
  153.   
  154. /** 
  155. * 自定义字段参数 - 显示拥有某个自定义字段的文章 
  156. */  
  157. 'meta_key' => 'key', //(字符串) - 自定义字段的键  
  158. 'meta_value' => 'value', //(字符串) - 自定义字段的值  
  159. 'meta_value_num' => 10, //(数字) - 自定义字段的值  
  160. 'meta_compare' => '=', //(字符串) - 测试'meta_value'的操作。可用的值有'!=', '>', '>=', '<', or ='. 默认为 '='.  
  161. 'meta_query' => array( //(数组) - 自定义字段参数 (3.1和以后的版本可用).  
  162. array(  
  163.     'key' => 'color', //(字符串) - 自定义字段的键  
  164.     'value' => 'blue', //(字符串/数组) - 自定义字段的值 (注意：数组的支持仅限于一个比较值： 'IN', 'NOT IN', 'BETWEEN', or 'NOT BETWEEN')  
  165.     'type' => 'CHAR', //(字符串) -自定义字段类型，可用的值有：'NUMERIC', 'BINARY', 'CHAR', 'DATE', 'DATETIME', 'DECIMAL', 'SIGNED', 'TIME', 'UNSIGNED'，默认为    'CHAR'  
  166.     'compare' => '=' //(字符串) - 测试的操作，可用的值有： '=', '!=', '>', '>=', '<', '<=', 'LIKE', 'NOT LIKE', 'IN', 'NOT IN', 'BETWEEN', 'NOT BETWEEN'. 默认为：'='  
  167. ),  
  168. array(  
  169.     'key' => 'price',  
  170.     'value' => array( 1,200 ),  
  171.     'compare' => 'NOT LIKE'  
  172. )  
  173.   
  174. /** 
  175. * 权限参数 - 显示已发布文章，如果用户有合适的权限，同样现实私有文章: 
  176. */  
  177. 'perm' => 'readable' //(字符串) 可用的值有：'readable', 'editable' (可能还有其他可用的值我没有测试)  
  178.   
  179. /** 
  180. * 与缓存相关的参数 
  181. */  
  182. 'no_found_rows' => false, //(布尔值) 默认为假，为了分页，WordPress 在大多数查询中使用 SQL_CALC_FOUND_ROWS 查询， 即使你不需要分页，通过设置这个参数为真，我们告诉了了WordPress不要查询数据总行数，从而降低数据库负载，如果设置了这个参数为真，分页将不工作，更多信息请参考：http://flavio.tordini.org/speed-up-wordpress-get_posts-and-query_posts-functions  
  183. 'cache_results' => true, //(布尔值) 默认为真  
  184. 'update_post_term_cache' => true, //(布尔值) 默认为真  
  185. 'update_post_meta_cache' => true, //(布尔值) 默认为真  
  186. //注意：缓存是个好东西，通常不建议设为假，更多信息请参考：http://codex.wordpresorg/Class_Reference/WP_Query#Permission_Parameters  
  187.   
  188. /** 
  189. * 搜索参数 
  190. */  
  191. 's' => $s, //(字符串) - 传递搜索变量到搜索功能，更多信息请参考： http://www.wprecipes.com/how-to-display-the-number-of-results-in-wordpress-search  
  192. 'exact' => true //(布尔值) - 只匹配完整的titles/posts的信号 - 默认值为假，更多信息请参考：https://gist.github.com/2023628#gistcomment-285118  
  193. 'sentence' => true //(布尔值) - 进行短语搜索的信号-默认值为假，更多信息请参考：https://gist.github.com/2023628#gistcomment-285118  
  194.   
  195. /** 
  196. * 文章字段参数 
  197. */  
  198. //关于文章字段参数信息，请参考http://codex.wordpress.org/Class_Reference/WP_Query#Post_Field_Parameters  
  199.   
  200. /** 
  201. * 过滤器 
  202. */  
  203. //关于过滤器的更多信息，请参考：http://codex.wordpress.org/Class_Reference/WP_Query#Filters  
  204.   
  205. );  
  206.   
  207. $the_query = new WP_Query( $args );  
  208.   
  209. // 循环开始  
  210. if ( $the_query->have_posts() ) :  
  211.     while ( $the_query->have_posts() ) : $the_query->the_post();  
  212.         // 输出内容  
  213.     endwhile;  
  214. endif;  
  215.   
  216. // 重置文章数据  
  217. wp_reset_postdata();  
  218.   
  219. ?>  

The End