WordPress的钩子函数之一——do_action()
2013-04-28 14:16
169 查看
要想随心所欲的给主题添加功能,wordpress的钩子和过滤器应该要能明白。wordpress钩子和过滤器也是插件开发的基本知识。
准备工作——给主题的头部文件加上wp_head();函数
介绍与分析:要是不加这个函数,有的插件将不能正常工作!该函数位于wp-includes/general-template.php文件的1577行,原函数如下:
①可以看到这个wp_head函数调用了do_action函数,传入参数"wp_head"。该函数(do_action函数)位于wp-includes/plugin.php文件。不过这个函数就比较复杂了,这里就不讲解了,只需要明白会用就好。
②do_action函数:do_action执行了一个“动作”,这个动作名称就是这个参数"wp_head",这个“wp_head动作”是不需要定义的,do_action含有自动定义的功能。也就是不需要事先定义这个参数wp_head是什么、要干嘛,而do_action就会自动定义一个名叫wp_head的动作,并执行它。
但是,这个动作是要干什么,这里我们还需要一个函数——add_action()。注意,动作钩子的两个基本函数——add_action和do_action,位于同一个文件wp-includes/plugin.php中。
③add_action()函数可以给“动作”添加具体事务,比如我们已经定义并执行了一个动作“饭前”,然后我们add_action('饭前 ','洗手'),就给这个“饭前”动作添加了具体内容,在程序中来讲,“洗手”这个参数应该是个函数名称,也就是‘饭前’动作要执行这个函数。
我们do_action里面的动作——'wp_head',叫做动作钩子(hook),钩子可以挂东西,所以add_action就是往这个钩子上挂函数,然后执行那个钩子的时候,也就是执行所有挂在这个钩子上的函数!
钩子
简单示例一——通过wp_head()函数来往wp头部输出一个meta信息
我们只需要往wp_head动作上添加一个函数,输出meta信息即可!
上面的函数添加在哪里呢?主题的functions.php,或者其它主题被包含的函数文件,好吧,只要主题会执行的地方。
这个应用很简单,很多插件就是这样工作的,像这样来输出css或js代码。
简单示例二——通过钩子来传递参数
do_action('hookname',$arg_1,$arg_2,$arg_3),除了钩子名外,还要带3 个参数;然后add_action()中,除了钩子名,函数名,优先级,剩下那个就是参数的个数了,也就是挂靠的这个函数需要多少个参数。
do_action传了3个参数,那么对应的add_action()中的accepted_args——函数需要的参数个数,可以为0、1、2、3,少接受可以,但是多了就木有了。
可以看到定义并执行了一个叫“ashu”的动作钩子,并且传3个参数给动作函数,然后使用add_action,往这个钩子上挂了 2个函数,function1函数需要2个参数,function2需要3个参数,所以使用add_action的时候后面对应的参数个数也是2和3。然后优先级分别是10和1,所以function2先执行。
到这里,动作的使用已经很清楚了。然而关于动作钩子(hook)的函数不仅仅只有这两个,还有has_action() do_action_ref_array() remove_action() remove_all_action()....要想再深入了解,可以看官网了。
准备工作——给主题的头部文件加上wp_head();函数
介绍与分析:要是不加这个函数,有的插件将不能正常工作!该函数位于wp-includes/general-template.php文件的1577行,原函数如下:
function wp_head() { do_action('wp_head'); }
①可以看到这个wp_head函数调用了do_action函数,传入参数"wp_head"。该函数(do_action函数)位于wp-includes/plugin.php文件。不过这个函数就比较复杂了,这里就不讲解了,只需要明白会用就好。
②do_action函数:do_action执行了一个“动作”,这个动作名称就是这个参数"wp_head",这个“wp_head动作”是不需要定义的,do_action含有自动定义的功能。也就是不需要事先定义这个参数wp_head是什么、要干嘛,而do_action就会自动定义一个名叫wp_head的动作,并执行它。
但是,这个动作是要干什么,这里我们还需要一个函数——add_action()。注意,动作钩子的两个基本函数——add_action和do_action,位于同一个文件wp-includes/plugin.php中。
③add_action()函数可以给“动作”添加具体事务,比如我们已经定义并执行了一个动作“饭前”,然后我们add_action('饭前 ','洗手'),就给这个“饭前”动作添加了具体内容,在程序中来讲,“洗手”这个参数应该是个函数名称,也就是‘饭前’动作要执行这个函数。
我们do_action里面的动作——'wp_head',叫做动作钩子(hook),钩子可以挂东西,所以add_action就是往这个钩子上挂函数,然后执行那个钩子的时候,也就是执行所有挂在这个钩子上的函数!
钩子
函数: <?php do_action($tag, $arg); //$tag 必需、你想创建的动作钩子的名称 //$arg 传递给已有的动作钩子的值 ?> <?php add_action( $tag, $function_to_add, $priority, $accepted_args ); //$tag 参数必需,动作钩子的名称 //$function_to_add 参数为必需,要执行的函数 //$priority 参数为int(整数),数字越小越先调用 //$accepted_args 参数为int(整数),函数需要的参数个数,默认1;自己理解:就是$function_to_add函数需要的参数个数 ?>
简单示例一——通过wp_head()函数来往wp头部输出一个meta信息
<?php add_action('wp_head','echo_author'); function echo_author(){ echo '<meta name="author" content="阿树工作室" />'; } ?>
我们只需要往wp_head动作上添加一个函数,输出meta信息即可!
上面的函数添加在哪里呢?主题的functions.php,或者其它主题被包含的函数文件,好吧,只要主题会执行的地方。
这个应用很简单,很多插件就是这样工作的,像这样来输出css或js代码。
简单示例二——通过钩子来传递参数
do_action('hookname',$arg_1,$arg_2,$arg_3),除了钩子名外,还要带3 个参数;然后add_action()中,除了钩子名,函数名,优先级,剩下那个就是参数的个数了,也就是挂靠的这个函数需要多少个参数。
do_action传了3个参数,那么对应的add_action()中的accepted_args——函数需要的参数个数,可以为0、1、2、3,少接受可以,但是多了就木有了。
<?php add_action('ashu','function1',10,2); add_action('ashu','function2',1,3); function function1($a1,$a2){ echo $a1.'<br />'.$a2; } function function2($a1,$a2,$a3){ echo $a1.$a2.$a3.'<br />'; } $arg_1 = '这里是阿树工作室'; $arg_2 = '这里有主题制作教程'; $arg_3 = '我们提供主题定制服务'; do_action('ashu',$arg_1,$arg_2,$arg_3); ?>
可以看到定义并执行了一个叫“ashu”的动作钩子,并且传3个参数给动作函数,然后使用add_action,往这个钩子上挂了 2个函数,function1函数需要2个参数,function2需要3个参数,所以使用add_action的时候后面对应的参数个数也是2和3。然后优先级分别是10和1,所以function2先执行。
到这里,动作的使用已经很清楚了。然而关于动作钩子(hook)的函数不仅仅只有这两个,还有has_action() do_action_ref_array() remove_action() remove_all_action()....要想再深入了解,可以看官网了。
相关文章推荐
- 黄聪:WordPress动作钩子函数add_action()、do_action()源码解析
- Wordpress插件开发2 动作钩子函数add_action与add_filter过滤器
- 黄聪:wordpress中remove_action、add_action、 do_action()的hook钩子都有哪些
- WordPress 函数:add_action()(添加动作)
- WordPress中函数钩子hook的作用及基本用法
- 解析WordPress中函数钩子hook的作用及基本用法
- wordpress 的action钩子的动作名
- wordpress基础插件开发2-add_action()和do_action()的使用
- 解析WordPress中函数钩子hook的作用及基本用法
- wordpress中do_action方法,及其作用
- WordPress插件制作教程(六): 插件函数之动作(Actions)函数
- Struts2中将.action改为.do
- QTP学习之Action调用函数库文件中函数几种方法
- wordpress函数描述之一——WordPress add_theme_support() 函数
- 消息钩子函数入门篇
- Wordpress 安装Plugin是报错“To perform the requested action, WordPress needs to access your web server”
- do_mpage_readpage函数详细分析
- VC:鼠标钩子函数
- ActiveX之自定义DoDataExchange函数
- wordpress关于日志的常用函数-get_posts