WordPress 自定义查询WP_Query使用方法大全

  • A+
所属分类:WordPress技巧

自定义调用文章在网站建设中很常用,WordPress 也很人性化,用新建查询 new WP_Query 就能实现相关功能。WP_Query 怎么用呢?

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

WordPress 自定义查询WP_Query使用方法大全

我们知道 wordpress 的主循环

但其实是隐藏了一些参数,比如

两段代码是等效的,为了保持代码的简洁性,WordPress 隐藏了全局的主循环变量 $wp_query

WP_Query 最基础用法

WP_Query 这个万能的文章查询类,有人把 WP_Query 所有的参数做了一个总结,然后注释了一下,供有需要的朋友查阅使用。

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

还有一些例子

调用 id 为 36 的单篇文章的新建查询如下

等同于

调用指定 page 页面或 category 分类页可以用类似的写法

调用 id 为 34、32、30 的文章

post__in 默认调用的是文章信息,如果要调用页面,则需要指定类型

调用除了 id 为 3 以外的文章

调用全部文章

调用全部页面


本文由 云模板 作者:PetitQ 发表,转载请注明来源!

  • 我的微信
  • 这是我的微信扫一扫
  • weinxin
  • 我的微信公众号
  • 我的微信公众号扫一扫
  • weinxin