关于WordPress中函数add_action的说明

函数add_action(添加动作)的作用是将自定义函数function挂钩到指定的action(动作)中。
函数始见于WordPress-1.2.0,位于wp-includes/plugin.php文件中,WordPress的核心框架调用do_action时将触发该动作。

一、函数定义:

/**
 * $tag:要挂钩的action名称
 * $function_to_add:要挂钩的函数名称
 * $priority:挂钩函数的执行顺序
 * $accepted_args:挂钩函数所接受的参数数量
 * return:总是返回true
 */
add_action ( $tag, $function_to_add, $priority, $accepted_args );

二、参数说明:
$tag:字符串,必填,$function_to_add所挂钩action的名称。也可以是一个主题或插件文件内部的一个动作,或者特定的标签“all”(被所有的钩子(hooks)调用)。默认值:None

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

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

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

三、调用示例:

/**
 * 定义要挂钩的函数
 */
function function_to_add() {
	echo 'function_to_add';
}

// 将挂钩函数function_to_add添加到wp_footer动作中,并设定执行顺序为99
add_action ( 'wp_footer', 'function_to_add', 99 );

以上示例将在页面footer区域输出对应文本。

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

发表评论