关于WordPress中函数add_filter的说明

函数add_filter(添加过滤器)的作用是将自定义函数function挂钩到指定的filter(过滤器)中。
过滤器是WordPress发布的一种hook,在不同类别的文本被添加到数据库或发送到浏览器窗口前可以对其进行修改。在修改特定类型的文本时,插件可用API规定的过滤器执行一个或者多个function函数。

一、函数定义:

/**
 * $tag:要挂钩的filter名称
 * $function_to_add:要挂钩的函数名称
 * $priority:挂钩函数的执行顺序
 * $accepted_args:挂钩函数所接受的参数数量
 * return:$function_to_add成功添加到$tag过滤器时返回true,否则返回false。
 */
add_filter ( $tag, $function_to_add, $priority, $accepted_args );

二、参数说明:
$tag:字符串,必填,$function_to_add所挂钩filter的名称。默认值:None

$function_to_add:函数,必填,希望挂钩的函数名称。默认值:None

$priority:整数,可选,用于指定与特定的过滤器相关联的函数的执行顺序。数字越小,执行越早,具有相同优先级的函数按照它们被添加到过滤器的顺序执行。默认值:10

$accepted_args:整数,可选,挂钩函数所接受的参数数量。在WordPress-1.5.1及以后的版本中,可以是调用apply_filters时设置的参数。默认值:1

三、调用示例:

/**
 * 定义要挂钩的函数
 */
function function_to_add($content) {
	return $content . '...';
}

// 将挂钩函数function_to_add添加到the_content过滤器中,并设定执行顺序为99
add_filter ( 'the_content', 'function_to_add', 99 );

以上示例将在文章内容结尾输出字符串“…”。

更多信息请参阅:Function Reference/add filter « WordPress Codex

发表评论