WordPress函数
模板兔提供完善的WordPress常用函数使用介绍与方法,让您快速入门WordPress函数的使用。
我们在开发wordpress主题或者插件或者功能时时常会提交请求与验证请求,那么为了防止机器人请求,通常会增加一个验证机制。wp_create_nonce与wp_verify_nonce就是一个比较好用的验证方法。
比如我们在提交请求时传一个nonce参数,值可以是wp_create_nonce("mobantu-post-method"),这里的mobantu-post-method是自定义的一个标记。验证nonce时就用wp_verify_nonce($_POST['nonce'], 'mobantu-post-method'),post过来的nonce就是上面创建的值,后面标记要与前面创建时一致即可。
wp_verify_nonce返回值类型是bool型,可以直接判断验证是否通过。
wp_remote_get是模拟http的get请求然后返回数据。
参数有两个,wp_remote_get( string $url, array $args = array() ),一个传入请求的地址,另一个是请求配置参数,比如我们如果需要配置超时时间,可以这样使用。
$response = wp_remote_get( $url , array('timeout' => 3));
然后判断请求结果
if ( is_array( $response ) && !is_wp_error($response) && $response['response']['code'] == '200' ) {
}
我们在写wordpress后台用户查询时,往往都会涉及到用户的操作,涉及到用户的就会用到get_users函数,下面我们就来看看其用法吧。
函数
get_users( array $args = array() ) //检索匹配条件的用户列表
参数
(string|array) (Optional) 查询参数字符串或数组.
参数详解
blog_id
(int) 站点id 默认是当前选择的站点。
role
(string|array) 一个数组或以逗号分隔的角色名称列表,用户必须与之匹配才能将其包含在结果中。注意,这是一个包含所有内容的列表:用户必须匹配每个角色。
role__in
(array)一个角色名称数组。匹配的用户必须至少具有其中一个角色。
role__not_in
(array) 要排除的角色名称数组。匹配一个或多个...
函数介绍
返回保存在特定帖子上的所有字段的设置。
每个字段都包含许多设置,例如标签、名称和类型。 此函数可用于将这些设置与字段值一起加载为数组。
函数字段
get_field_objects( [$post_id = false], [$format_value = true], [$load_value = true] );
$post_id (混合)(可选)保存值的帖子 ID。 默认为当前帖子.
$format_value (bool) (可选)是否应用格式化逻辑。 默认为真.
$load_value (bool) (可选)是否加载字段的值。 默认为真.
返回值
(array) 此函数将返回一个如下所示的数组。 请注意,每个字段都包含独特的设置.
array(
"my_field" => array(
'ID' => 0,
...
wordpress有很多的函数可供调用,下面模板兔就整理了一下wordpress函数大全供各位参考,如果要详情,可以访问https://developer.wordpress.org/reference/functions/参数名/,感兴趣的朋友可以收藏。
文章,页面,附件,书签
文章
get_adjacent_post
get_boundary_post
get_children
get_extended
get_next_post
get_next_posts_link
next_posts_link
get_permalink
the_permalink
get_the_excerpt
the_excerpt
get_the_post_thumbnail
get_post
get_post_field
get_post_ancestors
get_post_mime_type
get_post_status
get_post_format
set_post_format
get_delete_post_link
get_previous_post
get_previou...
WordPress模板标签get_category_link根据传递的分类ID返回相应分类的固定链接,在WordPress主题开发中也常用到。
get_category_link( integer $category )
函数参数
$category
整数型,默认值:none
必须指定一个分类ID,以返回相应分类的链接
函数使用示例
<?php get_category_link( 23 ); ?>
扩展阅读
get_category_link()函数位于:wp-includes/category-template.php
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...
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标签,例如:<br />
$nicename
布尔值,默认值:false
是否输出分类别名,默认输出分类名称。
$de...
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,
'h...
WordPress模板标签wp_dropdown_categories用于输出分类列表,与其他输出分类列表的函数比较,wp_dropdown_categories()函数不是以<li>列表输出,而是<select>下拉列表。
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,
'e...
WordPress模板标签the_category用于在文章页或归档页的文章列表中输出当前文章所属分类,即使有多个分类也会一并输出。
the_category( string $separator = '', string $parents = '', int $post_id = false )
函数参数
$separator
字符串值,默认为空
默认以无序列表输出分类链接,当文章指定了多个分类时,提供一个字符用于分隔这些分类链接。
$parents
字符串值,默认为空
指定父分类的显示方式,可选值如下:
空值:不输出父分类;
multiple:父分类和子分类都是单独的链接,但处于同一个li元素中;
single:不输出父分类链接,但父分类的名称会出现在子分类链接锚文本中;
$post_id
整数型,默认值:...
WordPress模板标签get_bloginfo用于获取博客的一些信息,与bloginfo()的用法基本一样,区别在于get_bloginfo()只返回相应的值而不是直接输出。
get_bloginfo( string $show = '', string $filter = 'raw' )
事实上,bloginfo()函数等效于:
<?php echo get_bloginfo( $show, 'display' ); ?>
函数参数
$show
字符串值,可选
$filter
字符串值,可选,默认值为:raw
是否允许add_filter过滤,如果为display,当$show包含url或directory或home时,可以使用bloginfo_url钩子来过滤get_bloginfo()的输出结果,$show为其他值时,可以使用bloginfo钩子来过滤。
因此可以看出,bloginfo()输出的值可能会被插件、主题过滤修...
WordPress模板标签bloginfo用于输出博客的一些信息,例如博客名称、博客URL、博客描述、WordPress版本等等,几乎每个主题都会用到。
bloginfo( string $show = '' )
函数参数
$show
字符串值,可选,默认值为空
bloginfo()函数参数的可用值有点多,详细如下列表:
name:后台常规设置中的站点标题,等同于get_option('blogname')。
示例:模板兔
description:后台常规设置中的副标题,等同于get_option('blogdescription')。
示例:wp主题开发
wpurl:后台常规设置中的WordPress地址,即站点安装地址,等同于site_url()。
示例:https://www.mobantu.com/wordpress
url:后台常规设置中的站点地址,即用户访问的UR...
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函数是一样的。
扩展阅读
get_footer()函数位于:wp-includes/general-template.php
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