Action是Hooks的两种类型之一。
它们提供了在执行WordPress Core,插件和主题的特定点运行功能的方法。 它们是Filter的对应物。
##添加Action
添加Action的过程包括两个步骤。
首先,您需要创建一个回调函数,该函数在运行时将被调用。 其次,您需要将Callback函数添加到一个将执行该函数调用的钩子中。
您将使用add_action()函数,传递至少两个参数string $ tag,callable $ function_to_add。
下面的例子将在执行init钩子时运行:
```
<?php
function wporg_custom()
{
// do something
}
add_action('init', 'wporg_custom');
```
您可以参考Hooks章节了解可用挂钩的列表。
当您获得更多的经验,通过WordPress核心源代码将允许您找到最合适的钩子。
## 附加参数
add_action()可以接受两个附加参数,int $ priority用于给予回调函数的优先级,int $ accepted_args表示将传递给回调函数的参数数。
## 优先
优先级决定了与给定钩子相关联的其他回调函数相关的回调函数何时执行。
优先级为11的功能将以优先级为10的功能运行; 并且优先级为9的函数将在优先级为10的函数之前运行。任何正整数是可接受的值,默认值为10。
如果两个回调函数以相同的优先级为同一个钩子注册,那么将按照它们挂钩的顺序运行。
例如,以下回调函数都注册到
init钩子,但具有不同的优先级:
```
<?php
add_action('init', 'run_me_early', 9);
add_action('init', 'run_me_normal'); // default value of 10 is used since a priority wasn't specified
add_action('init', 'run_me_late', 11);
```
运行的第一个函数是run_me_early(),其次是run_me_normal(),最后运行的函数将是run_me_late()。
## 参数数量
有时候,回调函数需要接收一些与其挂接的函数相关的额外数据。
例如,当WordPress保存一个帖子并运行save_post钩子时,它会将两个参数传递给回调函数:保存的帖子的ID以及post对象本身:
```
do_action('save_post', $post->ID, $post);
```
所以,当save_post钩子注册一个回调函数时,它可以指定它要接收这两个参数:
```
add_action('save_post', 'wporg_custom', 10, 2);
```
...然后它可以在函数定义中注册参数:
```
function wporg_custom($post_id, $post)
{
// do something
}
```
## 示例
如果您想修改在前端的循环中获取搜索结果的查询,则可以钩入pre_get_posts钩子。
```
<?php
function wporg_search($query)
{
if (!is_admin() && $query->is_main_query() && $query->is_search) {
$query->set('post_type', ['post', 'movie']);
}
}
add_action('pre_get_posts', 'wporg_search');
```
- 简介
- 主题开发
- WordPress许可证
- 什么是主题
- 开发环境
- 主题开发示例
- 主题基础
- 模板文件
- 主样式表(style.css)
- 文章类型
- 规划主题文件
- 模板层级
- 模板标签
- 循环
- 主题函数
- 连接主题文件和目录
- 使用CSS和JavaScript
- 条件标签
- 类别,标签和自定义分类
- 模板文件
- 内容模板文件
- 页面模板文件
- 附件模板文件
- 自定义内容类型
- 部分和其他模板文件
- 评论模板
- 分类模板
- 404页面
- 主题功能
- 核心支持的功能
- 管理菜单
- 自定义Headers
- 自定义Logo
- 文章格式
- 置顶文章
- Sidebars
- Widgets
- 导航菜单
- 分页
- 媒体
- Audio
- Images
- Galleries
- Video
- 精选图片和缩略图
- 国际化
- 本地化
- 辅助功能
- 主题选项 – 自定义API
- 定制对象
- 改进用户体验的工具
- 定制JavaScript API
- JavaScript / Underscore.js渲染的自定义控件
- 高级用法
- 主题安全
- 数据消毒/逃避
- 数据验证
- 使用随机数
- 常见漏洞
- 高级主题
- 子主题
- UI最佳实践
- JavaScript最佳做法
- 主题单元测试
- 验证你的主题
- Plugin API Hooks
- 发布你的主题
- 所需的主题文件
- 测试
- 主题评论指南
- 写文档
- 提交你的主题到WordPress.org
- 参考文献
- 模板标签列表
- 条件标签列表
- 编码标准
- HTML编码标准
- CSS编码标准
- JavaScript编码标准
- PHP编码标准
- 插件开发
- 插件开发简介
- 什么是插件
- 插件基础
- 头部要求
- 包括软件许可证
- 启用 / 停用 Hooks
- 卸载方法
- 最佳做法
- 插件安全
- 检查用户功能
- 数据验证
- 保护输入
- 保护输出
- 随机数
- Hooks
- Actions
- Filters
- 自定义Hooks
- 高级主题
- 管理菜单
- 顶级菜单
- 子菜单
- 短代码
- 基本短码
- 封闭短码
- 带参数的短代码
- TinyMCE增强型短码
- 设置
- 设置API
- 使用设置API
- 选项API
- 自定义设置页面
- 元数据
- 管理帖子元数据
- 自定义元数据
- 渲染元数据
- 自定义文章类型
- 注册自定义文章类型
- 使用自定义文章类型
- 分类
- 使用自定义分类
- 在WP 4.2+中使用“split术语”
- 用户
- 创建和管理用户
- 使用用户元数据
- 角色和功能
- HTTP API
- JavaScript
- jQuery
- Ajax
- 服务器端PHP和入队
- Heartbeat API
- 概要
- 计划任务
- 了解WP-Cron计划
- 安排WP-Cron 事件
- 将WP-Cron挂接到系统任务计划程序中
- WP-Cron简单测试
- 国际化
- 本地化
- 如何国际化您的插件
- 国际化安全
- WordPress.org
- 详细插件指南
- 规划您的插件
- 如何使用Subversion
- 插件开发者常见问题
- 开发工具
- Debug Bar 和附加组件
- 辅助插件
- REST API手册
- 资源
- 文章
- 文章修订
- 文章类型
- 文章状态
- 类别
- 标签
- 页面
- 评论
- 分类
- 媒体
- 用户
- 设置
- 使用REST API
- 全局参数
- 分页
- 链接和嵌入
- 发现
- 认证
- 经常问的问题
- 骨干JavaScript客户端
- 客户端库
- 扩展REST API
- 添加自定义端点
- 自定义内容类型
- 修改回应
- 模式
- 词汇表
- 路由和端点
- 控制器类