WordPress函数
模板兔提供完善的WordPress常用函数使用介绍与方法,让您快速入门WordPress函数的使用。
简介
删除所有缓存。
用法
<?php wp_cache_flush(); ?>
参数
无
返回值
(bool)
永远返回 true。
注解
使用到 wp_object_cache 对象缓存的类
WP_Object_Cache::flush()
WordPress 对象缓存详细介绍和使用
修改记录
Since 2.0.0
源文件
wp-includes/cache.php
简介
$wpdb->_escape() 的别名,用于进行 SQL 查询之前的字符串处理。
用法
<?php esc_sql( $sql ); ?>
参数
$string
(string) (required) 一条转义的 SQL 查询语句。
Default: None
返回值
(string)
转义之后适合 SQL 查询中使用的字符串。
实例
$name=esc_sql($name);
$status=esc_sql($status);
$wpdb->get_var(
"SELECT something FROM table WHERE foo = '$name' and status = '$status'"
);
注解
SQL 转义还是建议首选 $wpdb->prepare(),因为它可以修正一些格式方面的错误。
修改记录
Since: 2.8.0
源文件
wp-includes/formatting.php
简介
检查内容中是否含有指定的 Shortcode。
用法
<?php if ( has_shortcode( $content, 'gallery' ) ) { } ?>
参数
$content
(string) (required) 要检测的内容
Default: None
$tag
(string) (required) 指定的 Shortcode
Default: None
返回值
(Bool)
指定的 Shortcode 找的返回 true,否则 false。
实例
if( has_shortcode( $content, 'gallery' ) ) {
// 内容中有gallery Shortcode,将返回 true。
}
在内容中含有指定的 Shotcode 的时候才载入相应的脚本。
function custom_shortcode_scripts() {
global $post;
if( has_shortcode( $post->post_content, 'custom-shortcode') ) {
wp_enqueue_script( ...
简介
用在表单中的下拉菜单,用于比较两个给定的值(比如:保存的值和当前的值),如果值相同,给当前的选项添加 selected 属性。
用法
<?php selected( $selected, $current, $echo); ?>
参数
$selected
(mixed) (required) 用于比较的值,已经在数据库中保存的。
Default: None
$current
(mixed) (optional) 另外的值(如果不为 true),当前选项的值。
Default: true
$echo
(boolean) (optional) 返回结果是输出还是返回字符串。
Default: true
返回值
(string)
HTML 属性 (selected='selected') 或者空的字符串。
修改记录
Since: 1.0
源文件
wp-includes/general-template.php
简介
用在表单中的多选和单选按钮中。用于比较两个给定的值(比如,已经保存到数据库的值和表单中的值),如果两个值相同,添加 checked 属性到当前的多选和单选按钮中。
用法
<?php checked( $checked, $current, $echo ); ?>
参数
$selected
(mixed) (required) 用于比较的值,已经在数据库中保存的。
Default: None
$current
(mixed) (optional) 另外的值(如果不为 true),当前选项的值。
Default: true
$echo
(boolean) (optional) 返回结果是输出还是返回字符串。
Default: true
返回值
(string)
HTML 属性 (checked='checked') 或者空的字符串。
实例
使用 if() 测试值:
<input checked="checked" n...
简介
用在表单中的输入框中。用于比较两个给定的值(比如,已经保存到数据库的值和表单中的值),如果两个值相同,添加 disabled 属性到输入框中。
用法
<?php disabled( $disabled, $current, $echo ); ?>
参数
$disabled
(mixed) (required) 用于比较的值,已经在数据库中保存的。
Default: None
$current
(mixed) (optional) 另外的值(如果不为 true),当前选项的值。
Default: true
$echo
(boolean) (optional) 返回结果是输出还是返回字符串。
Default: true
返回值
(string)
HTML 属性 (disabled='disabled') 或者空的字符串。
修改记录
Since: 3.0
源文件
wp-includes/general-template.php
简介
根据一组 key => value 参数从一组对象或者数组列表中,筛选出所需的数组。
用法
<?php wp_list_filter( $list, $args, $operator ); ?>
参数
$list
(array) (required) 一组将要过滤的对象或者数组列表
Default: None
$args
(array) (optional) key => value 用于去匹配数组中每个对象或者数组的 key => value 数组
Default: array()
$operator
(string) (optional) 应用于匹配的逻辑操作符: 'AND' 意思是 $args 中所有的元素都要匹配上;'OR' 只要任一条件匹配上即可,'NOT' 则和 'AND' 相反,所有的元素都不能匹配上。默认是 'AND'
Default: AND
返回值
(array)
过滤之后的数组或者对象列表
实...
简介
从列表中的每个对象活数组中抽取某个字段组成新数组。
用法
<?php wp_list_pluck( $list, $field, $index_key = null ); ?>
参数
$list
(array) (required) 一组对象或者数组列表
Default: None
$field
(mixed) (required) 对象或者数组中用于替换整个对象或者数组的字段
Default: None
$index_key
(mixed) (optional) 对象或者数组中用作新数组 key 的字段,4.0 新增的参数
Default: null
返回值
(array)
抽取出来的值,如果设置了 $index_key,那么结果数组中的会根据 $index_key 设置数组每个元素的 key。
实例
WordPress 数组处理相关的函数大全
修改记录
Since: 3.1
源文件
wp-includes/functions.php
PHP 编程,有很大一部分的工作就是数组的处理,WordPress 本身也整合一些非常方便的数组处理函数,今天给大家罗列一下,也方便自己以后写代码的时候查询。 🙂
wp_parse_args
wp_parse_args($args, $defaults='')
将用户定义的参数($args)合并到默认的参数($defaults),用户自定义的参数可以是数组,也可以是链接地址查询类型的字符串(比如:”id=5&status=draft”)。
$args = wp_parse_args($args, array(
'type' => 'post',
'posts_per_page' => 5,
'cat' => '1'
));
或者:
$args = wp_parse_args($args, 'type=post&posts_per_page=5&cat=1');
wp_parse_id_list
wp_parse_id_list($lis...
简介
根据一组 key => value 参数从一组对象或者数组列表中筛选出所需的数组,然后抽取出某个字段组成新数组。
用法
<?php wp_filter_object_list( $list, $args, $operator, $field ); ?>
参数
$list
(array) (required) 一组将要过滤的对象或者数组列表
Default: None
$args
(array) (optional) key => value 用于去匹配数组中每个对象或者数组的 key => value 数组
Default: array()
$operator
(string) (optional) 应用于匹配的逻辑操作符: 'AND' 意思是 $args 中所有的元素都要匹配上;'OR' 只要任一条件匹配上即可,'NOT' 则和 'AND' 相反,所有的元素都不能匹配上。默认是 'AND'
Default: AND
$fi...
简介
根据一个或者多个字段对对象(或者数组)列表进行排序。
用法
<?php wp_list_sort($list, $orderby = array(), $order = 'ASC', $preserve_keys = false ); ?>
参数
$list
(array) (Required) 一组将进行排序的对象(或者数组)列表。
$orderby
(string|array) (Optional) 可以是根据排序的单个字段,或者类似于 $orderby => $order 用于多重排序的数组。
Default value: array()
$order
(string) (Optional) 'ASC' 或者 'DESC' 只有 $orderby 单个字段时候才有效。
Default value: 'ASC'
$preserve_keys
(bool) (Optional) 是否保留原来数组的 $key
Default value: false
返回值
(array)
排序之后的数...
1、Functions by category 分类函数,Post, Page, Attachment and Bookmarks Functions 文章,页面,附件和链接的函数
get_adjacent_post
返回邻近的文章信息数组,详情见:http://codex.wordpress.org/Function_Reference/get_adjacent_post.
get_children
检索附件、版本、子页面等信息,一般情况下由父文章执行,详情见 :http://codex.wordpress.org/Function_Reference/get_children.
get_extended
获取文章 more 标签分割的数组.$post 是文章的内容
get_next_post
获取下一篇邻近的文章信息.
get_post
返回单篇文章的信息数组或对象,$id 是文章 id,注意这里只能用变量,详情见:
http://codex.wordpres...
描述
加载翻译后的插件字符串。
如果未给出路径,默认路径为插件根目录。.mo文件路径基于带有破折号的域名命名,域名后应跟有一个破折号,破折号后为本地语言简码。 这里的本地语言简码是指你在wp-config.php中填写的 WPLANG 的值,比如你填写的是 zh_CN ,那么就该使用 zh_CN,如果你的插件的 text domain 为 “my-plugin”,那么语言包的名字应该为 “my-plugin-zh_CN.mo”和 “my-plugin-zh_CN.po”。
用法
<?php load_plugin_textdomain( $domain, $abs_rel_path, $plugin_rel_path ) ?>
参数
$domain
(字符串)(必需)用以检索被翻译字符串的唯一标识符
默认值:None
$abs_rel_path
(字符串)(可选).mo文件所在...
介绍
用来注销小工具(通常是用来注销WordPress内置的小工具)
用法
<?php unregister_widget( $widget_class ) ?>
参数
$widget_class
(对象)WP_Widget 扩展的 类名
WP_Widget_Pages = 页面
WP_Widget_Calendar = 日历
WP_Widget_Archives = 存档
WP_Widget_Links = 链接
WP_Widget_Meta = Meta
WP_Widget_Search = 搜索
WP_Widget_Text = Text
WP_Widget_Categories = 分类
WP_Widget_Recent_Posts = 近期文章
WP_Widget_Recent_Comments = 最新评论
WP_Widget_RSS = RSS
WP_Widget_Tag_Cloud = 标签云
WP_Nav_Menu_Widget = 菜单
返回值
无
示例
注销内置的 WP_Widget_Calendar 小工具(如...