WP常用函数手册

WordPress加载头部模板函数:get_header

WordPress模板函数get_header用来加载头部模板,即header.php

get_header( string $name = null )

get_header函数默认加载header.php,但可以通过传递一个参数来实现加载类似header-name.php的模板:

<?php get_header('name'); ?>

以上示例加载header-name.php模板,如果header-name.php文件不存在,则加载header.php,这样就为没有header-name.php文件时提供了一个备用选项。

我们可以通过页面判断来为不同页面加载不同的头部模板:

<?php
if ( is_home() ) :
	get_header( 'home' );
elseif ( is_404() ) :
	get_header( '404' );
else :
	get_header();
endif;
?>

以上示例为首页加载header-home.php,为404页面加载header-404.php,其他页面加载header.php

我们还可以为分类和函数页加载不同的头部模板:

<?php
if ( is_category() ) :
	get_header( 'category' );
elseif ( is_tag() ) :
	get_header( 'tag' );
else :
	get_header();
endif;
?>

以上示例为分类页加载header-category.php,为函数页加载header-tag.php

如果你掌握了WordPress条件函数的用法,可以充分发挥你的想像力,定制出个性化的主题。

扩展阅读

get_header()函数位于:wp-includes/general-template.php

相关函数:

  • get_sidebar()
  • get_template_part()
  • get_search_form()
  • comments_template()
  • get_footer()

WordPress条件判断函数详细列表

使用WordPress条件判断函数,可以为特定页面加载不同的模板,灵活运用WordPress条件判断函数可以制作出WordPress图片列表、专题页面、不一样的文章页面等。通常我使用这些条件函数来为不同页面输出不同的关键词函数(Keywords)、描述函数(Description)内容。

WordPress条件判断函数详细列表

主页

is_home()

主页,当前页面为主页时返回True,只有“阅读”设置中的首页显示设置为“最新文章”才返回True

首页

is_front_page()

首页,不管“阅读”设置中的首页显示设置为何值,都返回True。需要注意的是,当首页显示设置为一个静态页面时,你的站点首页加载的是page.php页面模板。

管理员面板

is_admin()

后台,只有处于网站后台时才返回True,通常用于插件开发,因为主题模板总是在前台加载的。

文章页面

is_single()

判断是否为文章页面

is_single(’18’)

ID为18的文章页面

is_single(‘New Post’)

标题为“New Post”的文章页面

is_single(‘new-post’)

别名为“new-post”的文章页面

is_single(array(18,’new-post,’New Post’))

文章ID为18或别名为“new-post”或标题为“New Post”都返回True,也就是只要满足其中一个条件就返回True

文章置顶

is_sticky()

判断当前文章是否置顶,必须用在主循环(Loop)中

is_sticky(’18’)

判断ID为18的文章是否置顶

评论

is_comments_popup()

判断是否为弹出式评论

comments_open()

判断是否允许评论,必须用在主循环中

pings_open()

判断文章 ping 功能是否开启,必须用在主循环中

Page页面

is_page()

判断是否为页面

is_page(‘8’)

ID为8的页面

is_page(‘About Me’)

标题为“About Me”的页面

is_page(‘about-me’)

别名为“about-me”的页面

is_page(array(8,’about-me’,’About Me’))

页面ID为8或别名为“about-me”或标题为“About Me”都返回True,也就是只要满足其中一个条件就返回True

自定义页面模版

is_page_template()

是否自定义页面模板

is_page_template(‘links.php’)

是否自定义页面模板links.php

分类页面

is_category()

判断是否为分类页面

is_category(‘9’)

ID为9的分类页面

is_category(‘WordPress模板函数’)

名称为“WordPress模板函数”的分类页面

is_category(‘wordpress-template-tags’)

别名为“wordpress-template-tags”的分类页面

is_category(array(9,’wordpress-template-tags’,’WordPress模板函数’))

分类ID为9或别名为“wordpress-template-tags”或名称为“WordPress模板函数”都返回True,也就是只要满足其中一个条件就返回True

in_category(‘6’)

如果当前文章在ID为6的分类中,就返回True

函数页面

is_tag()

判断是否为函数页面

is_tag(‘wordpress-template-tags’)

别名为“wordpress-template-tags”的函数页面

is_tag(array(‘wordpress-template-tags’,’html’,’css’))

如果当前函数页面的别名是“wordpress-template-tags”或“html”或“css”都返回True

has_tag()

判断当前文章是否有函数,必须用在主循环中。

has_tag(‘wordpress-template-tags’)

判断当前文章是否有一个函数“wordpress-template-tags”

has_tag(array(‘wordpress-template-tags’,’html’,’css’))

作者页面

is_author()

判断是否作者页面

is_author(‘2’)

ID为2的作者页面

is_author(‘Jack’)

昵称为“Jack”的作者页面,也可以使用姓名作为参数

is_author(array(2,’john-jones’,’Jack’))

ID为2或昵称为“Jack”或姓名为“john-jones”都会返回True

日期页面

is_date()

判断是否日期归档页面

is_year()

判断当前页面是否为按年份存档的页面

is_month()

判断当前页面是否为按月份存档的页面

is_day()

判断当前页面是否为按日期存档的页面

is_time()

判断当前页面是否为按照小时、分钟、秒存档的页面

存档页面

is_archive()

判断是否存档页面,包括分类、函数、作者页面、日期存档页面等

搜索结果页面

is_search()

判断是否搜索结果页

404页面

is_404()

判断当前页面是否带有“HTTP 404:Not Found”错误

分页页面

is_paged()

存档页面的分页,不包括通过<!–nextpage–>拆分的页面

附件页面

is_attachment()

判断是否为附件页面

是否为文章页、页面或附件

is_singular()

只要is_single()、is_page()、is_attachment()返回True,此函数就返回True

订阅

is_feed()

判断是否在订阅输出的页面

引用通告

is_trackback()

判断是否开启了Trackback功能

是否为预览

is_preview()

判断是否在预览页面

是否有摘要

has_excerpt()

判断当前文章或页面是否有摘要,这个函数很有用,可以帮助我们设置描述函数为摘要内容

has_excerpt(’28’)

判断ID为28的文章是否有摘要

是否在循环内

in_the_loop()

判断是否在主循环(Loop)中

侧边栏是否激活

is_active_sidebar()

判断侧边栏是否激活,需要将侧边栏的标识传递进去

WordPress加载侧边栏模板函数:get_sidebar

WordPress模板函数get_sidebar用于加载侧边栏模板,即sidebar.php

get_sidebar( string $name = null )

get_sidebar函数默认加载sidebar.php,但可以通过传递一个参数来实现加载类似sidebar-name.php的模板:

<?php get_sidebar('name'); ?>

以上示例加载sidebar-name.php,如果sidebar-name.php文件不存在,则加载sidebar.php

对于三栏布局,我们需要两个侧边栏,分别为sidebar-left.php和sidebar-right.php,相应的代码如下:

<?php get_header(); ?>
<?php get_sidebar( 'left' ); ?>
<?php get_sidebar( 'right' ); ?>
<?php get_footer(); ?>

get_sidebar函数的用法与get_header函数是一样的,更多用法请阅读:

WordPress模板函数:get_header

扩展阅读

get_sidebar()函数位于:wp-includes/general-template.php

相关函数:

  • get_header()
  • get_template_part()
  • get_search_form()
  • comments_template()
  • get_footer()

WordPress加载评论模板函数:comments_template

WordPress模板函数comments_template首先会尝试加载评论模板comments.php,如果comments.php不存在,则输出默认的评论区HTML

comments_template( string $file = '/comments.php', bool $separate_comments = false )

函数参数

$file

字符串值,可选,默认值为/comments.php

可以指定需要加载的评论模板,而不必是comments.php

$separate_comments

布尔值,可选,默认值为false

是否根据评论类型来输出评论,几乎用不到。

comments_template函数通常用在single.php和page.php的主循环中,用来输出评论列表以及评论表单。

扩展阅读

comments_template()函数位于:wp-includes/comment-template.php

相关函数:

  • get_header()
  • get_sidebar()
  • get_template_part()
  • get_search_form()
  • get_footer()

WordPress加载搜索表单函数:get_search_form

WordPress模板函数get_search_form用于加载搜索表单,首先会尝试加载模板文件searchform.php,如果该文件不存在,则输出默认的搜索表单HTML。

get_search_form( bool $echo = true )

函数参数

$echo

布尔值,默认为true,即输出表单内容,如果为false,则只返回结果而不输出。

get_search_form默认输出XHTML版本的函数,如果要输出HTML5版本的函数,需要在主题文件中加入以下代码:

add_theme_support( 'html5', array(
	'search-form',
) );

XHTML版本的输出结果如下:

<form role="search" method="get" id="searchform" class="searchform" action="https://www.beizigen.com/">
	<div>
		<label class="screen-reader-text" for="s">搜索:</label>
		<input type="text" value="" name="s" id="s" />
		<input type="submit" id="searchsubmit" value="搜索" />
	</div>
</form>

HTML5版本的输出结果如下:

<form role="search" method="get" class="search-form" action="https://www.beizigen.com/">
	<label>
		<span class="screen-reader-text">搜索:</span>
		<input type="search" class="search-field" placeholder="搜索&hellip;" value="" name="s" />
	</label>
	<input type="submit" class="search-submit" value="搜索" />
</form>

扩展阅读

get_search_form()函数位于:wp-includes/general-template.php

相关函数:

  • get_header()
  • get_sidebar()
  • get_template_part()
  • comments_template()
  • get_footer()

WordPress加载自定义模板函数:get_template_part

WordPress模板函数get_template_part用来加载自定义模板文件

get_template_part( string $slug, string $name = null )

通常情况下,分类、函数、搜索结果页输出最新文章列表的代码是一样的,因此将这些代码放到一个名为loop.php的文件中,再在这些模板中使用get_template_part()函数来加载loop.php,可以最大化代码重用,也方便更新维护。

<?php get_template_part( 'loop' ); ?>

也可以加载loop-pic.php之类的模板

<?php get_template_part( 'loop', 'pic' ); ?>

以上示例当loop-pic.php不存在时,则加载loop.php

函数参数

$slug

字符串值,必须

模板的统一名称,即“-”前的名称,以content-pic.php为例,$slug应该是content

$name

字符串值,可选

模板的子名称,即“-”后的名称,以content-pic.php为例,$name应该是pic

扩展阅读

get_template_part()函数位于:wp-includes/general-template.php

相关函数:

  • get_header()
  • get_sidebar()
  • get_search_form()
  • comments_template()
  • get_footer()

WordPress输出博客信息函数:bloginfo

WordPress模板函数bloginfo用于输出博客的一些信息,例如博客名称、博客URL、博客描述、WordPress版本等等,几乎每个主题都会用到。

bloginfo( string $show = '' )

函数参数

$show

字符串值,可选,默认值为空

bloginfo()函数参数的可用值有点多,详细如下列表:

虽然bloginfo()可选的参数值有点多,常用的也就那么几个。

函数使用示例

输出网站标题:

<h2><?php bloginfo( 'name' ); ?></h2>

输出带首页链接的网站标题:

<h2 class="site-title"><a href="<?php echo esc_url( home_url( '/' ) ); ?>" rel="home"><?php bloginfo( 'name' ); ?></a></h2>

输出副标题:

<p><?php bloginfo('description'); ?></p>

扩展阅读

bloginfo()函数位于:wp-includes/general-template.php

相关函数:

  • bloginfo_rss()
  • get_bloginfo()
  • get_bloginfo_rss()

WordPress加载页脚模板函数:get_footer

WordPress模板函数get_footer用来加载页脚模板,即footer.php

get_footer( string $name = null )

get_footer函数默认加载footer.php,但可以通过传递一个参数来加载类似footer-name.php的文件

<?php get_footer('name'); ?>

以上示例加载footer-name.php,如果footer-name.php不存在,则加载footer.php

get_footer函数的用法与get_header函数是一样的,更多用法请阅读:

WordPress模板函数:get_header

扩展阅读

get_footer()函数位于:wp-includes/general-template.php

相关函数:

  • get_header()
  • get_sidebar()
  • get_template_part()
  • get_search_form()
  • comments_template()

WordPress获取博客信息函数:get_bloginfo

WordPress模板函数get_bloginfo用于获取博客的一些信息,与bloginfo()的用法基本一样,区别在于get_bloginfo()只返回相应的值而不是直接输出。

get_bloginfo( string $show = '', string $filter = 'raw' )

事实上,bloginfo()函数等效于:

<?php echo get_bloginfo( $show, 'display' ); ?>

函数参数

$show

字符串值,可选

要了解该参数的值,请阅读:WordPress模板函数:bloginfo

$filter

字符串值,可选,默认值为:raw

是否允许add_filter过滤,如果为display,当$show包含url或directory或home时,可以使用bloginfo_url钩子来过滤get_bloginfo()的输出结果,$show为其他值时,可以使用bloginfo钩子来过滤。

因此可以看出,bloginfo()输出的值可能会被插件、主题过滤修改,而get_bloginfo()可以不被过滤,这也是它们的一个不同之处。

扩展阅读

get_bloginfo()函数位于:wp-includes/general-template.php

相关函数:

  • bloginfo()
  • bloginfo_rss()
  • get_bloginfo_rss()

WordPress在RSS页面输出博客信息函数:bloginfo_rss

WordPress模板函数bloginfo_rss用于输出博客的一些信息,用法与bloginfo()完全一样

bloginfo_rss( string $show = '' )

事实上,bloginfo_rss等效于:

<?php echo strip_tags(get_bloginfo($show)); ?>

与bloginfo()相比较,bloginfo_rss()用strip_tags()函数剥去了字符串中的HTML、XML以及PHP函数

要了解bloginfo_rss()函数的参数值,请阅读:WordPress模板函数:bloginfo

扩展阅读

bloginfo_rss()函数位于:wp-includes/feed.php

相关函数:

  • bloginfo()
  • get_bloginfo()
  • get_bloginfo_rss()

WordPress作者列表函数:wp_list_authors

WordPress模板函数wp_list_authors输出用户列表,并给出用户页面链接,默认以

  • 列表输出。
    wp_list_authors( string|array $args = '' )
    

    函数参数

    $args

    数组或字符串值

    wp_list_authors()函数$args参数默认的值如下:

    $args = array(
    	'orderby'		=> 'name', 
    	'order'			=> 'ASC', 
    	'number'		=> null,
    	'optioncount'	=> false, 
    	'exclude_admin'	=> true, 
    	'show_fullname'	=> false,
    	'hide_empty'	=> true,
    	'echo'			=> true,
    	'feed'			=> [empty string], 
    	'feed_image'	=> [empty string],
    	'feed_type'		=> [empty string],
    	'style'			=> 'list',
    	'html'			=> true,
    	'exclude'		=> [empty string],
    	'include'		=> [empty string]
    );
    

    wp_list_authors()函数$args参数可用的值如下:

    orderby

    字符串值,默认值:name

    指定输出的用户列表以哪个字段排列顺序

    • name:以users表display_name字段排列顺序,也就是用户资料“公开显示为”
    • email:以用户邮件地址排列
    • url:以用户网址排列
    • registered:以注册日期排列
    • id:以用户ID排列
    • user_login:以用户登录账号排列
    • post_count:以用户发表的文章数量排列

    order

    字符串值,默认值:ASC

    指定输出的用户列表的排序方式

    • ASC:升序
    • DESC:降序

    number

    整数型

    指定要输出的用户数量

    optioncount

    布尔值,默认值:false

    是否显示作者发表的文章总数

    • 1(true):显示作者发表的文章总数
    • 0(false):不显示作者发表的文章总数

    exclude_admin

    布尔值,默认值:true

    排除名称为“admin”的用户,只有用户资料设置中“公开显示为”的名称为“admin”才被排除

    • 1(true):排除“admin”用户
    • 0(false):不排除“admin”用户

    show_fullname

    布尔值,默认值:false

    显示用户的姓名而不是用户资料设置“公开显示为”中指定的名称

    • 1(true):显示
    • 0(false):不显示,此时显示用户资料设置“公开显示为”中设定的名称

    hide_empty

    布尔值,默认值:true

    是否隐藏没有发表过文章的用户

    • 1(true):隐藏
    • 0(false):显示

    feed

    字符串值,默认为空

    提供一个文本作为用户feed链接的锚文本,默认不显示用户feed链接

    feed_image

    字符串值,默认为空

    提供一个图片的路径作为用户feed链接图片,并且会覆盖feed的设置

    feed_type

    字符串值,默认为空

    feed的类型,可选的值有:

    • -:默认值
    • rss2
    • atom
    • rss
    • rdf

    style

    字符串值,默认值:list

    输出用户列表的HTML函数类型

    • list:以
    • 列表输出,不包括
        函数
    • none:只输出链接,没有
    • 函数,每个链接之间用逗号分隔

    html

    布尔值,默认值:true

    是否输出HTML函数,如果为false,只输出文本,不同用户之前用逗号分隔

    exclude

    数组

    要排除的用户ID,例如:array(1,6,9)

    include

    数组

    要显示的用户ID,例如:array(1,3,5)

    函数使用示例

    显示10个用户,并排除ID为1的用户,通常管理员的ID为1,同时即使没有发表过文章的用户也显示出来

    <?php
    	$args = array(
    		'number' => 10,
    		'exclude' => array(1),
    		'hide_empty' => false
    	);
    	wp_list_authors($args);
    ?>
    

    下面的写法也是一样的效果:

    <?php wp_list_authors('number=10&exclude=1&hide_empty=0'); ?>
    

    不同之处在于,true写成了1,false写成了0

    如果要排除多个用户,则这样写:

    <?php wp_list_authors('number=10&exclude=1,2,3&hide_empty=0'); ?>
    

    扩展阅读

    wp_list_authors()函数位于:wp-includes/author-template.php

    相关函数:

    • the_author()
    • get_the_author()
    • get_the_author_id()
    • the_author_link()
    • get_the_author_link()
    • the_author_meta()
    • get_the_author_meta()
    • the_author_posts()
    • get_the_author_posts()
    • the_author_posts_link()
    • get_author_posts_url()
    • get_the_modified_author()
    • the_modified_author()
    • wp_dropdown_users()

    WordPress在RSS页面获取博客信息函数:get_bloginfo_rss

    WordPress模板函数get_bloginfo_rss用于输出博客的一些信息,用法与get_bloginfo()基本相同,与bloginfo_rss()相比较,get_bloginfo_rss()只返回结果而不是输出。

    get_bloginfo_rss( string $show = '' )
    

    事实上,get_bloginfo_rss等效于:

    <?php strip_tags(get_bloginfo($show)); ?>
    

    与get_bloginfo()相比较,get_bloginfo_rss()用strip_tags()函数剥去了字符串中的HTML、XML以及PHP函数

    要了解get_bloginfo_rss()函数的参数值,请阅读:WordPress模板函数:bloginfo

    扩展阅读

    get_bloginfo_rss()函数位于:wp-includes/feed.php

    相关函数:

    • bloginfo()
    • bloginfo_rss()
    • get_bloginfo()

    WordPress友情链接列表函数:wp_list_bookmarks

    WordPress模板函数wp_list_bookmarks用于输出博客的友情链接,虽然小工具里已经有了链接功能,但wp_list_bookmarks()函数可以让我们的主题开发更灵活。

    wp_list_bookmarks( array|string $args = '' )
    

    函数参数

    $args

    数组或字符串值

    wp_list_bookmarks()函数$args参数默认的值如下:

    $args = array(
    	'orderby'          => 'name',
    	'order'            => 'ASC',
    	'limit'            => -1,
    	'category'         => ' ',
    	'exclude_category' => ' ',
    	'category_name'    => ' ',
    	'hide_invisible'   => 1,
    	'show_updated'     => 0,
    	'echo'             => 1,
    	'categorize'       => 1,
    	'title_li'         => __('Bookmarks'),
    	'title_before'     => '<h2>',
    	'title_after'      => '</h2>',
    	'category_orderby' => 'name',
    	'category_order'   => 'ASC',
    	'class'            => 'linkcat',
    	'category_before'  => '<li id=%id class=%class>',
    	'category_after'   => '</li>'
    );
    

    wp_list_bookmarks()函数$args参数可用的值如下:

    categorize

    布尔值,默认值:1

    友情链接是否显示在相应的分类下。

    category

    字符串值,默认为空

    指定友情链接的分类ID,多个分类ID用逗号分隔。

    exclude_category

    字符串值,默认为空

    要排除的友情链接分类ID,多个ID用逗号分隔,默认不排除任何分类。

    category_name

    字符串值,默认为空

    要显示的友情链接分类的名称

    category_before

    字符串值,默认值:

  • 在每个友情链接分类前添加一个字符串

    category_after

    字符串值,默认值:

  • 在每个友情链接分类后添加一个字符串

    class

    字符串值,默认值:linkcat

    如果category_before为默认值,则该li元素会有一个名为linkcat的类,可以通过class的值修改这个类名。

    category_orderby

    字符串值,默认值:name

    友情链接的分类排序

    • name:以友情链接分类名称排序
    • id:以友情链接分类ID排序
    • slug:以友情链接的分类别名排序
    • count:以友情链接分类下的链接数量排序
    • term_group:暂时还没有使用

    category_order

    字符串值,默认值:ASC

    友情链接分类排序顺序

    • ASC:升序
    • DESC:降序

    title_li

    字符串值,默认值:Bookmarks

    友情链接列表的标题

    title_before

    字符串值,默认值:

    当categorize为1时,title_before指定友情链接分类名称前的字符,当categorize为0时title_before没有作用。

    title_after

    字符串值,默认值:

    当categorize为1时,title_after指定友情链接分类名称后的字符,当categorize为0时title_after没有作用。

    show_private

    布尔值,默认值:0

    是否显示私密的链接分类,但我在后台并没有找到链接分类的私密设置选项,虽然链接可以设置为私密链接,但show_private的值并不影响私密链接的输出,影响私密链接输出的参数是hide_invisible,下面会介绍。

    include

    字符串值,默认为空

    要显示的链接ID,多个ID用逗号分隔。如果该参数不为空,请将categorize设置为0,因为我在测试中发现,如果为include指定了值,那么每个链接分类下都会输出相同的链接。

    exclude

    字符串值,默认为空

    要排除的链接ID,多个ID用逗号分隔,此参数没有include的问题。

    orderby

    字符串值,默认值:name

    友情链接的排序方式

    • link_id:友情链接的ID
    • url:按链接的URL排序
    • name:友情链接的名称
    • target:按“目标”设置排序
    • description:按描述排序
    • owner:按添加链接的用户排序
    • rating:按评分排序
    • updated:按更新时间排序,由于这个更新时间并不是指本地修改的时间,而是基于pingomatic的更新,一般这个时间都是:0000-00-00 00:00:00,所以按updated排序没有任何意义。
    • rel:按链接关系(XFN)排序
    • notes:按备注排序
    • rss:按RSS地址排序
    • length:按链接名称的长度排序
    • rand:随机排序

    order

    字符串值,默认值:ASC

    友情链接的排序顺序

    • ASC:升序
    • DESC:降序

    limit

    整数型,默认值:-1

    要显示的链接数量,默认显示所有链接。

    before

    字符串值,默认值:

  • 默认情况下链接是以
  • 列表输出的,即之前的字符。after

    字符串值,默认值:

  • 之后的字符

    link_before

    字符串值,默认为空

    在链接锚文本的前面添加字符

    link_after

    字符串值,默认为空

    在链接锚文本的后面添加字符

    between

    字符串值,默认值:n

    当show_description为1时,也就是链接描述显示时,between的值将在描述前输出,默认为换行

    show_images

    布尔值,默认值:1

    是否显示链接图像,默认显示,如果为0,则显示链接名称而不是图像。

    show_description

    布尔值,默认值:0

    是否显示链接描述,默认不显示

    show_name

    布尔值,默认值:0

    是否显示链接的名称

    show_rating

    布尔值,默认值:0

    是否显示链接的评分

    show_updated

    布尔值,默认值:0

    是否显示链接更新时间,由于这个更新时间并不是指本地修改的时间,而是基于pingomatic的更新,一般这个时间都是:0000-00-00 00:00:00,所以没有任何输出。

    hide_invisible

    布尔值,默认值:1

    是否隐藏私密链接,默认隐藏,设置为0私密链接也会被显示出来。

    echo

    布尔值,默认值:1

    是否输出结果,如果为0,只返回结果而不输出。

    函数使用示例

    不按分类输出5个文字链接(不显示链接图像),并且不显示列表标题。

    <ul>
        <?php 
    		$args = array(
    			'categorize' => 0,
    			'title_li' => '',
    			'limit' => 5,
    			'show_images' => 0,
    		);
    		wp_list_bookmarks($args);
    	?>
    </ul>
    

    下面的代码输出一样的结果:

    <ul>
    	<?php wp_list_bookmarks('categorize=0&title_li=&limit=5&show_images=0'); ?> 
    </ul>
    

    本站的友情链接页面代码:

    <ul>
    	<?php wp_list_bookmarks('title_li=0&categorize=0&orderby=link_id&show_description=1&show_images=0&between=:'); ?>
    </ul>
    

    扩展阅读

    wp_list_bookmarks()函数位于:wp-includes/bookmark-template.php

    相关函数:

    • get_bookmark()
    • get_bookmark_field()
    • get_bookmarks()

    WordPress页面列表函数:wp_list_pages

    WordPress模板函数wp_list_pages用于输出页面列表,通常用在导航或企业模板的侧边栏。

    wp_list_pages( array|string $args = '' )
    

    函数参数

    $args

    数组或字符串值

    wp_list_pages()函数$args参数默认的值如下:

    $args = array(
    	'depth'			=> 0,
    	'show_date'		=> '',
    	'date_format'	=> get_option( 'date_format' ),
    	'child_of'		=> 0,
    	'exclude'		=> '',
    	'title_li'		=> __( 'Pages' ),
    	'echo'			=> 1,
    	'authors'		=> '',
    	'sort_column'	=> 'menu_order, post_title',
    	'link_before'	=> '',
    	'link_after'	=> '',
    	'walker'		=> '',
    );
    

    wp_list_pages()函数$args参数可用的值如下:

    child_of

    整数型,默认值:0

    指定一个页面ID,将输出该页面的子页面,不包含该页面。

    authors

    字符串值,默认为空

    作者ID,多个ID用逗号分隔,只有指定的作者发表的页面才被显示,默认显示所有作者发表的页面。

    date_format

    字符串值,默认为后台常规设置中的日期格式

    当show_date的值不为空时,也就是显示页面发表或修改日期,date_format指定该日期的格式

    depth

    整数型,默认值:0

    • 0:输出所有的页面和子页面,按层级的方式输出;
    • 1:只输出顶级页面,不包含任何子页面;
    • n:根据n的具体数字来显示相应等级的页面;
    • -1:输出所有的页面和子页面,不以层级的方式输出;

    echo

    布尔值,默认值:1

    是否输出结果,如果为0,只返回结果而不输出。

    exclude

    字符串值,默认为空

    要排除的页面ID,多个ID用逗号分隔。

    include

    字符串值,默认为空

    要显示的页面ID,多个ID用逗号分隔,默认显示所有页面。

    link_after

    字符串值,默认为空

    追加字符到链接锚文本的后面,即的前面。

    link_before

    字符串值,默认为空

    追加字符到链接锚文本的前面,即紧跟标记。

    post_type

    字符串值,默认值:page

    文章类型,暂时没有发现用处

    post_status

    字符串值,默认值:publish

    按页面的状态来显示,默认只显示已发表的页面

    • publish:已发表的页面
    • trash:回收站中的页面
    • private:私密
    • auto-draft:自动草稿
    • draft:草稿

    show_date

    字符串值,默认为空

    传递任意值将显示页面的发表日期,显示的日期格式由date_format决定。

    • modified:显示页面的修改日期
    • 任意值:显示页面的发表日期,例如:created

    sort_column

    字符串值,默认值:menu_order, post_title

    指定页面列表的排序方式,多个值用逗号分隔

    • post_author:按作者排序
    • post_date:按发表日期排序
    • post_title:按页面标题排序
    • post_name:按页面别名排序
    • post_modified:按修改日期排序
    • post_modified_gmt:按修改日期排序,与上面的post_modified不同之处在于这里是格林时间
    • menu_order:按页面设置中的“排序”
    • post_parent:按父页面排序
    • ID:按页面ID排序
    • rand:随机排序
    • comment_count:按评论数量排序

    sort_order

    字符串值,默认值:ASC

    页面列表的排序顺序

    • ASC:升序排列;
    • DESC:降序排列;

    title_li

    字符串值,默认值:Pages

    提供一个字符串作为页面列表的标题,不需要标题可以传递一个空值。

    walker

    用于列表页的实例,默认为空,参考Walker_Page

    函数使用示例

    排除ID为4、23的页面,显示发表日期并按发表日期的降序排列

    <ul>
        <?php 
    		$args = array(
    			'show_date' => 'created',
    			'sort_column' => 'post_date',
    			'sort_order'=> 'DESC',
    			'exclude' => '4,23',
    		);
    		wp_list_pages($args);
    	?> 
    </ul>
    

    下面的代码输出同样的结果:

    <ul>
    	<?php wp_list_pages('show_date=created&sort_column=post_date&sort_order=DESC&exclude=4,23'); ?> 
    </ul>
    

    一个比较有用的例子,如果当前页面为子页面,则输出它的兄弟页面,否则输出顶级页面:

    <?php
    	if( $post->post_parent ) {
    		$pages = wp_list_pages( array(
    			'title_li' => '',
    			'child_of' => $post->post_parent,
    			'echo'     => 0
    		) );
    	} else {
    		$pages = wp_list_pages( array(
    			'title_li' => '',
    			'echo' => 0,
    			'depth' => 1,
    		) );
    	}
    ?>
    <ul>
    	<?php echo $pages; ?>
    </ul>
    

    扩展阅读

    wp_list_pages()函数位于:wp-includes/post-template.php

    相关函数:

    • wp_page_menu()
    • wp_dropdown_pages()

    WordPress分类列表函数:wp_list_categories

    WordPress模板函数wp_list_categories用于输出分类列表,通常在导航栏需要用到

    wp_list_categories( string|array $args = '' )
    

    函数参数

    $args

    数组或字符串值

    wp_list_categories()函数$args参数默认的值如下:

    $args = array(
    	'child_of'            => 0,
    	'current_category'    => 0,
    	'depth'               => 0,
    	'echo'                => 1,
    	'exclude'             => '',
    	'exclude_tree'        => '',
    	'feed'                => '',
    	'feed_image'          => '',
    	'feed_type'           => '',
    	'hide_empty'          => 1,
    	'hide_title_if_empty' => false,
    	'hierarchical'        => true,
    	'order'               => 'ASC',
    	'orderby'             => 'name',
    	'separator'           => '<br />',
    	'show_count'          => 0,
    	'show_option_all'     => '',
    	'show_option_none'    => __( 'No categories' ),
    	'style'               => 'list',
    	'taxonomy'            => 'category',
    	'title_li'            => __( 'Categories' ),
    	'use_desc_for_title'  => 1,
    );
    

    wp_list_categories()函数$args参数可用的值如下:

    child_of

    整数型,默认值:0

    指定一个分类ID,将输出该分类下的子分类,但不包括该分类。

    current_category

    整数型或数组,默认值:0

    默认情况下,当前分类会有一个名为current-cat的class,以本站为例,当点击“开发”这个分类转到“开发”分类页面,那么“开发”这个li元素就有一个名为current-cat的class,便于我们设置CSS样式。

    如果这个参数指定了一个或多个分类ID,那么始终为指定的这些分类li元素添加一个名为current-cat的class,而当前分类不会再有current-cat这个class

    depth

    整数型,默认值:0

    • 0:输出所有的分类和子分类;
    • 1:只输出顶级分类,不包含任何子分类;
    • n:根据n的具体数字来显示相应等级的分类;
    • -1:输出所有的分类和子分类,不论hierarchical的值是多少,都不以层级的方式输出;

    echo

    布尔值,默认值:1

    默认直接输出分类列表,如果为0则只返回结果而不输出。

    exclude

    数组或字符串,默认为空

    要排除的分类ID,如果为字符串值时,多个分类ID用逗号分隔。如果hierarchical为true,则相应的子分类也会被排除。

    exclude_tree

    数组或字符串,默认为空

    要排除的分类ID,不管hierarchical为何值,相应的子分类都会被排除。

    feed

    字符串值,默认为空

    分类feed链接的锚文本,默认不显示feed链接。

    feed_image

    字符串值,默认为空

    提供一个图片的URL,将用这个图片作为feed的链接

    feed_type

    字符串值,默认为空

    指定feed的类型

    hide_empty

    布尔值,默认值:1

    是否隐藏没有文章的分类,默认隐藏,为0则会显示没有文章的分类。如果分类是以层级的方式显示的,那么只要子分类下有文章,父分类都会显示。

    hide_title_if_empty

    布尔值,默认值:false

    在没有分类目录时,是否隐藏标题“分类目录”,默认无论何时都显示标题“分类目录”

    hierarchical

    布尔值,默认值:true

    默认情况下,以层级的方式输出所有父分类和子分类,也就是说子分类被嵌套在父分类的

  • 里。order

    字符串值,默认值:ASC

    分类的排序顺序

    • ASC:升序排列;
    • DESC:降序排列;

    orderby

    字符串值,默认值:name

    以何种方式排序

    • ID:分类的ID
    • name:分类名称
    • slug:分类别名
    • count:文章数量
    • term_group

    separator

    字符串值,默认值:

    当style的值为none时,以什么标记来分隔分类链接,默认

    show_count

    布尔值,默认值:0

    是否显示分类下的文章数量,默认不显示

    show_option_all

    字符串值,默认为空

    提供一个文本作为“所有链接”的锚文本,也就是在链接列表的开始处添加一个“所有链接”的

  • 项。show_option_none

    字符串值,默认值:No categories

    当没有分类目录时要显示的文本

    style

    字符串值,默认值:list

    分类列表以何种HTML函数输出

    • list:以
    • 列表输出
    • none:仅输出链接,链接之间的标记由separator的值决定,默认为

    taxonomy

    字符串值,默认值:category

    要返回的分类法名称

    title_li

    字符串值,默认值:Categories

    设置列表的标题,一般情况下我们在导航栏输出分类列表都不需要标题,因此可以传递一个空值。

    use_desc_for_title

    布尔值,默认值:1

    是否将分类的描述作为a函数的title属性值,为了列表干净,可以传递一个空值

    函数使用示例

    以分类的文章总数降序排列,显示分类的文章数量,并排除ID为1的分类

    <ul>
        <?php wp_list_categories( array(
            'orderby' => 'count',
    		'order' => 'DESC',
            'show_count' => true,
            'exclude' => array( 1 )
        ) ); ?> 
    </ul>
    

    下面的代码输出同样的结果:

    <ul>
        <?php wp_list_categories('orderby=count&order=DESC&show_count=1&exclude=1'); ?> 
    </ul>
    

    扩展阅读

    wp_list_categories()函数位于:wp-includes/category-template.php

    相关函数:

    • wp_dropdown_categories()
    • walk_category_tree()

    WordPress页面菜单函数:wp_page_menu

    WordPress模板函数wp_page_menu与wp_list_pages()非常相似,都是用于输出页面列表。最大的不同之处在于,wp_page_menu()输出的页面列表被放置在一个类名为menu的DIV内,可见wp_page_menu()主要用于菜单的输出。

    wp_page_menu( array|string $args = '' )
    

    函数参数

    $args

    数组或字符串值

    wp_page_menu()函数$args参数默认的值如下:

    $args = array(
    	'depth'       => 0,
    	'sort_column' => 'menu_order, post_title',
    	'menu_class'  => 'menu',
    	'include'     => '',
    	'exclude'     => '',
    	'echo'        => true,
    	'show_home'   => false,
    	'link_before' => '',
    	'link_after'  => ''
    );
    

    wp_page_menu()函数$args参数可用的值如下:

    depth

    整数型,默认值:0

    • 0:输出所有的页面和子页面,按层级的方式输出;
    • 1:只输出顶级页面,不包含任何子页面;
    • n:根据n的具体数字来显示相应等级的页面;
    • -1:输出所有的页面和子页面,不以层级的方式输出;

    sort_column

    字符串值,默认值:menu_order, post_title

    排序方式,可以是wp_posts表的任何字段

    • post_title:页面标题
    • menu_order:页面排序编号
    • post_date:页面发表日期
    • post_modified:页面修改日期
    • ID:页面ID
    • post_author:作者
    • post_name:页面别名

    menu_class

    字符串值,默认值:menu

    包裹页面列表的DIV容器的类名

    include

    字符串值,默认为空

    指定要显示的页面的ID,多个ID用逗号分隔,默认显示所有页面。

    exclude

    字符串值,默认为空

    要排除的页面ID,多个ID用逗号分隔。

    exclude_tree

    字符串值,默认为空

    要排除的页面ID,多个ID用逗号分隔,连同子页面一起排除。

    echo

    布尔值,默认值:1

    是否输出结果,如果为0,只返回结果而不输出。

    show_home

    布尔值,默认值:0

    是否显示首页链接,默认不显示。

    link_before

    字符串值,默认为空

    在链接锚文本前添加字符

    link_after

    字符串值,默认为空

    在链接锚文本后添加字符

    函数使用示例

    只显示顶级页面,并显示首页的链接

    <?php
    	$args = array(
    		'depth'       => 1,
    		'show_home'   => true,
    	);
    	wp_page_menu($args);
    ?>
    

    下面的代码输出一样的结果:

    <?php wp_page_menu('depth=1&show_home=1'); ?>
    

    扩展阅读

    wp_page_menu()函数位于:wp-includes/post-template.php

    相关函数:

    • wp_list_pages()
    • wp_dropdown_pages()

    WordPress归档列表函数:wp_get_archives

    WordPress模板函数wp_get_archives用于显示一个基于日期的归档列表,这个函数可以用在任何模板,通常用来制作一个日期归档页。

    wp_get_archives( array|string $args = '' )
    

    函数参数

    $args

    数组或字符串值

    wp_get_archives()函数$args参数默认的值如下:

    $args = array(
    	'type'				=> 'monthly',
    	'limit'				=> '',
    	'format'			=> 'html', 
    	'before'			=> '',
    	'after'				=> '',
    	'show_post_count'	=> false,
    	'echo'				=> 1,
    	'order'				=> 'DESC',
    	'post_type'			=> 'post'
    );
    

    wp_get_archives()函数$args参数可用的值如下:

    type

    字符串值,默认值:monthly

    归档的方式,以年、月、日、周等归档

    • yearly:按年份归档
    • monthly:按月份归档
    • daily:按天归档
    • weekly:按周归档
    • postbypost:按发表日期列出所有文章
    • alpha:按文章标题排序列出所有文章

    limit

    整数型,默认为空

    显示的数量,默认为无限

    format

    字符串值,默认值:html

    以何种HTML函数输出内容,默认以

  • 列表输出。
    • html:以
    • 列表输出;
    • option:以输出,需要自己添加
    • link:以函数输出,rel值为archives;
    • custom:自定义包裹链接的函数,将使用before和after定义的值;

    before

    字符串值,默认为空

    当format的值为custom时,before的值将在链接前输出,即包裹链接的开始函数。

    after

    字符串值,默认为空

    当format的值为custom时,after的值将在链接后输出,即包裹链接的开始函数。

    show_post_count

    布尔值,默认值:false

    显示文章数量,type的值不为postbypost或alpha时。

    echo

    布尔值,默认值:1

    是否输出结果,如果为0则只返回结果而不是输出。

    order

    字符串值,默认值:ASC

    排序方式

    • ASC:升序
    • DESC:降序

    post_type

    字符串值,默认值:post

    文章类型

    函数使用示例

    按年份输出归档,并显示文章数量

    <?php
    	$args = array(
    		'type' => 'yearly',
    		'show_post_count' => true
    	);
    	wp_get_archives( $args );
    ?>
    

    下面的代码输出一样的结果:

    <?php wp_get_archives( 'type=yearly&show_post_count=1' ); ?>
    

    扩展阅读

    wp_get_archives()函数位于:wp-includes/general-template.php

    WordPress评论列表函数:wp_list_comments

     

    WordPress模板函数wp_list_comments用于输出评论列表,需要用在评论模板comments.php中。

    wp_list_comments( array|string $args = '', array $comments = null )
    

    函数参数

    $args

    数组或字符串值,可选

    wp_list_comments()函数$args参数默认的值如下:

    $args = array(
    	'walker'            => null,
    	'max_depth'         => '',
    	'style'             => 'ul',
    	'callback'          => null,
    	'end-callback'      => null,
    	'type'              => 'all',
    	'reply_text'        => 'Reply',
    	'page'              => '',
    	'per_page'          => '',
    	'avatar_size'       => 32,
    	'reverse_top_level' => null,
    	'reverse_children'  => '',
    	'format'            => 'html5',
    	'short_ping'        => false,
    	'echo'              => true
    );
    

    $comments

    数组,可选,默认值:get_comments()函数返回的值

    参数可用的值

    wp_list_comments()函数$args参数可用的值如下:

    walker

    对象,默认值:null

    提供一个自定义的类用于输出自己的评论列表HTML,参考Walker_Comment()

    max_depth

    整数型,默认为空

    评论嵌套多少层,如果不传递任何值,即默认的空值,那么将使用后台讨论设置中的嵌套层数设置。

    • 空:使用后台讨论设置中的嵌套层数设置,如果该设置不存在,则为-1;
    • -1:无限嵌套

    style

    字符串值,默认值:ul

    使用何种函数输出评论列表,可选的值有:div、ol、ul

    callback

    自定义函数

    使用一个自定义函数来输出评论列表,可以自定义输出评论的HTML,应包含开始函数

        • ,但不需要关闭函数,WordPress会自动关闭这个函数。

    end-callback

    自定义函数

    用来关闭callback中定义的开始函数,而不使用WordPress默认的

    type

    字符串值,默认值:all

    评论的类型,可选值有:all、comment、trackback、pingback、pings(等于trackback和pingback)

    reply_text

    字符串值,默认值:Reply

    评论回复链接的锚文本

    page

    整数型,默认为空

    当前分页的页码

    per_page

    整数型,默认为空

    每个页面显示的评论数量,默认取后台讨论设置每页显示评论数量的值。

    avatar_size

    整数型,默认值:32

    用户头像的大小

    reverse_top_level

    布尔值,默认值:null

    如果为true,等效于讨论设置中在每个页面顶部显示“新的”评论,如果为false,等效于“旧的”评论。

    reverse_children

    布尔值,默认为空

    如果设置为真,将显示最新的子评论,但我在测试中没发现有任何作用。

    format

    字符串值,默认值:html5

    以何种HTML版本风格输出评论列表

    • html5
    • xhtml

    short_ping

    布尔值,默认值:false

    是否使用short ping

    echo

    布尔值,默认值:true

    是否输出结果,如果为false,只返回结果而不是输出。

    函数使用示例

    以ol列表输出评论,嵌套3层,回复评论链接的锚文本修改为“吐槽”,用户头像设置为36像素大小。

    <ol>
    <?php
    	$args = array(
    		'max_depth' => 3,
    		'style' => 'ol',
    		'reply_text' => '吐槽',
    		'avatar_size' => 36,
    	);
    	wp_list_comments($args);
    ?>
    </ol>
    

    下面的代码输出一样的结果:

    <ol>
    	<?php wp_list_comments('max_depth=3&style=ol&reply_text=吐槽&avatar_size=36'); ?>
    </ol>
    

    使用callback的示例,我们将在mytheme_comment()函数中定义评论列表的输出格式。

    <?php
    function mytheme_comment($comment, $args, $depth) {
        if ( 'div' === $args['style'] ) {
            $tag       = 'div';
            $add_below = 'comment';
        } else {
            $tag       = 'li';
            $add_below = 'div-comment';
        }
        ?>
        <<?php echo $tag ?> <?php comment_class( empty( $args['has_children'] ) ? '' : 'parent' ) ?> id="comment-<?php comment_ID() ?>">
        <?php if ( 'div' != $args['style'] ) : ?>
            <div id="div-comment-<?php comment_ID() ?>" class="comment-body">
        <?php endif; ?>
        <div class="comment-author vcard">
            <?php if ( $args['avatar_size'] != 0 ) echo get_avatar( $comment, $args['avatar_size'] ); ?>
            <?php printf( __( '<cite class="fn">%s</cite> <span class="says">says:</span>' ), get_comment_author_link() ); ?>
        </div>
        <?php if ( $comment->comment_approved == '0' ) : ?>
             <em class="comment-awaiting-moderation"><?php _e( 'Your comment is awaiting moderation.' ); ?></em>
              <br />
        <?php endif; ?>
    
        <div class="comment-meta commentmetadata"><a href="<?php echo htmlspecialchars( get_comment_link( $comment->comment_ID ) ); ?>">
            <?php
            /* translators: 1: date, 2: time */
            printf( __('%1$s at %2$s'), get_comment_date(),  get_comment_time() ); ?></a><?php edit_comment_link( __( '(Edit)' ), '  ', '' );
            ?>
        </div>
    
        <?php comment_text(); ?>
    
        <div class="reply">
            <?php comment_reply_link( array_merge( $args, array( 'add_below' => $add_below, 'depth' => $depth, 'max_depth' => $args['max_depth'] ) ) ); ?>
        </div>
        <?php if ( 'div' != $args['style'] ) : ?>
        </div>
        <?php endif; ?>
    <?php } ?>
    <ul class="commentlist">
    	<?php wp_list_comments( 'type=comment&callback=mytheme_comment' ); ?>
    </ul>
    

    输出指定文章或页面评论的例子:

    <ol class="commentlist">
    	<?php
    		//Gather comments for a specific page/post 
    		$comments = get_comments(array(
    			'post_id' => $id,
    			'status' => 'approve' //Change this to the type of comments to be displayed
    		));
    
    		//Display the list of comments
    		wp_list_comments(array(
    			'per_page' => 10, //Allow comment pagination
    			'reverse_top_level' => false //Show the oldest comments at the top of the list
    		), $comments);
    	?>
    </ol>
    

    扩展阅读

    wp_list_comments()函数位于:wp-includes/comment-template.php

    相关函数:

    • cancel_comment_reply_link()
    • comment_author()
    • comment_author_email()
    • comment_author_email_link()
    • comment_author_IP()
    • comment_author_link()
    • comment_author_rss()
    • comment_author_url()
    • comment_author_url_link()
    • comment_class()
    • comment_date()
    • comment_excerpt()
    • comment_form_title()
    • comment_form()
    • comment_ID()
    • comment_id_fields()
    • comment_reply_link()
    • comment_text()
    • comment_text_rss()
    • comment_time()
    • comment_type()
    • comments_link()
    • comments_number()
    • comments_open()
    • comments_popup_link()
    • comments_popup_script()
    • comments_rss_link()
    • get_avatar()
    • next_comments_link()
    • paginate_comments_links()
    • permalink_comments_rss()
    • previous_comments_link()

    WordPress下拉列表输出页面函数:wp_dropdown_pages

    WordPress模板函数wp_dropdown_pages用于输出页面列表,与其他输出页面列表的函数比较,wp_dropdown_pages()函数不是以

     

  • 列表输出,而是
  •  
    wp_dropdown_pages( array|string $args = '' )
    

    函数参数

    $args

    数组或字符串值

    wp_dropdown_pages()函数$args参数默认的值如下:

    $args = array(
    	'depth'                 => 0,
    	'child_of'              => 0,
    	'selected'              => 0,
    	'echo'                  => 1,
    	'name'                  => 'page_id',
    	'id'                    => null,
    	'class'                 => null,
    	'show_option_none'      => null,
    	'show_option_no_change' => null,
    	'option_none_value'     => null,
    );
    

    wp_dropdown_pages()函数$args参数可用的值如下:

    depth

    整数型,默认值:0

    • 0:输出所有的页面和子页面,按层级的方式输出;
    • 1:只输出顶级页面,不包含任何子页面;
    • n:根据n的具体数字来显示相应等级的页面;
    • -1:输出所有的页面和子页面,不以层级的方式输出;

    child_of

    整数型,默认值:0

    指定一个页面ID,将输出该页面的子页面,不包含该页面。

    selected

    整数型,默认值:0

    指定一个页面ID,这个页面的函数将添加selected属性,也就是选中状态。

    echo

    布尔值,默认值:1

    是否输出结果,如果为0,只返回结果而不输出。

    name

    字符串值,默认值:page_id

    id

    字符串值,默认值:与name的值相同

    class

    字符串值,默认为空

    show_option_none

    字符串值,默认为空

    通常情况下,下拉列表有一个名为“请选择”的空,该值指定这个空的文本。

    option_none_value

    字符串值,默认为空

    为show_option_none添加的指定value值

    show_option_no_change

    字符串值,默认为空

    添加一个value为-1的选项,show_option_no_change的值为这个的文本。

    exclude

    字符串值,默认为空

    要排除的页面ID,多个ID用逗号分隔。

    exclude_tree

    字符串值,默认为空

    要排除的页面ID,多个ID用逗号分隔,连同子页面一起排除。

    函数使用示例

    只显示顶级页面,设置ID为15的页面默认被选中,并添加了一个“请选择”的选项

    <?php
    	$args = array(
    		'depth' => 1,
    		'selected' => 15,
    		'show_option_none' => '请选择'
    	);
    	wp_dropdown_pages($args);
    ?>
    

    下面的代码输出一样的结果:

    <?php wp_dropdown_pages('depth=1&selected=15&show_option_none=请选择'); ?>
    

    扩展阅读

    wp_dropdown_pages()函数位于:wp-includes/post-template.php

    相关函数:

    • wp_list_pages()
    • wp_page_menu()

    WordPress下拉列表输出分类函数:wp_dropdown_categories

    WordPress模板函数wp_dropdown_categories用于输出分类列表,与其他输出分类列表的函数比较,wp_dropdown_categories()函数不是以

     

  • 列表输出,而是
  •  
    wp_dropdown_categories( string|array $args = '' )
    

    函数参数

    $args

    数组或字符串值

    wp_dropdown_categories()函数$args参数默认的值如下:

    $args = array(
    	'show_option_all'    => '',
    	'show_option_none'   => '',
    	'option_none_value'  => '-1',
    	'orderby'            => 'ID',
    	'order'              => 'ASC',
    	'show_count'         => 0,
    	'hide_empty'         => 1,
    	'child_of'           => 0,
    	'exclude'            => '',
    	'include'            => '',
    	'echo'               => 1,
    	'selected'           => 0,
    	'hierarchical'       => 0,
    	'name'               => 'cat',
    	'id'                 => '',
    	'class'              => 'postform',
    	'depth'              => 0,
    	'tab_index'          => 0,
    	'taxonomy'           => 'category',
    	'hide_if_empty'      => false,
    	'value_field'	     => 'term_id',
    );
    

    wp_dropdown_categories()函数$args参数可用的值如下:

    show_option_all

    字符串值,默认为空

    在下拉列表的开始处添加一个value为0的,该值指定的文本,例如:所有分类

    show_option_none

    字符串值,默认为空

    在下拉列表的开始处添加一个value为-1的,该值指定的文本。

    option_none_value

    字符串值,默认值:-1

    为show_option_none添加的指定一个value值。

    orderby

    字符串值,默认值:ID

    以何种方式排序

    • ID:分类的ID
    • name:分类名称
    • slug:分类别名
    • count:文章数量
    • term_group

    order

    字符串值,默认值:ASC

    分类的排序顺序

    • ASC:升序排列;
    • DESC:降序排列;

    show_count

    布尔值,默认值:false

    是否显示分类下文章数量

    hide_empty

    布尔值,默认值:1

    是否隐藏没有文章的分类,默认隐藏,为0则会显示没有文章的分类。

    child_of

    整数型,默认值:0

    指定一个分类ID,将输出该分类下的子分类,但不包括该分类。

    exclude

    字符串,默认为空

    要排除的分类ID,如果为字符串值时,多个分类ID用逗号分隔。如果hierarchical为true,则相应的子分类也会被排除。

    include

    字符串,默认为空

    要显示的分类ID,多个分类ID用逗号分隔。

    exclude_tree

    字符串,默认为空

    要排除的分类ID,不管hierarchical为何值,相应的子分类都会被排除。

    echo

    布尔值,默认值:1

    默认直接输出分类列表,如果为0则只返回结果而不输出。

    depth

    整数型,默认值:0

    • 0:输出所有的分类和子分类;
    • 1:只输出顶级分类,不包含任何子分类;
    • n:根据n的具体数字来显示相应等级的分类;
    • -1:输出所有的分类和子分类,不论hierarchical的值是多少,都不以层级的方式输出;

    tab_index

    布尔值,默认值:false

    name

    字符串值,默认值:cat

    id

    字符串值,默认值:name参数指定的值

    class

    字符串值,默认值:postform

    selected

    整数型,默认值:0

    指定一个分类ID,将为其添加selected属性,即选中状态。

    hierarchical

    布尔值,默认值:0

    是否以层级的方式显示子分类,默认否。

    pad_counts

    布尔值,默认值:false

    是否将子分类的文章数量计算在父分类下,一般情况下,我们不会直接在父分类下发表文章,即父分类的文章总数为0,如果pad_counts的值为true,则显示父分类的文章数量为所有子分类文章数量的总和。如果show_count和hierarchical的值都为true,则pad_counts的值自动为true。

    taxonomy

    字符串值,默认值:category

    自定义分类法

    hide_if_empty

    布尔值,默认值:false

    在没有返回结果时是否隐藏下拉菜单,true为隐藏

    value_field

    字符串值,默认值:term_id

    指定的value值

    • term_id:分类ID
    • name:分类名称
    • slug:分类别名
    • term_taxonomy_id:分类ID
    • taxonomy:分类法名称,例如:category
    • description:分类描述
    • parent:父分类的ID
    • count:文章数量
    • term_group

    函数使用示例

    以层级方式显示一级子分类,并显示没有文章的分类,显示分类下文章数量,的value值取分类的别名

    <?php
    	$args = array(
    		'depth' => 2,
    		'hide_empty' => 0,
    		'hierarchical' => 1,
    		'show_count' => 1,
    		'value_field' => 'slug',
    	);
    	wp_dropdown_categories($args);
    ?>
    

    下面的代码输出一样的结果:

    <?php wp_dropdown_categories('depth=2&hide_empty=0&hierarchical=1&show_count=1&value_field=slug'); ?>
    

    扩展阅读

    wp_dropdown_categories()函数位于:wp-includes/category-template.php

    相关函数:

    • wp_list_categories()
    • get_the_category_list()

    WordPress获取登录地址函数:wp_login_url

    WordPress模板函数wp_login_url用于输出后台登录地址,常用于开放注册的WordPress站点。

    wp_login_url( string $redirect = '' )
    

    函数参数

    $redirect

    字符串值,默认为空

    提供一个URL,当用户登录后会跳转回这个URL,一般提供当前页面的URL

    函数使用示例

    当用户登录后返回网站首页

    <a href="<?php echo wp_login_url( home_url() ); ?>">登录</a>
    

    在文章页面,还可以这样使用,使用户登录后返回当前文章页

    <a href="<?php echo wp_login_url( get_permalink() ); ?>">登录</a>
    

    你可以使用条件判断函数来实现不同页面点击登录后返回不同的URL

    更简单的办法是,无论在哪个页面登录,都将跳转回当前页面

    <a href="<?php echo wp_login_url( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ); ?>">登录</a>
    

    扩展阅读

    wp_login_url()函数位于:wp-includes/general-template.php

    相关函数:

    • is_user_logged_in()
    • wp_login_form()
    • wp_loginout()
    • wp_logout()
    • wp_register()
    • wp_logout_url()
    • wp_lostpassword_url()
    • wp_registration_url()

    WordPress判断用户是否登录函数:is_user_logged_in

    WordPress模板函数is_user_logged_in用于判断当前用户是否已登录,从而输出用户信息或登录/退出按钮等。

    is_user_logged_in()
    

    is_user_logged_in()函数没有参数,一个简单的用法示例,如果用户已登录,输出用户头像及昵称:

    <?php
    	if( is_user_logged_in() ) {
    		$current_user = wp_get_current_user();
    		echo get_avatar( $current_user->user_email, 36 );
    		echo '<br />' . $current_user->display_name;
    	}
    ?>
    

    扩展阅读

    is_user_logged_in()函数位于:wp-includes/pluggable.php

    相关函数:

    • wp_get_current_user()

    WordPress下拉列表输出用户函数:wp_dropdown_users

    WordPress模板函数wp_dropdown_users用于输出用户列表,与其他输出用户列表的函数比较,wp_dropdown_users()函数不是以

  • 列表输出,而是
    wp_dropdown_users( string|array $args = '' )
    

    函数参数

    $args

    数组或字符串值

    wp_dropdown_users()函数$args参数默认的值如下:

    $args = array(
    	'show_option_all'         => null,
    	'show_option_none'        => null,
    	'hide_if_only_one_author' => null,
    	'orderby'                 => 'display_name',
    	'order'                   => 'ASC',
    	'include'                 => null,
    	'exclude'                 => null,
    	'multi'                   => false,
    	'show'                    => 'display_name',
    	'echo'                    => true,
    	'selected'                => false,
    	'include_selected'        => false,
    	'name'                    => 'user',
    	'id'                      => null,
    	'class'                   => null, 
    	'blog_id'                 => $GLOBALS['blog_id'],
    	'who'                     => null
    );
    

    wp_dropdown_users()函数$args参数可用的值如下:

    show_option_all

    字符串值,默认为空

    在下拉列表的开始处添加一个value为0的,该值指定的文本,例如:所有用户

    show_option_none

    字符串值,默认为空

    在下拉列表的开始处添加一个value为-1的,该值指定的文本。

    orderby

    字符串值,默认值:display_name

    以什么方式排序

    • ID:用户ID
    • user_nicename:用户昵称
    • display_name:用户资料设置中,“公开显示为”指定的名称

    order

    字符串值,默认值:ASC

    排序顺序

    • ASC:升序
    • DESC:降序

    include

    字符串值,默认为空

    要显示的用户ID,多个ID用逗号分隔

    exclude

    字符串值,默认为空

    要排除的用户ID,多个ID用逗号分隔

    multi

    布尔值,默认值:false

    是否隐藏

    show

    字符串值,默认值:display_name

    文本的值,即用户能看到的列表项内容。

    • ID:用户ID
    • user_login:用户登录名
    • display_name:用户资料“公开显示为”指定的名称

    echo

    布尔值,默认值:1

    默认直接输出用户列表,如果为0则只返回结果而不输出。

    selected

    整数型,默认值:false

    指定一个用户ID,将为该添加selected属性,即选中状态。

    include_selected

    布尔值,默认值:false

    始终在下拉列表中包含所选的用户ID。

    name

    字符串值,默认值:user

    id

    字符串值,默认值:name参数指定的值

    class

    字符串值,默认为空

    blog_id

    整数型,默认为当前博客的ID

    实用于多站点

    who

    要查询的用户,目前仅支持“authors”,默认为所有用户。

    函数使用示例

    以ID排序显示用户列表,并在列表开头添加一个“所有用户”项

    <?php
    	$args = array(
    		'show_option_all' => '所有用户',
    		'orderby' => 'ID'
    	);
    	wp_dropdown_users($args);
    ?>
    

    下面的代码输出一样的结果:

    <?php wp_dropdown_users('show_option_all=所有用户&orderby=ID'); ?>
    

    扩展阅读

    wp_dropdown_users()函数位于:wp-includes/user.php

    相关函数:

    • wp_list_authors()

    WordPress获取找回密码地址函数:wp_lostpassword_url

    WordPress模板函数wp_lostpassword_url用于输出找回密码地址,通过该URL,用户可以重置密码。

    wp_lostpassword_url( string $redirect = '' )
    

    函数参数

    $redirect

    字符串值,默认为空

    提供一个URL,当用户完成找回密码后会跳转回这个URL,一般提供当前页面的URL

    函数使用示例

    当用户找回密码后返回网站首页

    <a href="<?php echo wp_lostpassword_url( home_url() ); ?>">忘记密码?</a>
    

    在文章页面,用户找回密码后返回当前文章页

    <a href="<?php echo wp_lostpassword_url( get_permalink() ); ?>">忘记密码?</a>
    

    无论用户在哪个页面点击找回密码,当用户完成找回密码操作后都返回之前的页面

    <a href="<?php echo wp_lostpassword_url( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ); ?>">忘记密码?</a>
    

    扩展阅读

    wp_lostpassword_url()函数位于:wp-includes/general-template.php

    相关函数:

    • is_user_logged_in()
    • wp_login_form()
    • wp_loginout()
    • wp_logout()
    • wp_register()
    • wp_login_url()
    • wp_logout_url()
    • wp_registration_url()

    WordPress获取登出地址函数:wp_logout_url

    WordPress模板函数wp_logout_url用于输出登出地址,常用于开放注册的WordPress站点。

    wp_logout_url( string $redirect = '' )
    

    函数参数

    $redirect

    字符串值,默认为空

    提供一个URL,当用户退出登录后会跳转回这个URL,一般提供当前页面的URL

    函数使用示例

    当用户退出登录后返回网站首页

    <a href="<?php echo wp_logout_url( home_url() ); ?>">注销</a>
    

    在文章页面,用户退出登录后返回当前文章页

    <a href="<?php echo wp_logout_url( get_permalink() ); ?>">注销</a>
    

    无论在哪个页面退出登录,都返回到当前页面

    <a href="<?php echo wp_logout_url( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ); ?>">注销</a>
    

    扩展阅读

    wp_logout_url()函数位于:wp-includes/general-template.php

    相关函数:

    • is_user_logged_in()
    • wp_login_form()
    • wp_loginout()
    • wp_logout()
    • wp_register()
    • wp_login_url()
    • wp_lostpassword_url()
    • wp_registration_url()

    WordPress输出注册、管理站点链接函数:wp_register

    WordPress模板函数wp_register用于输出注册、管理站点链接,wp_register()会检测用户登录状态,根据用户登录状态输出相应的链接。

    wp_register( string $before = '<li>', string $after = '</li>', boolean $echo = true )
    

    函数参数

    $before

    字符串值,默认值:

  • 链接前的字符,默认
  • ,即以li列表输出。$after

    字符串值,默认值:

  • 链接后的字符,即关闭函数。

    $echo

    布尔值,默认值:true

    是否输出链接,如果为false,只返回结果而不输出。

    函数使用示例

    函数来包裹链接而不是li列表

    <?php wp_register('<p>', '</p>'); ?>
    

    扩展阅读

    wp_register()函数位于:wp-includes/general-template.php

    相关函数:

    • is_user_logged_in()
    • wp_login_form()
    • wp_loginout()
    • wp_logout()
    • wp_login_url()
    • wp_logout_url()
    • wp_lostpassword_url()
    • wp_registration_url()

    WordPress输出登录、登出链接函数:wp_loginout

    WordPress模板函数wp_loginout用于输出登录、登出链接,wp_loginout()检测用户登录状态,根据用户登录状态输出相应的链接。

    wp_loginout( string $redirect = '', boolean $echo = true )
    

    函数参数

    $redirect

    字符串值,默认为空

    提供一个URL,当用户登录或登出后跳转回这个URL,一般提供当前页面的URL

    $echo

    布尔值,默认值:true

    是否输出链接,如果为false,只返回结果而不输出。

    函数使用示例

    登录或登出后跳转回网站首页

    <p><?php wp_loginout( home_url() ); ?></p>
    

    如果在文章页,登录或登出后跳转回当前页面

    <p><?php wp_loginout( get_permalink() ); ?></p>
    

    无论用户在哪个页面操作登录或登出,都将返回到当前页面

    <p><?php wp_loginout( 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'] ); ?></p>
    

    扩展阅读

    wp_loginout()函数位于:wp-includes/general-template.php

    相关函数:

    • is_user_logged_in()
    • wp_login_form()
    • wp_logout()
    • wp_register()
    • wp_login_url()
    • wp_logout_url()
    • wp_lostpassword_url()
    • wp_registration_url()

    WordPress获取注册地址函数:wp_registration_url

    WordPress模板函数wp_registration_url用于输出注册链接,通常用于开放注册的WordPress站点。

    wp_registration_url()
    

    wp_registration_url()函数没有参数,返回注册页面的URL。

    wp_registration_url()函数使用示例:

    <a href="<?php echo wp_registration_url(); ?>">注册</a>
    

    扩展阅读

    wp_registration_url()函数位于:wp-includes/general-template.php

    相关函数:

    • is_user_logged_in()
    • wp_login_form()
    • wp_loginout()
    • wp_logout()
    • wp_register()
    • wp_login_url()
    • wp_logout_url()
    • wp_lostpassword_url()

    WordPress销毁当前用户会话函数:wp_logout

    WordPress模板函数wp_logout销毁当前用户会话以及清除相应的cookie。

    wp_logout()
    

    wp_logout()函数没有参数,事实上wp_logout()函数等效于调用这两个函数:

    wp_destroy_current_session();
    wp_clear_auth_cookie();
    

    wp_logout()函数使用示例:

    <?php wp_logout(); ?>
    

    扩展阅读

    wp_logout()函数位于:wp-includes/pluggable.php

    相关函数:

    • is_user_logged_in()
    • wp_login_form()
    • wp_loginout()
    • wp_register()
    • wp_login_url()
    • wp_logout_url()
    • wp_lostpassword_url()
    • wp_registration_url()

    WordPress设置记住登录信息函数:wp_signon

    WordPress模板函数wp_signon用于设置记住登录信息,这在开放注册的WordPress站点中经常用到。

    wp_signon( array $credentials = array(), boolean $secure_cookie = '' )
    

    函数参数

    $credentials

    数组,默认为空

    该数组定义了需要记住的登录信息,如果该参数为空,默认的值如下:

    • $_POST[‘log’]
    • $_POST[‘pwd’]
    • $_POST[‘rememberme’]

    $secure_cookie

    布尔值,默认值:false

    是否使用安全cookie

    wp_signon()函数使用示例:

    function custom_login() {
    	$creds = array();
    	$creds['user_login'] = 'example';
    	$creds['user_password'] = 'plaintextpw';
    	$creds['remember'] = true;
    	$user = wp_signon( $creds, false );
    	if ( is_wp_error($user) )
    		echo $user->get_error_message();
    }
    // 在加载头部前设置cookies
    add_action( 'after_setup_theme', 'custom_login' );
    

    扩展阅读

    wp_signon()函数位于:wp-includes/user.php

    相关函数:

    • is_user_logged_in()
    • wp_login_form()
    • wp_loginout()
    • wp_logout()
    • wp_register()
    • wp_login_url()
    • wp_logout_url()
    • wp_lostpassword_url()
    • wp_registration_url()

    WordPress输出当前文章标题函数:the_title

    WordPress模板函数the_title用于输出当前文章的标题,需要用在The Loop主循环里。

    the_title( string $before = '', string $after = '', boolean $echo = true )
    

    函数参数

    $before

    字符串值,默认为空

    在标题前输出的内容

    $after

    字符串值,默认为空

    在标题后输出的内容

    $echo

    布尔值,默认值:true

    是否输出标题,如果为false,只返回结果而不是输出。

    函数使用示例

    为标题添加

    函数并输出

    <?php the_title( '<h2>', '</h2>' ); ?>
    

    扩展阅读

    the_title()函数位于:wp-includes/post-template.php

    相关函数:

    • the_ID()
    • get_the_ID()
    • the_title_attribute()
    • the_title_rss()

    WordPress获取当前文章ID函数:the_ID

    WordPress模板函数the_ID用于输出当前文章的ID,需要用在The Loop主循环里。

    the_ID()
    

    使用示例:

    <p>文章ID: <?php the_ID(); ?></p>
    

    扩展阅读

    the_ID()函数位于:wp-includes/post-template.php

    相关函数:

    • get_the_ID()
    • the_title()
    • the_title_attribute()

    WordPress登录表单函数:wp_login_form

    前面介绍了一系列用于制作登录表单的函数,事实上如果我们需要WordPress前台输出一个登录表单,只需要WordPress模板函数wp_login_form就够了。

    wp_login_form( string|array $args = '' )
    

    函数参数

    $args

    数组或字符串值

    wp_login_form()函数$args参数默认的值如下:

    $args = array(
    	'echo'           => true,
    	'remember'       => true,
    	'redirect'       => ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'],
    	'form_id'        => 'loginform',
    	'id_username'    => 'user_login',
    	'id_password'    => 'user_pass',
    	'id_remember'    => 'rememberme',
    	'id_submit'      => 'wp-submit',
    	'label_username' => __( 'Username' ),
    	'label_password' => __( 'Password' ),
    	'label_remember' => __( 'Remember Me' ),
    	'label_log_in'   => __( 'Log In' ),
    	'value_username' => '',
    	'value_remember' => false
    );
    

    wp_login_form()函数$args参数可用的值如下:

    echo

    布尔值,默认值:true

    是否输出结果,如果为false,只返回结果而不输出。

    redirect

    字符串值,默认为当前页面URL

    用户登录后返回哪个页面,默认返回到当前页面,通常这是最好的选择。

    form_id

    字符串值,默认值:loginform

    登录表单id属性的值

    remember

    布尔值,默认值:true

    是否显示“记住我的登录信息”选项

    value_username

    字符串值,默认为空

    log文本框默认的value值,也就是用户名输入框默认值。

    value_remember

    布尔值,默认值:false

    这个比较实用,设置“记住我的登录信息”选项是否默认选中状态,默认为不选中。

    函数使用示例

    设置用户名输入框默认值为“请输入用户名…”,并默认勾选“记住我的登录信息”

    <?php 
    	$args = array(
    		'value_remember' => true,
    		'value_username' => '请输入用户名...'
    	);
    	wp_login_form($args);
    ?>
    

    下面的代码输出一样的结果:

    <?php wp_login_form('value_remember=1&value_username=请输入用户名...'); ?>
    

    扩展阅读

    wp_login_form()函数位于:wp-includes/general-template.php

    相关函数:

    • is_user_logged_in()
    • wp_loginout()
    • wp_logout()
    • wp_register()
    • wp_login_url()
    • wp_logout_url()
    • wp_lostpassword_url()
    • wp_registration_url()

    WordPress文章页输出文章标题函数:single_post_title

    WordPress模板函数single_post_title用于输出当前文章的标题,需要用在The Loop主循环里。

    single_post_title( string $prefix = '', boolean $display = true )
    

    函数参数

    $prefix

    字符串值,默认为空

    在文章标题前输出的内容

    $display

    布尔值,默认值:true

    是否输出标题,如果为false,只返回结果而不输出。

    函数使用示例

    以本文为例,输出:当前文章:WordPress模板函数:single_post_title

    <h2><?php single_post_title( '当前文章: ' ); ?></h2>
    

    扩展阅读

    single_post_title()函数位于:wp-includes/general-template.php

    相关函数:

    • the_title()
    • the_title_rss()
    • the_title_attribute()

    WordPress输出当前文章标题函数:the_title_attribute

    WordPress模板函数the_title_attribute用于输出当前文章的标题,和the_title()相似,但the_title_attribute()去除了标题中的HTML函数。

    the_title_attribute( string|array $args = '' )
    

    函数参数

    $args

    数组或字符串

    the_title_attribute()函数$args参数默认的值如下:

    $args = array( 
    	'before'	=> '',
    	'after'		=>  '',
    	'echo'		=> true,
    	'post'		=> get_post()
    );
    

    the_title_attribute()函数$args参数可用的值如下:

    before

    字符串值,默认为空

    在标题前添加内容

    after

    字符串值,默认为空

    在标题后添加内容

    echo

    布尔值,默认值:true

    是否输出标题,如果为false,只返回结果而不输出。

    post

    整数型或对象,默认值:get_post()函数返回的值

    指定一个文章ID或对象,用来输出特定文章的标题。

    函数使用示例

    这个示例在函数的title属性中输出了文章标题,并在标题前输出:Permalink to

    <a href="<?php the_permalink(); ?>" title="<?php the_title_attribute( array( 'before' => 'Permalink to: ', 'after' => '' ) ); ?>"><?php the_title(); ?></a>
    

    扩展阅读

    the_title_attribute()函数位于:wp-includes/post-template.php

    相关函数:

    • the_ID()
    • get_the_ID()
    • the_title()
    • the_title_rss()

    WordPress在RSS页面输出文章标题函数:the_title_rss

    WordPress模板函数the_title_rss用于RSS页面输出文章标题,一般用在The Loo主循环。

    the_title_rss()
    

    使用示例:

    <item>
        <title><?php the_title_rss(); ?></title>
    </item>
    

    扩展阅读

    the_title_rss()函数位于:wp-includes/feed.php

    相关函数:

    • the_ID()
    • get_the_ID()
    • the_title()
    • the_title_attribute()

    WordPress输出文章摘要函数:the_excerpt

    WordPress模板函数the_excerpt用于输出文章的摘要,需要用在The Loop主循环。如果当前文章有填写“摘要”,the_excerpt()函数输出这个摘要内容,否则自动截断文章内容的前55个字数,中文一个汉字只算作一个字数。

    the_excerpt()
    

    函数使用示例

    <?php the_excerpt(); ?>
    

    设置截断的字数(写在functions.php里):

    function wpdocs_custom_excerpt_length( $length ) {
        return 200;
    }
    add_filter( 'excerpt_length', 'wpdocs_custom_excerpt_length', 999 );
    

    在截断的文字后面输出的字符(写在functions.php里):

    function wpdocs_excerpt_more( $more ) {
        return '[.....]';
    }
    add_filter( 'excerpt_more', 'wpdocs_excerpt_more' );
    

    设置More链接(写在functions.php里):

    function wpdocs_excerpt_more( $more ) {
        return sprintf( '<a class="read-more" href="%1$s">%2$s</a>',
            get_permalink( get_the_ID() ),
            __( 'Read More', 'textdomain' )
        );
    }
    add_filter( 'excerpt_more', 'wpdocs_excerpt_more' );
    

    扩展阅读

    the_excerpt()函数位于:wp-includes/post-template.php

    相关函数:

    • the_content()
    • get_the_content()
    • get_the_excerpt()
    • the_excerpt_rss()

    WordPress输出RSS文章内容函数:the_content_rss

    WordPress模板函数the_content_rss用于输出RSS格式化的文章内容,需要用在The Loop循环里。该函数已经废弃,可能会在未来的WordPress版本中删除,不建议使用。

    the_content_rss( string $more_link_text='(more...)', boolean $stripteaser=0, string $more_file='', integer $cut = 0, integer $encode_html = 0)
    

    函数参数

    $more_link_text

    字符串值,默认值:(more…)

    More链接的文本

    $strip_teaser

    布尔值,默认值:false

    为true时,点击More链接到达文章页面会隐藏More链接前的文本,文章里要在添加<!–more–>函数的同时添加<!–noteaser–>函数。

    $more_file

    字符串值,默认为空

    More链接指向的文件

    $cut

    整数型,默认值:0,表示所有

    结束内容前显示的字符

    $encode_html

    整数型,默认值:0

    • 0:解析编号为url footnotes的链接;
    • 1:使用htmlspecialchars()函数转义字符;
    • 2:标记HTML函数,并将“&”替换为HTML实体;

    使用示例:

    <?php the_content_rss('', TRUE, '', 50); ?>
    

    扩展阅读

    the_content_rss()函数位于:wp-includes/deprecated.php

    相关函数:

    • the_ID()
    • the_title()
    • the_content()

    WordPress输出文章内容函数:the_contentw

    WordPress模板函数the_content用于输出文章内容,需要用在The Loop主循环。

    the_content( string $more_link_text = null, bool $strip_teaser = false )
    

    函数参数

    $more_link_text

    字符串值,默认为空

    当使用More函数截断内容时,提供一个字符串作为截断后显示的“阅读全文”链接的锚文本。

    $strip_teaser

    布尔值,但实际实用中通常传递字符串值,默认为false

    提供一个字符串,会在More的锚文本后面输出,并以函数包裹。

    函数使用示例

    输出当前文章内容并以More函数截断

    the_content( sprintf(
    	__( 'Continue reading<span class="screen-reader-text"> "%s"</span>', 'beizigen' ),
    	get_the_title()
    ) );
    

    扩展阅读

    the_content()函数位于:wp-includes/post-template.php

    相关函数:

    • get_the_content()
    • apply_filters()

    WordPress文章内容分页函数:wp_link_pages

    WordPress模板函数wp_link_pages用于输出文章内容翻页,需要在文章内容中插入<!–nextpage–>函数。

    wp_link_pages( array|string $args = '' )
    

    函数参数

    $args

    数组或字符串值

    wp_link_pages()函数$args参数默认的值如下:

    $args = array(
    	'before'           => '<p>' . __( 'Pages:' ),
    	'after'            => '</p>',
    	'link_before'      => '',
    	'link_after'       => '',
    	'next_or_number'   => 'number',
    	'separator'        => ' ',
    	'nextpagelink'     => __( 'Next page' ),
    	'previouspagelink' => __( 'Previous page' ),
    	'pagelink'         => '%',
    	'echo'             => 1
    );
    

    wp_link_pages()函数$args参数可用的值如下:

    before

    字符串值,默认值:

    页面:

    提供一个字符串在分页导航前输出

    after

    字符串值,默认值:

    提供一个字符串在分页导航后输出,主要用于关闭before里设置的函数。

    link_before

    字符串值,默认为空

    用于在链接锚文本前输出内容。

    link_after

    字符串值,默认为空

    用于在链接锚文本后输出内容。

    next_or_number

    字符串值,默认值:number

    指定分页的显示方式

    • number:以数字的方式显示分页导航;
    • next:分页导航以“上一页”、“下一页”的方式显示。

    separator

    字符串值,默认为空格

    页码之前输出,默认页码之间用空格分隔。

    nextpagelink

    字符串值,默认值:下一页

    当next_or_number的值为next时,nextpagelink的值指定下一页的文本。

    previouspagelink

    字符串值,默认值:上一页

    当next_or_number的值为next时,previouspagelink的值指定上一页的文本。

    pagelink

    字符串值,默认值:%

    格式化分页链接文本,%表示页码。

    echo

    布尔值,默认值:true

    是否输出结果,为false时只返回结果而不输出。

    函数使用示例

    函数包裹分页链接

    <?php
    	$args = array(
    		'before' => '<div id="page-links">分页:',
    		'after' => '</div>',
    	);
    	wp_link_pages( $args );
    ?>
    

    下面的代码输出一样的结果:

    <?php wp_link_pages( 'before=<div id="page-links">分页:&after=</div>' ); ?>
    

    扩展阅读

    wp_link_pages()函数位于:wp-includes/post-template.php

    相关函数:

    • posts_nav_link()
    • next_posts_link()
    • previous_posts_link()
    • get_next_posts_link()
    • get_previous_posts_link()
    • paginate_links()
    • next_post_link()
    • previous_post_link()
    • the_posts_pagination()
    • get_the_posts_pagination()

    WordPress输出RSS文章摘要函数:the_excerpt_rss

    WordPress模板函数the_excerpt_rss用于输出RSS格式化的文章摘要,需要用在The Loop主循环里。如果当前文章有填写“摘要”,the_excerpt_rss()函数输出这个摘要内容,否则自动截断文章内容的前55个字数,中文一个汉字只算作一个字数。

    the_excerpt_rss()
    

    使用示例:

    <description><?php the_excerpt_rss(); ?></description>
    

    扩展阅读

    the_excerpt_rss()函数位于:wp-includes/feed.php

    相关函数:

    • the_excerpt()
    • get_the_excerpt()
    • the_content()

    WordPress模板函数next_post_link用于在文章页面输出时间顺序上的下一篇文章链接,需要用在The Loop主循环。

    next_post_link( string $format = '%link &raquo;', string $link = '%title', boolean $in_same_term = false, string|array $excluded_terms = '', string $taxonomy = 'category' )
    

    函数参数

    $format

    字符串值,默认值:%link »

    格式化链接,可以在链接的前面或后面插入字符,%link表示链接。

    $link

    字符串值,默认值:%title

    格式化链接锚文本,可以在锚文本的前面或后面插入字符,%title表示文章标题。

    $in_same_term

    布尔值,默认值:false

    是否只显示相同分类的文章链接,默认为否。

    $excluded_terms

    数组或字符串值,默认为空

    排除某些分类的文章,如果是字符串值,多个ID用逗号分隔。

    $taxonomy

    字符串值,默认值:category

    分类法,默认为category

    函数使用示例

    显示相同分类的下一篇文章

    <?php next_post_link( '相同分类下一个文章:%link', '%title', TRUE ); ?>
    

    扩展阅读

    next_post_link()函数位于:wp-includes/link-template.php

    相关函数:

    • wp_link_pages()
    • previous_post_link()
    • posts_nav_link()
    • get_next_posts_link()
    • get_previous_posts_link()
    • paginate_links()

    WordPress模板函数posts_nav_link用于在分类、函数、日期等归档页显示上一页、下一页翻页导航。

    posts_nav_link( string $sep = '', string $prelabel = '', string $nxtlabel = '' )
    

    函数参数

    $sep

    字符串值,默认值:“ — ”

    翻页链接之间显示的字符

    $prelabel

    字符串值,默认值:« 上一页

    上一页链接的文本

    $nxtlabel

    字符串值,默认值:下一页 »

    下一页链接的文本

    函数使用示例

    用空格分隔链接,并修改了链接文本,事实上默认的链接文本更好,这里只是为了示范用法。

    <div id="posts-nav">
    	<?php posts_nav_link( ' ', '上一页', '下一页' ); ?>
    </div>
    

    扩展阅读

    posts_nav_link()函数位于:wp-includes/link-template.php

    相关函数:

    • next_posts_link()
    • previous_posts_link()
    • get_next_posts_link()
    • get_previous_posts_link()
    • paginate_links()

    WordPress模板函数next_posts_link用于在分类、函数、日期等归档页输出下一页链接,需要注意是用在The Loop主循环之外。

    next_posts_link( string $label = null, integer $max_page = 0 )
    

    函数参数

    $label

    字符串值,默认值:null

    链接的锚文本,默认输出 下一页 »

    $max_pages

    整数型,默认值:0

    限制最多翻页数,如果设置为2,那么翻到第2页就不再出现“下一页”链接,默认不限制。

    函数使用示例

    <?php 
    	while ( have_posts() ) : the_post();
    		the_title();
    	endif;
    	next_posts_link();
    ?>
    

    扩展阅读

    next_posts_link()函数位于:wp-includes/link-template.php

    相关函数:

    • posts_nav_link()
    • previous_posts_link()
    • get_next_posts_link()
    • get_previous_posts_link()
    • paginate_links()

    WordPress模板函数previous_posts_link用于在分类、函数、日期等归档页输出上一页链接,需要注意是用在The Loop主循环之外。

    previous_posts_link( string $label = null )
    

    函数参数

    $label

    字符串值,默认值:null

    链接的锚文本,默认输出 « 上一页

    函数使用示例

    <?php 
    	while ( have_posts() ) : the_post();
    		the_title();
    	endif;
    	previous_posts_link();
    ?>
    

    扩展阅读

    previous_posts_link()函数位于:wp-includes/link-template.php

    相关函数:

    • posts_nav_link()
    • next_posts_link()
    • get_next_posts_link()
    • get_previous_posts_link()
    • paginate_links()

    WordPress模板函数previous_post_link用于在文章页输出上一篇文章链接,需要用在The Loop主循环。

    previous_post_link( string $format = '&laquo; %link', string $link = '%title', boolean $in_same_term = false, string|array $excluded_terms = '', string $taxonomy = 'category' )
    

    函数参数

    $format

    字符串值,默认值:« %link

    格式化链接,可以在链接的前面或后面插入字符,%link表示链接。

    $link

    字符串值,默认值:%title

    格式化链接锚文本,可以在锚文本的前面或后面插入字符,%title表示文章标题。

    $in_same_term

    布尔值,默认值:false

    是否只显示相同分类的文章链接,默认为否。

    $excluded_terms

    数组或字符串值,默认为空

    排除某些分类的文章,如果是字符串值,多个ID用逗号分隔。

    $taxonomy

    字符串值,默认值:category

    分类法,默认为category

    函数使用示例

    显示相同分类的上一篇文章

    <?php previous_post_link( '相同分类上一个文章:%link', '%title', TRUE ); ?>
    

    扩展阅读

    previous_post_link()函数位于:wp-includes/link-template.php

    相关函数:

    • wp_link_pages()
    • next_post_link()
    • posts_nav_link()
    • previous_posts_link()
    • get_next_posts_link()
    • get_previous_posts_link()
    • paginate_links()

    WordPress置顶文章类名函数:sticky_class

    WordPress模板函数sticky_class用于在The Loop主循环中,如果文章为置顶状态时,则输出类名:sticky,以便于为置顶文章设置特殊样式。

    sticky_class( int $post_id = null )
    

    函数参数

    $post_id

    整数型,默认值:null

    指定文章ID,在The Loop主循环中不需要指定。

    函数使用示例

    在归档页面循环输出文章,置顶文章的容器会加上sticky类。

    <?php while( have_posts() ) : the_post(); ?>
    	<div class="<?php sticky_class(); ?>">
    		......
    	</div>
    <?php endwhile; ?>
    

    扩展阅读

    sticky_class()函数位于:wp-includes/general-template.php

    相关函数:

    • is_sticky()

    WordPress获取上一个图像函数:previous_image_linkw

    WordPress模板函数previous_image_link用于在附件页面输出上一个图像的链接。

    previous_image_link( string $size = 'thumbnail', string $text = false )
    

    函数参数

    $size

    数组或字符串值,默认值:thumbnail

    图像的尺寸,0或none将默认为post_title 或 $text

    $text

    字符串值,默认值:false

    提供一个字符作为链接锚文本,默认以图片缩略图作为链接。

    函数使用示例

    <div class="alignleft"><?php previous_image_link(); ?></div>
    

    扩展阅读

    previous_image_link()函数位于:wp-includes/media.php

    相关函数:

    • next_image_link()

    WordPress模板函数next_image_link用于在附件页面输出下一个图像的链接。

    next_image_link( string $size = 'thumbnail', string $text = false )
    

    函数参数

    $size

    数组或字符串值,默认值:thumbnail

    图像的尺寸,0或none将默认为post_title 或 $text

    $text

    字符串值,默认值:false

    提供一个字符作为链接锚文本,默认以图片缩略图作为链接。

    函数使用示例

    <div class="alignright"><?php next_image_link(); ?></div>
    

    扩展阅读

    next_image_link()函数位于:wp-includes/media.php

    相关函数:

    • previous_image_link()

    WordPress输出RSS格式分类函数:the_category_rss

    WordPress模板函数the_category_rss用于输出RSS格式的分类,必须用在The Loop主循环中。

    the_category_rss( string $type = null )
    

    函数参数

    $type

    字符串值,默认值:rss2

    RSS的版本,可选的值如下:

    • rss2
    • rss
    • rdf
    • atom

    函数使用示例

    以rss2格式输出分类:

    <?php the_category_rss() ?>
    <guid><?php the_permalink($id); ?></guid>
    

    扩展阅读

    the_category_rss()函数位于:wp-includes/feed.php

    相关函数:

    • the_category()
    • single_cat_title()
    • category_description()
    • wp_dropdown_categories()
    • wp_list_categories()
    • get_the_category()
    • get_category_parents()
    • get_category_link()
    • is_category()
    • in_category()

    WordPress获取文章分类函数:the_category

    WordPress模板函数the_category用于在文章页或归档页的文章列表中输出当前文章所属分类,即使有多个分类也会一并输出。

    the_category( string $separator = '', string $parents = '', int $post_id = false )
    

    函数参数

    $separator

    字符串值,默认为空

    默认以无序列表输出分类链接,当文章指定了多个分类时,提供一个字符用于分隔这些分类链接。

    $parents

    字符串值,默认为空

    指定父分类的显示方式,可选值如下:

    • 空值:不输出父分类;
    • multiple:父分类和子分类都是单独的链接,但处于同一个li元素中;
    • single:不输出父分类链接,但父分类的名称会出现在子分类链接锚文本中;

    $post_id

    整数型,默认值:false

    文章的ID,默认使用当前文章ID。

    函数使用示例

    用 > 分隔分类链接,并且输出父分类链接,非常适合用于制作面包屑导航:

    <?php the_category( ' > ', 'multiple' ); ?>
    

    扩展阅读

    the_category()函数位于:wp-includes/category-template.php

    相关函数:

    • the_category_rss()
    • single_cat_title()
    • category_description()
    • wp_dropdown_categories()
    • wp_list_categories()
    • get_the_category()
    • get_category_parents()
    • get_category_link()
    • is_category()
    • in_category()

    WordPress自定义文章字段函数:the_meta

    WordPress模板函数the_meta用于输出文章自定义字段,必须用在The Loop主循环中。

    the_meta()
    

    该函数没有参数,以无序列表的方式输出文章自定义字段。

    函数使用示例

    <?php the_meta(); ?>
    

    以上代码输出类似如下的内容:

    <ul class='post-meta'>
    	<li><span class='post-meta-key'>views:</span> 18</li>
    	<li><span class='post-meta-key'>seo_title:</span> FTP常见错误解决办法</li>
    	<li><span class='post-meta-key'>seo_description:</span> FTP常见错误解决办法的描述</li>
    </ul>
    

    扩展阅读

    the_meta()函数位于:wp-includes/post-template.php

    相关函数:

    • get_post_meta()
    • add_post_meta()
    • update_post_meta()
    • delete_post_meta()
    • get_post_custom()
    • get_post_custom_values()
    • get_post_custom_keys()

    WordPress获取文章Tag函数:the_tags

    WordPress模板函数the_tags用于在文章页输出函数链接,必须用在The Loop主循环中。

    the_tags( string $before = null, string $sep = ', ', string $after = '' )
    

    函数参数

    $before

    字符串值,默认值:null

    在函数链接前显示的文本。

    $sep

    字符串值,默认值:,

    在每个函数链接之间显示的文本。

    $after

    字符串值,默认为空

    在函数链接后显示的文本。

    函数使用示例

    以无序列表输出函数链接:

    <ul>
    	<?php the_tags('<li>', '</li><li>', '</li>') ?>
    </ul>
    

    扩展阅读

    the_tags()函数位于:wp-includes/category-template.php

    相关函数:

    • get_tag()
    • get_tag_link()
    • get_tags()
    • get_the_tag_list()
    • get_the_tags()
    • is_tag()
    • single_tag_title()
    • tag_description()
    • wp_generate_tag_cloud()
    • wp_tag_cloud()

    WordPress模板函数comments_rss_link用于输出当前文章评论的RSS链接,不同于comments_link(),comments_rss_link()输出的是一个完整的链接,而不只是一个URL。

    comments_rss_link( string $link_text = 'Comments RSS' )
    

    函数参数

    $link_text

    字符串值,默认值:Comments RSS

    提供一个文本,用于链接的锚文本。

    函数使用示例

    <?php comments_rss_link('评论RSS'); ?>
    

    扩展阅读

    comments_rss_link()函数位于:wp-includes/deprecated.php

    相关函数:

    • cancel_comment_reply_link()
    • comment_author()
    • comment_author_email()
    • comment_author_email_link()
    • comment_author_IP()
    • comment_author_link()
    • comment_author_rss()
    • comment_author_url()
    • comment_author_url_link()
    • comment_class()
    • comment_date()
    • comment_excerpt()
    • comment_form_title()
    • comment_form()
    • comment_ID()
    • comment_id_fields()
    • comment_reply_link()
    • comment_text()
    • comment_text_rss()
    • comment_time()
    • comment_type()
    • comments_link()
    • comments_number()
    • comments_open()
    • comments_popup_link()
    • comments_popup_script()
    • get_avatar()
    • next_comments_link()
    • paginate_comments_links()
    • permalink_comments_rss()
    • previous_comments_link()
    • wp_list_comments()

    WordPress模板函数comments_link用于输出评论链接,点击该链接可以跳转到当前文章的评论区域,必须用在The Loop主循环中。

    该函数没有参数,直接调用即可。

    函数使用示例

    <a href="<?php comments_link(); ?>">
        发表评论
    </a>
    

    输出的链接如下所示:

    https://www.beizigen.com/614.html#respond
    

    扩展阅读

    comments_link()函数位于:wp-includes/comment-template.php

    相关函数:

    • cancel_comment_reply_link()
    • comment_author()
    • comment_author_email()
    • comment_author_email_link()
    • comment_author_IP()
    • comment_author_link()
    • comment_author_rss()
    • comment_author_url()
    • comment_author_url_link()
    • comment_class()
    • comment_date()
    • comment_excerpt()
    • comment_form_title()
    • comment_form()
    • comment_ID()
    • comment_id_fields()
    • comment_reply_link()
    • comment_text()
    • comment_text_rss()
    • comment_time()
    • comment_type()
    • comments_number()
    • comments_open()
    • comments_popup_link()
    • comments_popup_script()
    • comments_rss_link()
    • get_avatar()
    • next_comments_link()
    • paginate_comments_links()
    • permalink_comments_rss()
    • previous_comments_link()
    • wp_list_comments()

    WordPress文章评论数量函数:comments_numbere

    WordPress模板函数comments_number用于输出当前文章的评论数量,必须用在The Loop主循环中。

    comments_number( string $zero = false, string $one = false, string $more = false )
    

    函数参数

    $zero

    字符串值,默认值:No Comments

    如果该文章没有评论,则显示$zero的值。

    $one

    字符串值,默认值:1 Comment

    如果该文章只有1条评论,则显示$one的值。

    $more

    字符串值,默认值:% Comments

    如果该文章的评论数量大于1,则显示$more的值,其中,% 表示评论的总数。

    函数使用示例

    <p>
    	文章评论:
    	<?php comments_number('没有评论', '1条评论', '%条评论'); ?>
    </p>
    

    扩展阅读

    comments_number()函数函数位于:wp-includes/comment-template.php

    相关函数:

    • cancel_comment_reply_link()
    • comment_author()
    • comment_author_email()
    • comment_author_email_link()
    • comment_author_IP()
    • comment_author_link()
    • comment_author_rss()
    • comment_author_url()
    • comment_author_url_link()
    • comment_class()
    • comment_date()
    • comment_excerpt()
    • comment_form_title()
    • comment_form()
    • comment_ID()
    • comment_id_fields()
    • comment_reply_link()
    • comment_text()
    • comment_text_rss()
    • comment_time()
    • comment_type()
    • comments_link()
    • comments_open()
    • comments_popup_link()
    • comments_popup_script()
    • comments_rss_link()
    • get_avatar()
    • next_comments_link()
    • paginate_comments_links()
    • permalink_comments_rss()
    • previous_comments_link()
    • wp_list_comments()

    WordPress输出评论ID函数:comment_ID

    WordPress模板函数comment_ID用于输出当前评论的ID,通常用在自定义评论模板。

    comment_ID()
    

    comment_ID()函数没有参数,直接调用即可。

    函数使用示例

    <p>这条评论的ID是:<?php comment_ID(); ?></p>
    

    扩展阅读

    comment_ID()函数位于:wp-includes/comment-template.php

    相关函数:

    • cancel_comment_reply_link()
    • comment_author()
    • comment_author_email()
    • comment_author_email_link()
    • comment_author_IP()
    • comment_author_link()
    • comment_author_rss()
    • comment_author_url()
    • comment_author_url_link()
    • comment_class()
    • comment_date()
    • comment_excerpt()
    • comment_form_title()
    • comment_form()
    • comment_id_fields()
    • comment_reply_link()
    • comment_text()
    • comment_text_rss()
    • comment_time()
    • comment_type()
    • comments_link()
    • comments_number()
    • comments_open()
    • comments_popup_link()
    • comments_popup_script()
    • comments_rss_link()
    • get_avatar()
    • next_comments_link()
    • paginate_comments_links()
    • permalink_comments_rss()
    • previous_comments_link()
    • wp_list_comments()

    WordPress模板函数comments_popup_link用于输出弹出评论的链接,当使用了comments_popup_script()函数时,点击该链接可实现弹出窗口评论,如果没有使用comments_popup_script()函数,则输出普通的跳转到评论区域的链接。

    由于comments_popup_script()函数在WordPress 4.5版本已弃用,所以comments_popup_link()也变得没有意义。

    comments_popup_link( string $zero = false, string $one = false, string $more = false, string $css_class = '', string $none = false )
    

    函数参数

    $zero

    字符串值,默认值:No Comments

    没有评论时显示的内容。

    $one

    字符串值,默认值:1 Comment

    只有一条评论时显示的内容。

    $more

    字符串值,默认值:% Comments

    大于一条评论时显示的内容。

    $css_class

    字符串值,默认值为空

    链接的class类名称

    $none

    字符串值,默认值:Comments Off

    评论关闭时显示的内容

    函数使用示例

    <p>
    <?php
    	comments_popup_link( '没有评论', '1条评论', '%条评论', 'comments-link', '当前文章不允许评论');
    ?>
    </p>
    

    WordPress弹出评论脚本函数:comments_popup_script

    WordPress模板函数comments_popup_script用于输出支持弹出评论的JS脚本,可以使comments_popup_link()输出的链接实现弹出窗口中评论,通常在函数之内使用。

    comments_popup_script()在WordPress 4.5版本已弃用,可能是使用比较少的原因。

    comments_popup_script(integer $width = 400, integer $height = 400, string $file = '')
    

    函数参数

    $width

    整数型,默认值:400(单位是像素)

    指定弹出窗口的宽度

    $height

    整数型,默认值:400(单位是像素)

    指定弹出窗口的高度

    $file

    字符串值,默认值:none

    弹出窗口的位置

    函数使用示例

    <?php comments_popup_script(); ?>
    

    WordPress生成评论表单隐藏域函数:comment_id_fields

    WordPress模板函数comment_id_fields用于在评论表单生成两个隐藏的域,保存当前文章ID和父评论的ID。

    comment_id_fields( integer $id = 0 )
    

    函数参数

    $id

    整数型,默认值:0

    提供一个评论ID,隐藏域将基于这条评论来生成。

    函数使用示例

    <?php comment_id_fields(); ?>
    

    这将输出:

    <input type="hidden" name="comment_post_ID" value="670" id="comment_post_ID">
    <input type="hidden" name="comment_parent" id="comment_parent" value="0">
    

    WordPress模板函数comment_author_link用于输出带链接的评论作者名称,通常用于自定义评论模板中。

    comment_author_link( integer $comment_ID = 0 )
    

    函数参数

    $comment_ID

    整数型,默认值:0

    提供评论ID则输出该评论的作者链接。

    函数使用示例

    <p>Comment by: <?php comment_author_link(); ?></p>
    

    WordPress评论作者函数:comment_author

    WordPress模板函数comment_author用于在评论模板中输出当前评论的作者,通常在自定义输出评论列表中使用。

    comment_author( integer $comment_ID = 0 )
    

    函数参数

    $comment_ID

    整数型,默认值:0

    指定评论ID,则输出该评论的作者名称。

    函数使用示例

    <div>评论作者:<?php comment_author(); ?></div>
    

    WordPress评论作者URL函数:comment_author_url

    WordPress模板函数comment_author_url用于输出评论作者的主页链接,通常用在自定义评论模板中。

    comment_author_url( integer $comment_ID = 0 )
    

    函数参数

    $comment_ID

    整数型,默认值:0

    提供一个评论ID,输入该评论的作者主页链接。

    函数使用示例

    <a href="<?php comment_author_url(); ?>">Visit 
    <?php comment_author(); ?>'s site</a>
    

    WordPress模板函数comment_author_email_link用于输出评论作者的邮箱链接,通常用于自定义评论模板中。

    comment_author_email_link( string $linktext = '', string $before = '', string $after = '', int $comment = null )
    

    函数参数

    $linktext

    字符串值,默认值:评论作者的Email

    提供一个文本作为链接的锚文本

    $before

    字符串值,默认值为空

    链接前的文本(不可点击)

    $after

    字符串值,默认值为空

    链接后的文本(不可点击)

    函数使用示例

    Email: <?php comment_author_email_link(); ?>
    

    WordPress评论者邮箱函数:comment_author_email

    WordPress模板函数comment_author_email用于输出评论者的邮箱地址,通常用在自定义评论模板中。

    comment_author_email( integer $comment_ID = 0 )
    

    函数参数

    $comment_ID

    整数型,默认值:0

    指定一个评论ID,则输出该评论的作者邮箱地址。

    函数使用示例

    以下示例会输出一个作者名称的链接,点击链接调用邮件客户端给评论作者发送邮件

    <a href="mailto:<?php comment_author_email(); ?>"><?php comment_author(); ?></a>
    

    WordPress评论作者IP函数:comment_author_IP

    WordPress模板函数comment_author_IP用于输出评论作者的IP地址,通常用来识别垃圾评论、灌水。

    comment_author_IP( integer $comment_ID = 0 )
    

    函数参数

    $comment_ID

    整数型,默认值:0

    指定一个评论ID,则输出该评论作者的IP地址。

    函数使用示例

    <?php comment_author_IP($comment_ID); ?>
    

    WordPress模板函数comment_author_url_link用于输出评论作者主页链接,与comment_author_url()函数的区别在于comment_author_url_link()函数输出的是可点击的URL,而comment_author_url()函数只输出一个单纯的URL,而comment_author_link()函数与前两函数的区别在于锚文本是作者名称。

    comment_author_url_link( string $linktext = '', string $before = '', string $after = '', integer $comment = 0 )
    

    函数参数

    $linktext

    字符串值,默认值:评论作者的主页URL

    提供一个字符串作为链接的锚文本。

    $before

    字符串值,默认值为空

    提供一个字符串在链接前输出。

    $after

    字符串值,默认值为空

    提供一个字符串在链接后面输出。

    $comment

    整数型,默认值:0

    指定一个评论ID,则输出该评论作者的主页链接。

    函数使用示例

    <?php comment_author_url_link('查看评论作者主页', ' &bull; ', ' &bull; '); ?>
    

    WordPress评论类型函数:comment_type

    WordPress模板函数comment_type用于输出评论类型,通常用在自定义评论模板中。WordPress的评论类型有:comment、trackback、pingback

    comment_type( string $commenttxt = false, string $trackbacktxt = false, string $pingbacktxt = false )
    

    函数参数

    $comment

    字符串值,默认值:Comment

    描述“评论”这种评论类型的文本

    $trackback

    字符串值,默认值:Trackback

    描述“Trackback”类型的评论的文本

    $pingback

    字符串值,默认值:Pingback

    描述“Pingback”类型的评论的文本

    函数使用示例

    <p><?php comment_type(); ?> to <?php the_title(); ?>: </p>
    

    WordPress评论摘要函数:comment_excerpt

    WordPress模板函数comment_excerpt用于输出评论摘要,默认输出20个字符,通常用在自定义评论模板中。

    comment_excerpt( integer $comment_ID = 0 )
    

    函数参数

    $comment_ID

    整数型,默认值:0

    指定一个评论的ID,则输出该评论的摘要

    函数使用示例

    <?php comment_excerpt( $comment_ID ); ?>
    

    WordPress评论内容函数:comment_text

    WordPress模板函数comment_text用于输出评论内容,通常用在自定义评论模板中。

    comment_text( integer $comment_ID = 0, array $args = array() )
    

    函数参数

    $comment_ID

    整数型,默认值:0

    指定一个评论ID,则输出该评论的内容。

    $args

    数组,默认为空

    可选的数组参数,为comment_text()函数提供额外的值。

    函数使用示例

    <li><?php comment_author(); ?>说:<br /> 
    <?php comment_text(); ?></li>
    

    WordPress评论表单标题函数:comment_form_title

    WordPress模板函数comment_form_title用于输出评论表单的标题,通常用在自定义评论模板中。

    comment_form_title( string $noreplytext = false, string $replytext = false, boolean $linktoparent = true )
    

    函数参数

    $noreplytext

    字符串值,默认值:Leave a Reply

    在没有点击回复评论时显示的文本,默认为“发表评论”

    $replytext

    字符串值,默认值:Leave a Reply to %s

    如果点击了“回复”,则显示该文本,其中%s为评论作者的名称

    $linktoparent

    布尔值,默认值:true

    评论作者的名称是否带有一个指向该评论楼层的链接。

    函数使用示例

    <h3><?php comment_form_title( '发表评论', '回复 %s 的评论' ); ?></h3>
    

    WordPress评论时间函数:comment_time

    WordPress模板函数comment_time用于输出当前评论的发表时间,与comment_date()函数不同之处在于comment_time()默认只输出时间,而comment_date()函数默认只输出日期。

    comment_time( string $d = '' )
    

    函数参数

    $d

    字符串值,默认值:取WordPress后台设置的日期格式

    指定评论日期的格式

    函数使用示例

    <p>发表评论的时间:<?php comment_time('H:i:s'); ?></p>
    

    WordPress评论日期函数:comment_date

    WordPress模板函数comment_date用于输出评论的日期,通常用在自定义评论模板中。

    comment_date( string $d = '', integer $comment_ID = 0 )
    

    函数参数

    $d

    字符串值,默认值:取WordPress后台设置的日期格式

    指定评论日期的格式

    $comment_ID

    整数型,默认值:0

    指定一个评论的ID,则输出该评论的日期

    函数使用示例

    <div>评论日期:<?php comment_date('n-j-Y'); ?></div>
    

    WordPress模板函数comment_reply_link用于输出评论回复链接,通常用在自定义评论模板中。

    comment_reply_link( array $args = array(), integer $comment = null, integer $post = null )
    

    函数参数

    $args

    数组,默认值如下:

    $defaults = array(
    	'add_below'     => 'comment',
    	'respond_id'    => 'respond',
    	'reply_text'    => __( 'Reply' ),
    	/* translators: Comment reply button text. 1: Comment author name */
    	'reply_to_text' => __( 'Reply to %s' ),
    	'login_text'    => __( 'Log in to Reply' ),
    	'max_depth'     => 0,
    	'depth'         => 0,
    	'before'        => '',
    	'after'         => ''
    );
    

    $args参数可用的值如下:

    add_below

    字符串值,默认值:comment

    JavaScript addComment.moveForm()方法的参数,例如:{$add_below}-{$id},则评论容器的ID为类似:comment-23

    respond_id

    字符串值,默认值:respond

    JavaScript addComment.moveForm()方法的参数

    reply_text

    字符串值,默认值:Reply

    回复链接的锚文本

    login_text

    字符串值,默认值:Log in to Reply

    只有在“需要登录才能发表评论”时显示

    depth

    整数型,默认值:0

    新评论的的层级数

    before

    字符串值,默认为空

    在回复评论链接前添加的字符

    after

    字符串值,默认为空

    在回复评论链接后面添加的字符

    $comment

    整数型,默认值:null

    要显示的评论ID

    $post

    整数型,默认值:null

    要显示的评论所在的文章ID

    函数使用示例

    <?php comment_reply_link(); ?>
    

    WordPress模板函数previous_comments_link输出上一页评论链接,用于在评论模板中制作评论翻页导航。

    previous_comments_link( string $label = '' )
    

    函数参数

    函数使用示例

    <?php previous_comments_link( '« Older Comments' ); ?>
    

    WordPress模板函数cancel_comment_reply_link输出一个取消评论回复的链接,通常用在自定义评论模板中。

    cancel_comment_reply_link( string $text = '' )
    

    函数参数

    $text

    字符串值,默认值:Click here to cancel reply

    提供一个字符作为链接的锚文本

    函数使用示例

    <?php cancel_comment_reply_link( 'Cancel Reply' ); ?>
    

    WordPress文章发表时间函数:the_time

    WordPress模板函数the_time输出当前文章的发表时间,需要用在The Loop主循环中。

    the_time( string $d = '' )
    

    函数参数

    $d

    字符串值,默认为WordPress后台常规设置中的时间格式

    时间格式

    函数使用示例

    <p>文章发表时间: <?php the_time('g:i a'); ?></p>
    

    WordPress模板函数paginate_comments_links输出数字形式的评论翻页导航,通常用在自定义评论模板中。

    paginate_comments_links( array $args = array() )
    

    函数参数

    $args

    数组,默认值如下:

    $defaults = array(
    	'base' => add_query_arg( 'cpage', '%#%' ),
    	'format' => '',
    	'total' => $max_page,
    	'current' => $page,
    	'echo' => true,
    	'add_fragment' => '#comments'
    );
    

    函数使用示例

    <div class="navigation">
    	<?php paginate_comments_links(); ?>
    </div>
    <ol class="commentlist">
    	<?php wp_list_comments(); ?>
    </ol>
    <div class="navigation">
    	<?php paginate_comments_links(); ?>
    </div>
    

    WordPress模板函数next_comments_link输出下一页评论链接,用于在评论模板中制作翻页导航。

    next_comments_link( string $label = '', integer $max_page = 0 )
    

    函数参数

    $label

    字符串值,默认值:Newer Comments »

    链接的锚文本

    $max_pages

    整数型,默认值:0

    翻页的最大页码数,默认值无限制

    函数使用示例

    <?php next_comments_link( 'Newer Comments »', 0 ); ?>
    

    WordPress文章发表日期函数:the_date

    WordPress模板函数the_date输出当前文章的发表日期,需要用在The Loop主循环中。

    the_date( string $d = '', string $before = '', string $after = '', boolean $echo = true )
    

    函数参数

    $d

    字符串值,默认值:WordPress选项中设置的值

    日期的格式

    $before

    字符串值,默认为空

    日期前输出的文本

    $after

    字符串值,默认为空

    日期后输出的文本

    $echo

    布尔值,默认值:True

    输出日期还是只返回相应的值,默认输出。

    函数使用示例

    <?php the_date('Y-m-d', '<h2>', '</h2>'); ?>
    

    WordPress文章修改时间函数:the_modified_time

    WordPress模板函数the_modified_time输出文章修改时间,需要用在The Loop主循环里。

    the_modified_time( string $d = '')
    

    函数参数

    $d

    字符串值,默认值:WordPress后台选项中设置的日期格式

    定义日期的格式

    函数使用示例

    <p>最后修改: <?php the_modified_time(); ?></p>
    

    扩展阅读

    the_modified_time()函数位于:wp-includes/general-template.php

    相关函数:

    • get_the_date()
    • get_the_time()
    • the_date()
    • get_the_modified_date()
    • the_modified_date()
    • get_the_modified_time()
    • the_time()

    WordPress XML格式文章发表日期函数:the_date_xml

    WordPress模板函数the_date_xml输出XML格式的文章发表日期,一般用得比较少。

    the_date_xml()
    

    该函数没有参数,直接调用即可。

    函数使用示例

    <p>Date posted: <?php the_date_xml(); ?></p>
    

    扩展阅读

    the_date_xml()函数位于:wp-includes/general-template.php

    相关函数:

    • get_the_date()
    • get_the_time()
    • the_date()
    • the_modified_date()
    • get_the_modified_date()
    • the_modified_time()
    • get_the_modified_time()
    • the_time()

    WordPress月份归档页标题函数:single_month_title

    WordPress模板函数single_month_title仅在月份归档页输出年月标题,即使年份归档页也不会输出任何内容。

    single_month_title( string $prefix = '', boolean $display = true )
    

    函数参数

    $prefix

    字符串值,默认为空

    在输出的月份归档标题内容前输出

    $display

    布尔值,默认值:true

    输出标题还是只返回值,默认输出。

    函数使用示例

    <p><?php single_month_title('<br />') ?></p>
    

    扩展阅读

    single_month_title()函数位于:wp-includes/general-template.php

    相关函数:

    • get_the_date()
    • get_the_time()
    • the_date()
    • the_modified_date()
    • get_the_modified_date()
    • the_modified_time()
    • get_the_modified_time()
    • the_time()

    WordPress文章修改作者函数:the_modified_author

    WordPress模板函数the_modified_author输出文章的最后修改作者名称,需要用在The Loop主循环里。

    the_modified_author()
    

    该函数没有参数,直接调用即可。

    函数使用示例

    <p>文章最后由 <?php the_modified_author(); ?> 修改</p>
    

    WordPress文章修改日期函数:the_modified_date

    WordPress模板函数the_modified_date输出文章最后修改日期,需要用在The Loop主循环里。

    the_modified_date( string $d = '', string $before = '', string $after = '', boolean $echo = true )
    

    函数参数

    $d

    字符串值,默认值:WordPress后台选项中设置的日期格式

    指定日期的格式

    $before

    字符串值,默认为空

    日期前输出的内容

    $after

    字符串值,默认为空

    日期后面输出的内容

    $echo

    布尔值,默认值:true

    是否输出日期,还是只返回值,默认输出。

    函数使用示例

    <p>文章最后修改日期: <?php the_modified_date(); ?></p>
    

    WordPress模板函数get_day_link用来生成日期归档页链接,需要注意这个函数的三个参数都必须传递,否则会输出当前日期的链接并报错。

    get_day_link( integer $year, integer $month, integer $day)
    

    函数参数

    $year

    整数型,默认为空

    指定年份

    $month

    整数型,默认为空

    指定月份

    $day

    整数型,默认为空

    指定日期

    函数使用示例

    <a href="<?php echo get_day_link('', '', ''); ?>">今天发表的文章</a>
    

    WordPress获取文章发表时间函数:get_the_time

    WordPress模板函数get_the_time获取当前文章的发表时间,与the_time()函数的区别在于get_the_time()函数只返回获取到的值,而the_time()函数直接输出结果。该函数需要用在The Loop主循环中。

    get_the_time( string $d = '', integer/object $post = null )
    

    函数参数

    $format

    字符串值,默认为WordPress后台常规设置中的时间格式

    时间格式

    $post

    整数型或对象,默认值:当前文章ID

    指定一个文章ID或包含文章信息的对象

    函数使用示例

    <?php echo get_the_time('', $post->ID); ?>
    

    WordPress日历函数:get_calendar

    WordPress模板函数get_calendar用于输出日历,如果某天有发表文章,点击该日期可以到达该日期归档页面。

    get_calendar( boolean $initial = true, boolean $echo = true )
    

    函数参数

    $initial

    布尔值,默认值:true

    如果为false,则显示为本地化的日期

    $echo

    布尔值,默认值:true

    如果为false,则只返回结果,不直接输出。

    函数使用示例

    <?php get_calendar(false); ?>
    

    WordPress模板函数get_year_link用来生成年份归档页链接,年份参数必须传递,否则输出当前年份链接并报错。

    get_year_link( integer $year )
    

    函数参数

    $year

    整数型,默认为空

    指定年份

    函数使用示例

    <a href="<?php echo get_year_link( $archive_year ); ?>"><?php the_time('Y'); ?> archive</a>
    

    WordPress模板函数get_month_link用来生成月份归档页链接,需要注意这个函数的两个参数都必须传递,否则会输出当前月份的链接并报错。

    get_month_link( integer $year, integer $month)
    

    函数参数

    $year

    整数型,默认为空

    指定年份

    $month

    整数型,默认为空

    指定月份

    函数使用示例

    <a href="<?php echo get_month_link('', ''); ?>">本月发表的文章</a>
    

    WordPress分类摘要函数:category_description

    WordPress模板函数category_description输出分类、函数的摘要,一般用在分类页、函数页、描述函数中。

    category_description( integer $category = 0 )
    

    函数参数

    $category

    整数型,默认值:当前分类/函数ID

    指定一个分类/函数ID,则输出该分类/函数的摘要

    函数使用示例

    <div><?php echo category_description(3); ?></div>
    

    扩展阅读

    category_description()函数位于:wp-includes/category-template.php

    相关函数:

    • the_category()
    • the_category_rss()
    • single_cat_title()
    • wp_dropdown_categories()
    • wp_list_categories()
    • get_category_parents()
    • get_the_category()
    • get_category_link()
    • in_category()

    WordPress分类标题函数:single_cat_title

    WordPress模板函数single_cat_title用于在分类页输出分类标题,使用比较少见。

    single_cat_title( string $prefix = '', bool $display = true )
    

    函数参数

    $prefix

    字符串值,默认为空

    在分类标题前输出的字符串

    $display

    布尔值,默认值:true

    值为false时,只返回结果而不是输出结果。

    函数使用示例

    <?php single_cat_title('分类:'); ?>
    

    扩展阅读

    single_cat_title()函数位于:wp-includes/general-template.php

    相关函数:

    • the_category()
    • the_category_rss()
    • category_description()

    WordPress获取当前分类信息函数:get_the_category

    WordPress模板函数get_the_category用于获取当前分类信息,包含分类ID、分类名称、分类别名、分类描述、父分类ID、分类下文章数量等。

    get_the_category( int $id = false )
    

    函数参数

    $id

    整数型,默认值:当前文章的ID

    指定文章的ID,将返回该文章所属分类的信息。

    函数返回值

    Array (
        [0] => WP_Term Object
            (
                [term_id] => 7
                [name] => 互联网
                [slug] => internet
                [term_group] => 0
                [term_taxonomy_id] => 7
                [taxonomy] => category
                [description] => 聚焦互联网业界动态,关注互联网发展中的人和事,提供最新的互联网资讯,分享互联网知识和技术。
                [parent] => 0
                [count] => 38
                [filter] => raw
                [cat_ID] => 7
                [category_count] => 38
                [category_description] => 聚焦互联网业界动态,关注互联网发展中的人和事,提供最新的互联网资讯,分享互联网知识和技术。
                [cat_name] => 互联网
                [category_nicename] => internet
                [category_parent] => 0
            )
    )
    

    函数使用示例

    <?php
    	$categorys = get_the_category();
    	foreach ($categorys as $category) {
    		echo $category->name;
    	}
    ?>
    

    扩展阅读

    get_the_category()函数位于:wp-includes/category-template.php

    相关函数:

    • the_category()
    • the_category_rss()
    • single_cat_title()
    • category_description()
    • wp_dropdown_categories()
    • wp_list_categories()
    • get_category_parents()
    • get_category_link()
    • in_category()

    WordPress获取父分类函数:get_category_parents

    WordPress模板函数get_category_parents用于获取父分类,在制作面包屑导航时非常有用。

    get_category_parents( integer $id, boolean $link = false, string $separator = '/', boolean $nicename = false, array $deprecated = array() )
    

    函数参数

    $id

    整数型,默认为空

    指定分类的ID,将输出该分类及其父分类,该参数不能为空,否则返回空数组并报错。

    $link

    布尔值,默认值:false

    输出的分类名称是否带有链接,默认不带链接

    $separator

    字符串值,默认值:/

    各个分类之间的分隔符,可以是HTML函数,例如:

    $nicename

    布尔值,默认值:false

    是否输出分类别名,默认输出分类名称。

    $deprecated

    数组,默认为空

    函数使用示例

    <?php echo get_category_parents( $cat, true, ' <br /> ' ); ?>
    

    扩展阅读

    get_category_parents()函数位于:wp-includes/category-template.php

    相关函数:

    • the_category()
    • the_category_rss()
    • single_cat_title()
    • category_description()
    • wp_dropdown_categories()
    • wp_list_categories()
    • get_the_category()
    • get_category_link()
    • in_category()

    WordPress判断文章是否属于某分类函数:in_category

    WordPress模板函数in_category用于判断文章是否属于某分类,该函数只能在The Loop主循环中使用,如果有明确指定文章ID,那么可以在任何地方使用。

    in_category( int|string|array $category, int|object $post = null )
    

    函数参数

    $category

    整数/字符串/数组,默认为空

    分类的ID,可以是多个。

    $post

    整数/对象,默认值:当前文章ID

    如果在主循环中使用,可以不指定该参数的值,默认取当前文章的ID,在主循环之外使用,需要明确指定文章ID

    函数使用示例

    <?php
    	if( in_category( array(2,6,8), $post->ID )) {
    		echo 'yes';
    	} else {
    		echo 'no';
    	}
    ?>
    

    扩展阅读

    in_category()函数位于:wp-includes/category-template.php

    相关函数:

    • the_category()
    • the_category_rss()
    • single_cat_title()
    • category_description()
    • wp_dropdown_categories()
    • wp_list_categories()
    • get_category_parents()
    • get_the_category()
    • get_category_link()

    WordPress模板函数get_category_link根据传递的分类ID返回相应分类的固定链接,在WordPress主题开发中也常用到。

    get_category_link( integer $category )
    

    函数参数

    $category

    整数型,默认值:none

    必须指定一个分类ID,以返回相应分类的链接

    函数使用示例

    <?php get_category_link( 6 ); ?>
    

    扩展阅读

    get_category_link()函数位于:wp-includes/category-template.php

    • the_category()
    • the_category_rss()
    • single_cat_title()
    • category_description()
    • wp_dropdown_categories()
    • wp_list_categories()
    • get_category_parents()
    • get_the_category()
    • in_category()

    WordPress作者文章数量函数:the_author_posts

    WordPress模板函数the_author_posts输出当前作者发表的文章总数,不包含草稿、私密文章,必须用在The Loop主循环中。

    the_author_posts()
    

    函数使用示例

    <p><?php the_author(); ?> 共发表了 <?php the_author_posts(); ?> 篇文章</p>
    

    扩展阅读

    the_author_posts()函数位于:wp-includes/author-template.php

    相关函数:

    • the_author()
    • get_the_author()
    • get_the_author_id()
    • the_author_link()
    • get_the_author_link()
    • the_author_meta()
    • get_the_author_meta()
    • get_the_author_posts()
    • the_author_posts_link()
    • get_author_posts_url()
    • get_the_modified_author()
    • the_modified_author()
    • wp_dropdown_users()
    • wp_list_authors()

    WordPress模板函数the_author_link输出带作者主页链接的作者名称,也就是作者在个人资料中设置的“站点”的链接,必须用在The Loop主循环中。

    the_author_link()
    

    the_author_link()函数没有任何参数,直接调用即可。

    函数使用示例

    <p>作者: <?php the_author_link(); ?></p>
    

    扩展阅读

    the_author_link()函数位于:wp-includes/author-template.php

    相关函数:

    • the_author()
    • get_the_author()
    • get_the_author_id()
    • get_the_author_link()
    • the_author_meta()
    • get_the_author_meta()
    • the_author_posts()
    • get_the_author_posts()
    • the_author_posts_link()
    • get_author_posts_url()
    • get_the_modified_author()
    • the_modified_author()
    • wp_dropdown_users()
    • wp_list_authors()

    WordPress作者名称函数:the_author

    WordPress模板函数the_author用于输出当前文章作者的名称,必须用在The Loop主循环中。

    the_author()
    

    the_author()函数没有任何参数,直接调用即可。

    函数使用示例

    <p>作者:<?php the_author(); ?></p>
    

    扩展阅读

    the_author()函数位于:wp-includes/author-template.php

    相关函数:

    • get_the_author()
    • get_the_author_id()
    • the_author_link()
    • get_the_author_link()
    • the_author_meta()
    • get_the_author_meta()
    • the_author_posts()
    • get_the_author_posts()
    • the_author_posts_link()
    • get_author_posts_url()
    • get_the_modified_author()
    • the_modified_author()
    • wp_dropdown_users()
    • wp_list_authors()

    WordPress获取Tag摘要函数:tag_description

    WordPress模板函数tag_description用于获取函数的摘要,也就是获取函数设置里的“图像描述”内容,事实上tag_description()也可以获取分类的摘要,WordPress的分类与函数本就没有多大区别。

    tag_description( integer $tag = 0 )
    

    函数参数

    $tag_id

    整数型,默认值:当前函数ID

    指定一个函数ID,将返回该函数的摘要。

    函数使用示例

    <?php echo '函数描述:' . tag_description('28'); ?>
    

    扩展阅读

    tag_description()函数位于:wp-includes/category-template.php

    相关函数:

    • get_tag()
    • get_tag_link()
    • get_tags()
    • get_the_tag_list()
    • get_the_tags()
    • is_tag()
    • the_tags()
    • single_tag_title()
    • wp_generate_tag_cloud()
    • wp_tag_cloud()

    WordPress作者元数据函数:the_author_meta

    WordPress模板函数the_author_meta输出文章作者的元数据,如果在The Loop主循环之外使用,必须传递作者ID。

    the_author_meta( string $field = '', integer $user_id = false )
    

    函数参数

    $field

    字符串值,默认为空

    可选择的值如下:

    • user_login:登录账号
    • user_pass:加密后的密码
    • user_nicename:昵称
    • user_email:邮箱
    • user_url:用户主页
    • user_registered:注册时间
    • user_activation_key:用于验证找回密码链接是否还有效的Key
    • user_status:用户状态
    • display_name:用户个人资料里“公开显示为”设置的值
    • nickname:昵称
    • first_name:名字
    • last_name:姓氏
    • description:用户个人资料里“个人说明”
    • jabber:Jabber账号
    • aim:AIM账号
    • yim:YIM账号
    • user_level:用户等级
    • user_firstname:名字
    • user_lastname:姓氏
    • user_description:用户个人资料里“个人说明”
    • rich_editing:是否使用了可视化编辑器
    • comment_shortcuts:键盘快捷键
    • admin_color:管理界面配色方案
    • plugins_per_page:
    • plugins_last_view:
    • ID:用户ID

    $userID

    整数型,默认值:false

    如果在The Loop主循环中使用the_author_meta()函数,用户ID默认为当前文章作者的ID,如果在主循环之外使用,必须指定用户ID

    函数使用示例

    <p><?php the_author_meta('display_name'); ?>的注册时间:<?php the_author_meta('user_registered'); ?></p>
    

    扩展阅读

    函数位于:wp-includes/author-template.php

    相关函数:

    • the_author()
    • get_the_author()
    • get_the_author_id()
    • the_author_link()
    • get_the_author_link()
    • get_the_author_meta()
    • the_author_posts()
    • get_the_author_posts()
    • the_author_posts_link()
    • get_author_posts_url()
    • get_the_modified_author()
    • the_modified_author()
    • wp_dropdown_users()
    • wp_list_authors()

    WordPress模板函数the_author_posts_link用于输出指向当前作者所有文章页面的链接,其中锚文本为作者个人资料里“公开显示为”设置的名称。

    需要注意the_author_posts_link()函数与the_author_link()函数的区别,前者输出的是该作者的文章归档页面链接,而the_author_link()函数输出的是作者在个人资料中设置的“站点”链接。

    the_author_posts_link()
    

    the_author_posts_link()函数不接收任何参数,直接调用即可。

    函数使用示例

    <p>作者:<?php the_author_posts_link(); ?></p>
    

    扩展阅读

    the_author_link()函数位于:wp-includes/author-template.php

    相关函数:

    • the_author()
    • get_the_author()
    • get_the_author_id()
    • the_author_link()
    • get_the_author_link()
    • the_author_meta()
    • get_the_author_meta()
    • the_author_posts()
    • get_the_author_posts()
    • get_author_posts_url()
    • get_the_modified_author()
    • the_modified_author()
    • wp_dropdown_users()
    • wp_list_authors()

    WordPress生成函数云函数:wp_generate_tag_cloud

    WordPress模板函数wp_generate_tag_cloud用于生成函数名,必须传递一个包含函数信息的对象。

    wp_generate_tag_cloud( object $tags, array $args = '' )
    

    函数参数

    $tags

    对象,默认为空

    必须传递一个包含函数信息的对象,否则wp_generate_tag_cloud()函数不会返回任何值,可以通过get_tags()函数获取函数信息。

    $args

    数组

    参考wp_tag_cloud()函数的$args参数值说明。

    函数使用示例

    <?php echo wp_generate_tag_cloud( get_tags() ); ?>
    

    扩展阅读

    wp_generate_tag_cloud()函数位于:wp-includes/category-template.php

    相关函数:

    • get_tag()
    • get_tag_link()
    • get_tags()
    • get_the_tag_list()
    • get_the_tags()
    • is_tag()
    • the_tags()
    • single_tag_title()
    • tag_description()
    • wp_tag_cloud()

    WordPress函数云函数:wp_tag_cloud

    WordPress模板函数wp_tag_cloud用于输出函数云,函数的大小由该函数下的文章数量决定。

    wp_tag_cloud( array $args = '' )
    

    函数参数

    $args

    数组或字符串值

    wp_tag_cloud()函数$args参数默认的值如下:

    $args = array(
    	'smallest'                  => 8, 
    	'largest'                   => 22,
    	'unit'                      => 'pt', 
    	'number'                    => 45,  
    	'format'                    => 'flat',
    	'separator'                 => "n",
    	'orderby'                   => 'name', 
    	'order'                     => 'ASC',
    	'exclude'                   => null, 
    	'include'                   => null, 
    	'topic_count_text_callback' => default_topic_count_text,
    	'link'                      => 'view', 
    	'taxonomy'                  => 'post_tag', 
    	'echo'                      => true,
    	'child_of'                  => null,
    );
    

    wp_tag_cloud()函数$args参数可用的值如下:

    smallest

    整数型,默认值:8

    最小字号大小

    largest

    整数型,默认值:22

    最大字号大小

    unit

    字符串值,默认值:pt

    字号单位

    number

    整数型,默认值:45

    显示的函数数量

    format

    字符串值,默认值:flat

    列表的格式,可选值:

    • flat:空格;
    • list:UL列表;
    • array:数组;

    separator

    字符串值,默认值:n

    函数之间的文本

    orderby

    字符串值,默认值:name

    排序规则,可选值:

    • name:按名称排序;
    • count:按文章数量排序;

    order

    字符串值,默认值:ASC

    排序方式,可选值:

    • ASC:升序;
    • DESC:降序;
    • RAND:随机;

    exclude

    字符串值,默认值:null

    提供函数ID,以排除显示这些函数,多个函数ID用半角逗号分隔

    include

    字符串值,默认值:null

    提供函数ID,以显示这些函数,多个函数ID用半角逗号分隔

    topic_count_text_callback

    字符串值,默认值:default_topic_count_text

    指定一个函数名称,该函数返回的值将作为链接的title属性值,默认输出文章数量,例如:28个话题

    link

    字符串值,默认值:view

    链接的类型,可选值:

    • view:输出函数归档页面链接;
    • edit:当已登录且有编辑函数的权限时,输出编辑该函数的链接,否则输出首页链接;

    taxonomy

    字符串或数组,默认值:post_tag

    指定分类法名称,可选值:

    • post_tag:文章函数;
    • category:文章分类;
    • link_category:友情链接分类;

    echo

    布尔值,默认值:true

    是否输出返回结果

    函数使用示例

    <?php if ( function_exists( 'wp_tag_cloud' ) ) : ?>
    	<h2>函数云集</h2>
    	<ul>
    		<li><?php wp_tag_cloud( 'smallest=8&largest=22' ); ?></li>
    	</ul>
    <?php endif; ?>
    

    扩展阅读

    wp_tag_cloud()函数位于:wp-includes/category-template.php

    相关函数:

    • get_tag()
    • get_tag_link()
    • get_tags()
    • get_the_tag_list()
    • get_the_tags()
    • is_tag()
    • the_tags()
    • single_tag_title()
    • tag_description()
    • wp_generate_tag_cloud()

    WordPress获取Tag标题函数:single_tag_title

    WordPress模板函数single_tag_title输出当前函数(Tag)的标题,一般用在函数页。

    single_tag_title( string $prefix = '', boolean $display = true )
    

    函数参数

    $prefix

    字符串值,默认为空

    在标题前输出的字符

    $display

    布尔值,默认值:true

    是否输出返回的值,默认为输出。

    函数使用示例

    <p><?php single_tag_title('当前函数:'); ?></p>
    

    扩展阅读

    single_tag_title()函数位于:wp-includes/general-template.php

    相关函数:

    • get_tag()
    • get_tag_link()
    • get_tags()
    • get_the_tag_list()
    • get_the_tags()
    • is_tag()
    • the_tags()
    • tag_description()
    • wp_generate_tag_cloud()
    • wp_tag_cloud()

    WordPress获取当前文章Tag列表函数:get_the_tag_list

    WordPress模板函数get_the_tag_list用于获取当前函数列表,需要用在The Loop主循环中,如果在主循环之外使用,需要传递文章ID。

    get_the_tag_list( string $before = '', string $sep = '', string $after = '', integer $id = 0 )
    

    函数参数

    $before

    字符串值,默认为空

    在链接前输出

    $sep

    字符串值,默认为空

    在链接之间输出,用于分隔多个函数

    $after

    字符串值,默认为空

    在链接后输出

    $id

    整数型,默认值:当前文章ID

    指定一个文章ID,用于输出该文章的函数

    函数使用示例

    <?php echo get_the_tag_list('<p>函数: ', ', ', '</p>'); ?>
    

    扩展阅读

    get_the_tag_list()函数位于:wp-includes/category-template.php

    相关函数:

    • get_tag()
    • get_tag_link()
    • get_tags()
    • get_the_tags()
    • is_tag()
    • the_tags()
    • single_tag_title()
    • tag_description()
    • wp_generate_tag_cloud()
    • wp_tag_cloud()

    WordPress获取Tag信息函数:get_the_tags

    WordPress模板函数get_the_tags用于获取函数信息,包括函数ID、别名、名称、描述等。get_the_tags()函数需要用在The Loop主循环中,如果在主循环之外使用,需要传递文章ID。

    get_the_tags( int $id = 0 )
    

    函数参数

    $id

    整数型,默认值:当前文章ID

    指定文章ID,将返回该文章的函数信息。

    函数返回值

    Array (
    	[0] => WP_Term Object (
    		[term_id] => 27
    		[name] => CDN
    		[slug] => cdn
    		[term_group] => 0
    		[term_taxonomy_id] => 27
    		[taxonomy] => post_tag
    		[description] => CDN的全称是Content Delivery Network,即内容分发网络。
    		[parent] => 0
    		[count] => 11
    		[filter] => raw
    	)
    )
    

    函数使用示例

    <?php
    	$posttags = get_the_tags();
    	if ($posttags) {
    	  foreach($posttags as $tag) {
    		echo '函数ID:' . $tag->term_id;
    		echo '<br />函数名称:' . $tag->name;
    		echo '<br />函数描述:' . $tag->description;
    	  }
    	}
    ?>
    

    扩展阅读

    get_the_tags()函数位于:wp-includes/category-template.php

    相关函数:

    • get_tag()
    • get_tag_link()
    • get_tags()
    • get_the_tag_list()
    • is_tag()
    • the_tags()
    • single_tag_title()
    • tag_description()
    • wp_generate_tag_cloud()
    • wp_tag_cloud()

    WordPress模板函数edit_comment_link输出编辑评论的链接,需要用在The Loop主循环中。

    edit_comment_link( string $text = null, string $before = '', string $after = '' )
    

    函数参数

    $text

    字符串值,默认为空

    链接锚文本

    $before

    字符串值,默认为空

    链接前输出的字符

    $after

    字符串值,默认为空

    链接后输出的字符

    函数使用示例

    <?php edit_comment_link('编辑评论', '<p>', '</p>'); ?>
    

    扩展阅读

    edit_comment_link()函数位于:wp-includes/link-template.php

    相关函数:

    • edit_post_link()
    • edit_tag_link()
    • edit_bookmark_link()

    WordPress模板函数edit_post_link用于输出编辑文章的链接,必须用在The Loop主循环中。

    edit_post_link( string $text = null, string $before = '', string $after = '', integer $id = 0, string $class = 'post-edit-link' )
    

    函数参数

    $text

    字符串值,默认为空

    链接的锚文本

    $before

    字符串值,默认为空

    在链接前输出的文本

    $after

    字符串值,默认为空

    在链接后输出的文本

    $id

    整数型,默认值:0

    指定文章ID,输出该文章的编辑链接。

    $class

    字符串值,默认值:post-edit-link

    链接的类名

    函数使用示例

    <?php edit_post_link('编辑', '<p>', '</p>'); ?>
    

    扩展阅读

    edit_post_link()函数位于:wp-includes/link-template.php

    相关函数:

    • edit_comment_link()
    • edit_tag_link()
    • edit_bookmark_link()

    WordPress模板函数get_tag_link用于获取函数链接,该函数需要传递函数ID,以返回指定ID函数的链接。

    get_tag_link( integer $tag )
    

    函数参数

    $tag

    整数型,默认为空

    指定函数ID,将返回该函数的链接。

    函数使用示例

    <a href="<?php echo get_tag_link($tag_id); ?>">函数名称</a>
    

    扩展阅读

    get_tag_link()函数位于:wp-includes/category-template.php

    • get_tag()
    • get_tags()
    • get_the_tag_list()
    • get_the_tags()
    • is_tag()
    • the_tags()
    • single_tag_title()
    • tag_description()
    • wp_generate_tag_cloud()
    • wp_tag_cloud()

    WordPress模板函数edit_bookmark_link输出编辑友情链接的链接,需要用在The Loop主循环中,如果在主循环之外使用,需要传递链接的ID。

    edit_bookmark_link( string $link = '', string $before = '', string $after = '', int $bookmark = null )
    

    函数参数

    $link

    字符串值,默认为空

    链接的锚文本

    $before

    字符串值,默认为空

    在链接前输出的字符串

    $after

    字符串值,默认为空

    在链接后输出的字符串

    $bookmark

    整数型,默认值:当前链接ID

    指定一个链接ID,用于输出该链接的编辑链接。

    函数使用示例

    <?php edit_bookmark_link('编辑链接', '<p>', '</p>'); ?>
    

    扩展阅读

    edit_bookmark_link()函数位于:wp-includes/link-template.php

    相关函数:

    • edit_post_link()
    • edit_comment_link()
    • edit_tag_link()

    WordPress模板函数edit_tag_link用于输出编辑函数的链接,需要用在The Loop主循环中,如果在主循环之外使用,必须传递函数ID或包含函数信息的对象。

    edit_tag_link( string $link = '', string $before = '', string $after = '', integer/object $tag = null )
    

    函数参数

    $link

    字符串值,默认为空

    指定一个字符作为链接的锚文本

    $before

    字符串值,默认为空

    在链接前输出的字符串

    $after

    字符串值,默认为空

    在链接后输出的字符串

    $tag

    整数或对象,默认值:当前函数ID

    指定一个函数ID或包含函数信息的对象,将输出该函数的编辑链接。

    函数使用示例

    <?php edit_tag_link('编辑函数', '<p>', '</p>'); ?>
    

    扩展阅读

    edit_tag_link()函数位于:wp-includes/link-template.php

    相关函数:

    • edit_post_link()
    • edit_comment_link()
    • edit_bookmark_link()

    WordPress模板函数the_permalink用于输出文章的固定链接,即伪静态形式的链接地址,需要用在The Loop主循环中。

    the_permalink( $post = 0 )
    

    该函数没有参数,事实上the_permalink()函数相当于调用了get_permalink( $post ),将当前文章对象传递给了get_permalink()函数并输出返回的结果。

    函数使用示例

    <a href="<?php the_permalink(); ?>"><?php the_title(); ?></a>
    

    扩展阅读

    the_permalink()函数位于:wp-includes/link-template.php

    相关函数:

    • permalink_anchor()
    • get_permalink()
    • post_permalink()
    • permalink_single_rss()

    WordPress模板函数get_permalink用于获取文章的固定链接,也就是伪静态链接,需要用在The Loop主循环中,如果在主循环之外使用,需要传递文章ID或包含文章信息的对象。

    get_permalink( int|WP_Post $post = 0, bool $leavename = false )
    

    函数参数

    $post

    整数或对象,默认值:当前文章的ID

    提供一个文章ID或包含文章信息的对象,输出该文章的固定链接。

    $leavename

    布尔值,默认值:false

    如果为true,则固定链接设置中的%postname%将原样输出,而不是输出文章名称。

    函数使用示例

    <?php echo '<a href="' . get_permalink() . '">' . get_the_title() . '</a>'; ?>
    

    扩展阅读

    get_permalink()函数位于:wp-includes/link-template.php

    相关函数:

    • permalink_anchor()
    • the_permalink()
    • post_permalink()
    • permalink_single_rss()

    WordPress文章添加锚函数:permalink_anchor

    WordPress模板函数permalink_anchor输出一个ID为post-ID的空链接,通常用于跳转页面到特定位置,需要用在The Loop主循环中。

    permalink_anchor( string $mode = 'id' )
    

    函数参数

    $mode

    字符串值,默认值:id

    可选的值:

    • id:空链接的ID值为post-ID,其中ID为文章的ID
    • title:空链接的ID值为文章别名

    函数使用示例

    <h3><?php permalink_anchor(); ?><?php the_title(); ?></h3>
    

    扩展阅读

    permalink_anchor()函数位于:wp-includes/link-template.php

    相关函数:

    • get_permalink()
    • the_permalink()
    • post_permalink()
    • permalink_single_rss()

    WordPress获取友情链接数据函数:get_bookmarks

    WordPress模板函数get_bookmarks用于获取友情链接数据,将返回所有友情链接的信息。

    get_bookmarks( array|string $args = '' )
    

    函数参数

    $args

    数组或字符串值

    get_bookmarks()函数$args参数默认的值如下:

    $args = array(
    	'orderby'			=> 'name',
    	'order'				=> 'ASC',
    	'limit'				=> -1,
    	'category'			=> '',
    	'category_name'			=> '',
    	'hide_invisible'		=> 1,
    	'show_updated'			=> 0,
    	'include'			=> '',
    	'exclude'			=> '',
    	'search'			=> ''
    );
    

    get_bookmarks()函数$args参数可用的值如下:

    orderby

    字符串值,默认值:name

    指定排序的方式,可用的值如下:

    • link_id:按照友情链接的ID排序;
    • url:按照链接排序;
    • name:按照名称排序;
    • owner:按照添加书签的用户排序;
    • rating:按照评论排序;
    • visible:按照可见度排序;
    • length:按照长度排序;
    • rand:随机顺序;

    order

    字符串值,默认值:ASC

    升序或降序排列:

    • ASC:升序排列;
    • DESC:降序排列;

    limit

    整数型,默认值:-1

    指定返回链接的数量,默认为返回所有链接。

    category

    字符串值,默认为空

    以逗号分隔的友情链接分类ID,指定返回哪些分类的链接,默认返回所有分类的链接。

    category_name

    字符串值,默认为空

    友情链接分类名称,指定返回哪个分类的链接。

    hide_invisible

    布尔值,默认值:true

    是否隐藏私密链接,true表示隐藏。

    show_updated

    布尔值,默认值:false

    如果为true,将额外返回link_category_f输出link_updated的值,但是以时间戳的形式。

    include

    字符串值,默认为空

    以逗号分隔的友情链接ID,将返回这些ID的链接信息。

    exclude

    字符串值,默认为空

    以逗号分隔的友情链接ID,返回结果中将排除这些ID的链接。

    search

    字符串值,默认为空

    搜索link_url、link_name、link_description的值,返回符合搜索字符的结果。

    函数返回值

    Array (
        [0] => stdClass Object
            (
                [link_id] => 16
                [link_url] => https://www.beizigen.com/
                [link_name] => 背字根
                [link_image] => 
                [link_target] => _blank
                [link_description] => 开发运营笔记
                [link_visible] => Y
                [link_owner] => 88891
                [link_rating] => 0
                [link_updated] => 0000-00-00 00:00:00
                [link_rel] => 
                [link_notes] => 
                [link_rss] => 
            )
    )
    

    函数使用示例

    <?php
    	$bookmarks = get_bookmarks( array(
    		'orderby'        => 'name',
    		'order'          => 'ASC',
    	));
    	foreach ( $bookmarks as $bookmark ) { 
    		printf( '<li><a class="relatedlink" href="%s">%s</a></li>', $bookmark->link_url, $bookmark->link_name );
    	}
    ?>
    

    扩展阅读

    get_bookmarks()函数位于:wp-includes/bookmark.php

    相关函数:

    • get_bookmark()
    • get_bookmark_field()
    • wp_list_bookmarks()

    WordPress RSS版本文章链接函数:permalink_single_rss

    WordPress模板函数permalink_single_rss输出RSS版本的文章链接,该函数在WordPress 2.3.0版本就废弃了,请使用the_permalink_rss()函数来替代。

    permalink_single_rss(string $deprecated = '')
    

    扩展阅读

    permalink_single_rss()函数位于:wp-includes/deprecated.php

    相关函数:

    • permalink_anchor()
    • get_permalink()
    • the_permalink()
    • post_permalink()

    WordPress获取链接指定信息函数:get_bookmark_fieldw

    WordPress模板函数get_bookmark_field获取指定链接的指定信息,例如获取指定链接ID的链接名称、链接地址等。

    get_bookmark_field( string $field, int $bookmark, string $context = 'display' )
    

    函数参数

    $field

    字符串值,默认为空

    指定要返回什么信息,可以参考get_bookmark()函数的返回值部分。

    $bookmark

    整数型,默认为空

    指定一个链接ID,将返回该链接的信息。

    $context

    字符串值,默认值:display

    等同于get_bookmark()函数的$filter参数作用。

    函数使用示例

    <?php echo get_bookmark_field('link_name', 17 ); ?>
    

    扩展阅读

    get_bookmark_field()函数位于:wp-includes/bookmark.php

    相关函数:

    • get_bookmark()
    • get_bookmarks()
    • wp_list_bookmarks()

    WordPress获取单个友链信息函数:get_bookmark

    WordPress模板函数get_bookmark返回单个友情链接的信息,而之前发表的get_bookmarks()函数则是返回一堆友情链接的信息,get_bookmark()函数需要用在The Loop主循环中,否则必须传递一个友情链接ID。

    get_bookmark(integer|object $bookmark, string $output = OBJECT, string $filter = 'raw')
    

    函数参数

    $bookmark

    整数或对象,默认值:当前友情链接

    指定一个友情链接的ID或包含友情链接信息的对象,将返回该链接的信息

    $output

    字符串值,默认值:OBJECT

    指定返回的数据格式,可选的值如下:

    • OBJECT:对象;
    • ARRAY_A:升序排列的数组;
    • ARRAY_N:降序排列的数组;

    $filter

    字符串值,默认值:raw

    是否使用过滤钩子,默认不使用,可用的值如下:

    • raw:不使用钩子;
    • edit:钩子名称 edit_$field;
    • db:钩子名称 pre_$field;
    • 其他值:钩子名称 $field;

    函数返回值

    stdClass Object
    (
        [link_id] => 8
        [link_url] => https://www.beizigen.com/
        [link_name] => 背字根
        [link_image] => 
        [link_target] => _blank
        [link_description] => 开发运营笔记。
        [link_visible] => Y
        [link_owner] => 88891
        [link_rating] => 0
        [link_updated] => 0000-00-00 00:00:00
        [link_rel] => 
        [link_notes] => 
        [link_rss] => 
        [link_category] => Array
            (
                [0] => 2
            )
    
    )
    

    函数使用示例

    以下示例输出友情链接的名称:

    <?php
    	$bookmark = get_bookmark(8);
    	echo $bookmark->link_name; 
    ?>
    

    扩展阅读

    get_bookmark()函数位于:wp-includes/bookmark.php

    相关函数:

    • get_bookmark_field()
    • get_bookmarks()
    • wp_list_bookmarks()

    WordPress输出RDF格式的Trackback函数:trackback_rdf

    WordPress模板函数trackback_rdf用于输出RDF格式的Trackback,需要用在The Loop主循环中。

    trackback_rdf( $deprecated = '' )
    

    该函数没有可用的参数,直接调用即可。

    函数使用示例

    <?php trackback_rdf(); ?>
    

    扩展阅读

    trackback_rdf()函数位于:wp-includes/comment-template.php

    相关函数:

    • trackback_url()

    WordPress输出Trackback链接函数:trackback_url

    WordPress模板函数trackback_url输出Trackback的URL,需要用在The Loop主循环中。

    trackback_url( boolean $deprecated_echo = true )
    

    该函数没有可用的参数,直接调用即可。

    函数使用示例

    <p>Trackback URL for this post: <?php trackback_url(); ?></p>
    

    扩展阅读

    trackback_url()函数位于:wp-includes/comment-template.php

    相关函数:

    • pingback()

    WordPress获取文章函数:get_posts

    WordPress模板函数get_posts用于获取文章信息,通常用于输出最新文章列表、随机文章、指定分类文章等等,在用WordPress制作CMS网站时非常有用。

    get_posts( array $args = null )
    

    函数参数

    $args

    数组或字符串值

    get_posts()函数$args参数默认的值如下:

    $defaults = array(
    	'numberposts' => 5,
    	'category' => 0,
    	'orderby' => 'date',
    	'order' => 'DESC',
    	'include' => array(),
    	'exclude' => array(),
    	'meta_key' => '',
    	'meta_value' => '',
    	'post_type' => 'post',
    	'suppress_filters' => true
    );
    

    get_posts()函数$args参数可用的值如下:

    orderby

    字符串值,默认值:date

    设置排序的类型。

    • none:不使用排序;
    • ID:按ID排序;
    • author:按作者排序;
    • title:按标题排序;
    • date:按日期排序;
    • modified:按文章的修改日期排序;
    • parent:按父级文章ID排序;
    • rand:随机顺序;
    • comment_count:按评论数量排序;
    • menu_order:如果页面,有一个排序设置项,则按这个设置排序;
    • meta_value:按元数据排序;
    • meta_value_num:按元数据排序;
    • post__in:按照传递参数的顺序。

    numberposts

    整数型,默认值:5

    指定输出文章的数量。

    category

    整数型,默认值:0

    指定分类的ID,输出该分类下的文章,默认所有分类。

    order

    字符串值,默认值:DESC

    指定排序的方式。

    • DESC:降序;
    • ASC:升序。

    include

    字符串或数组,默认为空

    指定文章的ID,以输出这些文章的信息。

    exclude

    字符串或数组,默认为空

    指定文章的ID,以排除这些文章。

    meta_key

    字符串值,默认为空

    自定义字段的名称。

    meta_value

    字符串值,默认为空

    自定义字段的值。

    post_type

    字符串值,默认值:post

    文章类型。

    • post:文章;
    • page:页面;
    • revision:文章的修订版本;
    • attachment:附件;
    • 自定义文章类型。

    suppress_filters

    布尔值,默认值:true

    是否使用过滤器。

    函数使用示例

    输出5篇分类1的文章

    <ul>
    <?php
    	global $post;
    	$args = array( 'numberposts' => 5, 'category' => 1 );
    	$myposts = get_posts( $args );
    	foreach ( $myposts as $post ) : 
    		setup_postdata( $post );
    ?>
    	<li><a href="<?php the_permalink(); ?>"><?php the_title(); ?></a></li>
    <?php
    	endforeach;
    	wp_reset_postdata();
    ?>
    </ul>
    

    扩展阅读

    get_posts()函数位于:wp-includes/post.php

    相关函数:

    • get_pages()

     

阅读剩余
THE END