常用函数-add_filter()

说明

将函数连接到特定过滤器动作。

过滤器是WordPress发布的一种hook，在不同类别的文本被添加到书库据或发送到浏览器窗口前对这些文本进行修改。插件可用过滤器API规定在修改特定类型的文本时，执行一个还是多个PHP函数。在Plugin API上查阅过滤器hook列表。

用法

<?php add_filter($tag,  $function_to_add,  $priority = 10,  $accepted_args = 1); ?> 

参数

$tag

（字符串）（必需）连接到$function_to_add的过滤器名称

默认值：None

$function_to_add

（回调）（必需）应用过滤器时被调用函数的名称

默认值：None

$priority

（整数）（可选）用于规定函数被执行的顺序，函数与特定动作关联。较小的数字匹配较早的执行，同等优先级的函数按加入action的顺序被执行。

默认值：10

$accepted_args

（整数）（必需）函数所接受参数的数量。在WordPress 1.5.1及之后版本中，连接的函数可吸收其它在调用do_action() 或 apply_filters()时设置的参数。

默认值：None

用户还需要为过滤器回调时函数的命名空间提供一个指示器，如：

<?php add_filter(‘media_upload_newtab’, array(&$this, ‘media_upload_mycallback’)); ?> 

否则WordPress会为函数查找自备命名空间，从而引发异常状况。

返回的值

$function_to_add成功添加到$tag过滤器时返回true。返回函数可接受的参数数量。在WordPress 1.5.1及之后版本中，连接的函数可吸收其它在调用do_action() 或 apply_filters()时设置的参数。例如，comment_id_not_found动作将传递任何函数，若该函数将所请求的评论编号连接到该动作。

分类：中文手册