无处不在的WordPress的主循环

主循环简介
在WordPress中显示文章内容都是用主循环(The Loop),包括首页、分类页、文章页和搜索结果等其他页面,自定义查询也是用主循环,这个循环挂载了WordPress许多动作和钩子,通过主循环我们不仅可以快捷有效地把内容展示出来,同时别处的代码(如 functions.php 文件)也能通过动作钩子实现修改查询条件或内容。

最常见的主循环(这样的循环在WordPress模板文件中随处可见,如 index.php):

  1. <?php
  2. if (have_posts()) :
  3. while (have_posts()) : the_post();
  4. //~ 在这里使用内容函数,如 the_title();
  5. endwhile;
  6. endif;
  7. ?>

或者首页显示文章的代码一般都是:

  1. <?php if (have_posts()) : ?> 
  2.  <!--检查是否有文章如果有,继续执行,没有就跳到  else 那里-->   
  3. <?php  while (have_posts()) : the_post(); ?> 
  4. <!--开始准备文章内容,开始循环,每次循环输出一篇文章-->   
  5. 此处显示文章内容或标题之类的。。   
  6. <?php  endwhile ; ?>  
  7. <!-- while 循环结束-->   
  8. <?php  else : ?>   
  9. 此处显示未找到文章时的信息,比如404相关   
  10. <?php  endif ; ?>   <!-- if 结束-->

如上代码所示,我们很容易就能看懂其中的原理:WordPress先通过 have_posts() 判断是否有文章,如果有就使用 while 语句循环,然后在循环中通过 the_post() 设置当前文章内容的全局变量,这样我们就可以轻而易举地在循环中使用函数输出内容到浏览器了。

如果你想找没有找到内容的时候显示一个提示,你可以这样:

  1. <?php
  2. if (have_posts()) :
  3. while (have_posts()) : the_post();
  4. //~ 在这里使用内容函数,如 the_title();
  5. endwhile; else :
  6. //~ 在这里放置关于没有找到内容的提示
  7. endif;
  8. ?>

常用函数
在主循环中最常用到的函数:

1、使用 the_ID() 输出文章ID(返回值使用 get_the_ID()
2、使用 the_title() 输出文章标题(返回值使用 get_the_title()
3、使用 the_title_attribute() 输出文章标题属性
4、使用 the_permalink() 输出文章固定链接(返回值使用 get_permalink()
5、使用 the_shortlink() 输出文章短链接(返回值使用 wp_get_shortlink()
6、使用 the_excerpt() 输出文章摘要(返回值使用 get_the_excerpt()
7、使用 the_content() 输出文章内容(返回值使用 get_the_content()
8、使用 the_category() 输出文章分类目录(返回值使用 get_the_category() ,返回分类列表使用 get_the_category_list()
9、使用 the_tags() 输出文章标签(返回值使用 get_the_tags() ,返回标签列表使用 get_the_tag_list())
10、使用 the_meta() 输出文章自定义meta信息
11、使用 the_author() 输出文章作者(返回值使用 get_the_author()
12、使用 the_author_link() 输出文章作者(带链接)(返回值使用 get_the_author_link()
更多函数请浏览WordPress官方的函数参考页面。

写一个循环
好了,既然我们知道WordPress主循环是什么样的了,也知道在循环中应该用什么函数输出内容了,下面就让我们来写一个循环来试试身手吧!

首先,我们写一个归档页的(也可以是首页的)模板,归档的就是文章列表了,文章列表一般都是有一个文章标题(带链接可点击)和一段摘要:

  1. <?php
  2. //~ 载入头部模板
  3. get_header();
  4. //~ 循环开始
  5. if (have_posts()) :
  6. while (have_posts()) : the_post();
  7. ?>
  8.  
  9. <h3><a href="<?php the_permalink();?>" title="<?php the_title_attribute();?>"><?php the_title();?></a></h3>
  10.  
  11. <div><?php the_excerpt();?></div>
  12.  
  13.  <?php
  14. endwhile;
  15. endif;
  16. //~ 载入侧边栏模板
  17. get_sidebar();
  18. //~ 载入底部模板
  19. get_footer();
  20. ?>

好了,我们有一个归档页,接下来就应该是具体内容的文章页了,文章页的标题不需要带链接,但应该展示更多关于这篇文章的内容,如作者、分类、标签等,同时文章内容输出的就不应该是摘要了,而是全部内容。

  1. <?php
  2. //~ 载入头部模板
  3. get_header();
  4. //~ 循环开始
  5. if (have_posts()) :
  6. while (have_posts()) : the_post();
  7. ?>
  8.  
  9. <h3><?php the_title();?></h3>
  10.  
  11. <p>文章作者:<?php the_author_link(); ?></p>
  12.  
  13. <div class="cat">分类:<?php the_category(', ');?></div>
  14.  
  15. <?php the_tags('<div class="tag">标签:', ', ', '</div>' ); ?>
  16.  
  17. <div><?php the_content();?></div>
  18.  
  19. <?php
  20. endwhile;
  21. endif;
  22. //~ 载入侧边栏模板
  23. get_sidebar();
  24. //~ 载入底部模板
  25. get_footer();
  26. ?>

细心的童鞋应该有了新的发现,没错,就是 the_category() the_tags() 有传入参数;其中 the_category() 传入的是一个逗号,显然这是多个分类时的分隔符;而 the_tags() 则传入了三个参数,中间那个逗号显然也是分隔符,而前后两个参数则是添加在标签内容前后的内容;这些函数的具体用法和传入参数都可以在WordPress官方的函数参考中找到。

自定义循环
WordPress常规循环我们都已经了解,包括归档页和文章页(其实无论什么页面,循环都一样,只是循环里显示的内容略有区别而已),接下来,我们来学习稍微高级一点的自定义查询循环。

在WordPress中自定义查询内容我们可以使用 WP_Query 类,不过,还有比这更简单的方法,那就是使用 query_posts() 函数,这个函数是来自 WP_Query 类的封装,所以传入参数完全一样(传入参数官方说明),但用法更简单,代码更简洁。

  1. <?php
  2. //~ 通过 $args 传入查询参数,可以是数组,也可以是文本模式(以key=value格式并以&隔开多个参数)
  3. query_posts( $args );
  4.  
  5. //~ 循环
  6. while ( have_posts() ) : the_post();
  7. //~ 在这里使用内容函数,如 the_title();
  8. endwhile;
  9.  
  10. //~ 循环后使用这个函数重置查询,以防影响其他常规查询
  11. wp_reset_query();
  12. ?>

以下是一个例子(查询最新5篇文章):

  1. <?php
  2. query_posts( 'orderby=date&order=DESC&posts_per_page=5' );
  3.  
  4. 如果要把自定义参数和当前页面预置的查询参数合并起来,你可以这样:
  5.  
  6. <?php
  7. //~ 在预置查询条件的前提下把排序改为升序
  8. global $query_string;
  9. query_posts( $query_string . '&order=ASC' );

改变预置参数
通过 query_posts() 函数我们可以自定义查询条件(一般用来新建自定义查询而不是直接使用在常规查询中),但是有些时候,我们需要更改常规查询的查询条件,如在首页排除某个分类,或者是在搜索结果中排除页面。

对于这样的需求,建议通过 pre_get_posts 动作来实现,如在首页排除ID是1和4的分类,我们只需这样:

  1. function exclude_category( $query ) {
  2. if ( $query->is_home() && $query->is_main_query() ) $query->set( 'cat', '-1,-4' );
  3. }
  4. add_action( 'pre_get_posts', 'exclude_category' );

在搜索结果中只显示文章的结果,我们可以这样:

  1. function search_filter($query) {
  2. if ( !is_admin() && $query->is_main_query() && $query->is_search ) $query->set('post_type', array( 'post' ) );
  3. }
  4. add_action('pre_get_posts','search_filter');

以上只是两个简单的例子,更多用法可以参考

WordPress官方文档关于 pre_get_posts 动作的说明:http://codex.wordpress.org/Plugin_API/Action_Reference/pre_get_posts


发布日期:

所属分类: WordPress 函数 标签: