钩子让插件能够响应事件执行代码。所有钩子接收一个事件对象和插件上下文。
钩子签名
async (event, ctx) => ReturnType;
钩子配置
| 选项 | 类型 | 默认值 | 说明 |
|---|---|---|---|
priority | number | 100 | 执行顺序。较低的数字先执行。 |
timeout | number | 5000 | 最大执行时间(毫秒)。 |
errorPolicy | "abort" | "continue" | "abort" | 错误时是否停止管道。 |
生命周期钩子
plugin:install、plugin:activate、plugin:deactivate、plugin:uninstall
内容钩子
content:beforeSave、content:afterSave、content:beforeDelete、content:afterDelete、content:afterPublish、content:afterUnpublish、content:afterRestore、content:afterSchedule、content:afterUnschedule
媒体钩子
media:beforeUpload、media:afterUpload
公共页面钩子
page:metadata — 沙盒和原生插件均可使用。
page:fragments — 仅限原生插件。
钩子参考
完整事件类型请参见钩子参考。