WordPress:Function Reference/add filter

来自站长百科
跳转至: 导航、​ 搜索

描述[ ]

将一个函数hook到一个特别的filter action。

Filters是WordPress发行的hooks,用来更改不同类型的文本,再将这些文本添加到数据库或者发送到浏览器屏面。这时,插件可以指定一个或者更多的PHP函数使用Filter API,更改特别类型的文本。请看看插件API上关于filter hooks的一个列表。

用法[ ]

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

参数[ ]

你可能要为同样的filter callbacks提供指针指向函数的名字空间。

%%% <?add_filter('media_upload_newtab', array(&$this, 'media_upload_mycallback'));?> %%%

否则,WordPress会在自身名字空间查找函数,会导致不正常的操作。

返回[ ]

如果$function_to_add成功地加到了filter $tag上,返回true。你的函数拥有多少个参数。在WordPress1.5.1+,hooked函数拥有正在匹配的do_action() 或者apply_filters()运行时,设置的额外的参数。例如,action comment_id_not_found会传递任何hook onto需要的评论ID的函数。