add_action() WordPress函数（添加动作）

do_action( string $hook_name, mixed $arg )

将函数添加到指定挂钩的回调函数 action（动作）。

说明

此函数调用附加到动作钩子的所有函数$hook_name。可以通过简单地调用这个函数来创建新的动作钩子，使用$hook_name参数指定新钩子的名称。

您可以将额外的参数传递给钩子，就像您可以使用apply_filters().

示例用法

// The action callback function.
function example_callback( $arg1, $arg2 ) {
    // (maybe) do something with the args.
}
add_action( 'example_action', 'example_callback', 10, 2 );

/*
 * Trigger the actions by calling the 'example_callback()' function
 * that's hooked onto `example_action` above.
 *
 * - 'example_action' is the action hook.
 * - $arg1 and $arg2 are the additional arguments passed to the callback.
$value = do_action( 'example_action', $arg1, $arg2 );

参数

$tag

（字符串）（必填）$function_to_add  所挂载的动作（action）的名称。（在Plugin API/Action Reference 上查看动作hook列表）。也可以是一个主题或插件文件内部的一个动作，或者特定的标签“all”，这个函数将被所有的钩子（hooks）调用。

默认值：None

$function_to_add

（回调）（必填）你希望挂载的函数的名称。注：在 PHP“回调”类型文档中 所罗列的字符串格式化的语法均可用。

默认值：None

$priority

（整数）（可选）用于指定与特定的动作相关联的函数的执行顺序。数字越小，执行越早，具有相同优先级的函数在它们被添加到动作的顺序执行。

默认值：10

$accepted_args

（整数）（可选）挂钩函数所接受的参数数量。在 WordPress1.5.1 及以后的版本中，挂钩函数可以是调用do_action() 或 apply_filters()时设置的参数。例如，comment_id_not_found动作将传递任何函数，若该函数将所请求的评论编号连接到该动作。

默认值：1

返回值

(true)总是返回 true。

用法

add_action( $hook, $function_to_add, $priority, $accepted_args );

要找出一个动作的参数的ID和名称，只需搜索匹配 do_action() 调用的代码库。举例来说，如果你挂载到’save_post’，你会在 post.php 找到：

do_action( 'save_post', $post_ID, $post, $update );

您的 add_action 调用如下所示：

add_action( 'save_post', 'wpdocs_my_save_post', 10, 3 );

你的功能函数是：

function wpdocs_my_save_post( $post_ID, $post, $update ) {
    // do stuff here
}

源文件

文件：wp-includes/plugin.php

原文：http://codex.wordpress.org/Function_Reference/add_action

关注公众号『窗外天空』

获取更多建站运营运维新知！
互联网创业、前沿技术......