WordPress过滤器(Filters):apply_filters和add_filter
过滤器(Filters)对于WordPress来说是非常重要的,它极大地扩展了WordPress的定制能力,提高了WordPress的灵活性。无论是制作主题还是开发插件,我们基本上都会或多或少地使用到过滤器,以实现我们的一些特殊需求。
其实,WordPress过滤器的使用非常简单,我们经常用到的也就两个函数而已,它们就是apply_filters和add_filter。本文将对WordPress过滤器进行详细解读与分析。
什么是过滤器?
下面就来说说什么是过滤器(Filters),过滤器就是注册到过滤器钩子(Filter Hook)的函数,过滤器钩子都有一个名字,在WordPress中,一般使用变量$tag来标识这个名字。所有挂接到过滤器钩子上的函数都是过滤器。
过滤器钩子和动作钩子一样,基本的函数有两个,动作钩子有do_action函数,它就有apply_filters函数,该函数是用于执行相应的过滤器函数,不同的是动作钩子仅仅是执行函数(或者称为动作,更为贴切),而过滤器钩子它要做的是通过执行过滤器函数来改变对象或变量的值,就相当于对变量或者对象进行过滤,然后再返回。
过滤器钩子相关函数:
简单地说,动作钩子要的是过程(仅仅执行代码块)而不是结果(输出值/返回值),过滤器钩子要的是结果而不是过程。apply_filters()函数的用法:
<?php
apply_filters( $tag, $value, $var ... );
//$tag 必需,过滤器钩子的名称
//$value 必需,可以被过滤器函数修改的值
//$var 可选,若干个可以传递给过滤器函数的参数
?>
同理,动作钩子有个函数是add_action,相应地,过滤器钩子也有个函数是add_filter。这两个函数的用法就完全一样了,实质上,add_action就是直接调用add_filter来实现的。add_filter函数的用法:
<?php
add_filter( $tag, $function_to_add, $priority, $accepted_args );
//$tag 必需,过滤器钩子的名称
//$function_to_add 必需,要添加的过滤器函数
//$priority 可选,过滤器函数的优先级,默认值为10
//$accepted_args 可选,过滤器函数接受的参数数量,默认值为1
?>
要注意的是,我们在前面说过,过滤器(过滤器函数)的任务是要改变对象或变量的值,所以通过add_filter函数添加的过滤器必须要有个返回值,也就是函数$function_to_add必需有返回值。
过滤器应用实例:
我们以wp_title()函数为例,为大家讲一下过滤器的实际用法,这个函数的定义在wp-includes/general-template.php文件中。在该函数的定义中,调用了apply_filters函数来执行相应的过滤器函数。代码如下:
$title = apply_filters('wp_title', $title, $sep, $seplocation);
//这里会执行过滤器函数,对变量$title进行过滤
//正因为这行代码的存在,你可以把你的过滤器函数添加进来,实现对$title的定制
那么,我们可以在该过滤器钩子(wp_title)上添加一个过滤器来改变$title的值。代码如下:
<?php
add_filter('wp_title', 'mytitle');
//把函数mytitle挂接到过滤器钩子wp_title上
//定义过滤器函数mytitle
function mytitle($title) {
$title = 'This is a demo.';
return $title;
}
?>
上面这些代码就会把wp_title()函数的返回值$title改为“This is a demo.”,调用wp_title()函数得到的输出就是“This is a demo.”了,不管在什么页面调用都是如此。把这段代码添加到主题的functions.php文件中,你就能看到效果了(如果你的主题使用了wp_title函数)。
通过本文的介绍,相信大家都明白了什么是过滤器以及过滤器的用法。
WordPress过滤器(Filters):apply_filters和add_filter的更多相关文章
- 学习笔记6——插件 API,“过滤器”(Filters)和“动作”(Actions)
WordPress 中有一种叫执行挂勾的机制,允许插件把一些功能“挂载”到 WordPress 当中.也就是说,在系统运行至某一个环节时,去调用插件内的一些函数.执行挂勾分为两种: 动作 (Actio ...
- vue 过滤器filters的使用以及常见报错小坑(Failed to resolve filter)
今天使用vue 过滤器中发现一个小坑,网上查到的大都是不正确的解决方法,故分享给大家: 原错误代码: // 过滤器 filter:{ FdishList:function(value){ if (!v ...
- ASP.NET MVC5基础-过滤器(Filters)详解
什么是过滤器? 过滤器的类型与作用 定义过滤器 授权过滤器 动作过滤器 结果过滤器 异常处理过滤器 过滤器的使用方法 总结 什么是过滤器? 通过上一篇关于Controller控制器的文章我们知道,MV ...
- vue使用过滤器 filters:{}
在项目开发过程中,经常会用到过滤器,下面就来说说我用的用法 我从后台获取到一个时间字段,是2017-03-23的格式,但是我要的是年月日分开显示,那就要用到过滤器了 在没有用过滤器的时候,是这样的: ...
- 带你掌握Vue过滤器filters及时间戳转换
摘要:Vue的filters过滤器是比较常见的一个知识点,下面我将结合时间戳转换的例子带你快速了解filters的用法. 本文分享自华为云社区<三分钟掌握Vue过滤器filters及时间戳转换& ...
- 黄聪:WordPress 函数:apply_filters()(创建过滤器)
apply_filters() 函数用来创建一个过滤器,大多数被用在函数中,是 WordPress 插件机制中非常重要的一个函数,能让其它的主题和插件对一个值进行修改过滤. 用法 apply_filt ...
- YII2 过滤器 filters
使用过滤器 过滤器本质上是一类特殊的 行为,所以使用过滤器和 使用 行为一样. 可以在控制器类中覆盖它的 yii\base\Controller::behaviors() 方法来申明过滤器, 如下所示 ...
- vue从入门到进阶:过滤器filters(五)
Vue.js 允许你自定义过滤器,可被用于一些常见的文本格式化.过滤器可以用在两个地方:双花括号插值和 v-bind 表达式 (后者从 2.1.0+ 开始支持).过滤器应该被添加在 JavaScrip ...
- vue指令v-html中使用过滤器filters功能
Vue 2.0 不再支持在 v-html 中使用过滤器 解决方法: 1:全局方法(推荐) 2:computed 属性 3:$options.filters(推荐) 1:使用全局方法: 可以在 Vue ...
随机推荐
- DAX/PowerBI系列 - 关于时间系列 - 如何用脚本生成时间维度 (Generate TIME Dimension)
DAX/PowerBI系列 - 关于时间系列 - 如何用脚本生成时间维度 (Generate TIME Dimension) 难度: ★☆☆☆☆(1星) 适用范围: ★★★★★(5星) 这个时间系列想 ...
- EJS学习(五)之EJS的CommonJs规范版本
EJS的CommonJs规范版本 ejs分为两个版本一个是CommonJs版本,另外一个是AMD规范的版本. 基础:html页面 安装:<script type="text/javas ...
- Git复习(一)之简介、安装、集中式和分布式
简介 Git是分布式版本控制系统,使用C语言开发的,CVS.SVN是集中式的版本控制系统,集中式的版本控制系统不但速度慢,而且必须联网才能使用. Git是分布式版本控制系统,同一个Git仓库,可以 分 ...
- luogu题解 UVA1615 【Highway】
题目链接: https://www.luogu.org/problemnew/show/UVA1615 分析: 首先这里的距离是欧几里得距离而不是曼哈顿距离. 然后我们对于每个点,求出在公路上保持D范 ...
- wpf GridSplitter左右托不了或者拖拽异常
对于水平分割线,需要将verticalAlignment属性设置为Center 对于垂直分割线,需要将horizontalAlignment属性设置为center 切记切记,不然很苦逼....
- 15 Scrapy框架之CrawlSpider
一.简介 CrawlSpider其实是Spider的一个子类,除了继承到Spider的特性和功能外,还派生除了其自己独有的更加强大的特性和功能.其中最显著的功能就是”LinkExtractors链接提 ...
- js 回顾知识总结一
1.js数据类型? 基本数据类型:String(字符串).boolean(布尔值).Number(数字).undefined(未定义).null(空) 引用数据类型:Object(对象).Array( ...
- 大神的JS代码风格指南
js代码风格指南:1.缩进使用空格,不要用制表符2.必须用分号3.暂时不用ES6(modules)例如export和import命令4.不鼓励(不禁止)水平对齐5.少用var 都应该使用const或者 ...
- Nginx如何配置https证书?
#把80端口请求跳转到443端口 server { listen 80; server_name 域名; return 301 https://$http_host$request_uri; } se ...
- CentOS7搭建FastDFS V5.11分布式文件系统(三)
1.测试 前面两篇博文已对FastDFS的安装和配置,做了比较详细的讲解.FastDFS的基础模块都搭好了,现在开始测试下载. 1.1 配置客户端 同样的,需要修改客户端的配置文件: /etc/fdf ...