# Niushop开源商城常用钩子说明
---
1. 商品相关钩子
| 钩子名称 | 钩子说明 | 相关插件(实例) | 钩子介绍 |
| :--- | :---: | :--- | :--- |
| addGoods | 添加商品 | 实物商品,虚拟商品,网盘商品,下载商品,卡券商品 | 添加商品实现接口,在添加商品使用,返回对应添加页面 |
| editGoods | 编辑商品 | 实物商品,虚拟商品,网盘商品,下载商品,卡券商品 | 编辑商品实现接口,在编辑商品使用,返回对应商品编辑界面 |
| addGoodsSuccess | 添加商品成功执行方法 | 同上 | 添加商品之后执行功能 |
| editGoodsSuccess | 编辑商品成功后执行方法 | 同上 | 编辑商品成功之后执行 |
| deleteGoodsSuccess | 删除商品成功执行方法 | 同上 | 删除商品成功后执行 |
| copyGoodsSuccess | 复制商品执行成功后方法 | 同上 | 复制商品成功后执行 |
2. 会员相关钩子
| 钩子名称 | 钩子说明 | 相关插件(实例) | 钩子介绍 |
| :--- | :--- | :--- | :--- |
| userLoginSuccess | 用户登录成功 | | 用户登录之后执行方法 |
| userAddSuccess | 用户添加成功 | | 用户添加之后执行 |
| memberRegisterSuccess | 会员注册成功 | 消息管理,分销 | 会员注册成功之后执行 |
| | | | |
3. 订单创建相关钩子
| 钩子名称 | 钩子说明 | 相关插件(实例) | 钩子介绍 |
| :--- | :--- | :--- | :--- |
| getOrderType | 订单类型 | 拼团,预售 | 获取订单类型 |
| getOrderStatus | 订单状态 | 同上 | 获取订单状态(所有) |
| getOrderStatusInfo | 订单状态 | 同上 | 获取订单状态值信息 |
| getOrderTypeInfo | 订单类型 | 同上 | 获取订单类型值信息 |
| orderCreate | 订单创建 | 同上 | 实现订单创建方法 |
| orderCalculate | 订单计算 | 同上 | 待付款订单针对商品以及会员等信息计算订单 |
| orderCreateSuccessAction | 订单创建成功 | 同上 | 订单创建成功操作,专用订单创建相关插件 |
| dataCollation | 数据整理 | 同上 | 订单创建之前数据整理方便订单显示 |
4. 订单操作相关钩子(订单操作执行后执行)
| 钩子名称 | 钩子说明 | 相关插件(实例) | 钩子介绍 |
| :--- | :--- | :--- | :--- |
| orderCreateSuccess | 订单创建成功 | 分销 | 订单创建成功后执行,返回订单id |
| orderDeliverySuccess | 订单发货成功 | 库存管理 | 订单发货之后执行 |
| orderPaySuccess | 订单支付成功 | 分销 | 订单支付成功之后执行 |
| orderRefundSuccess | 订单退款成功 | 分销 | 订单退款成功之后进行执行计算使用 |
| orderCompleteSuccess | 订单完成 | 分销 | 订单完成之后执行,一般订单执行完成之后 |
| orderGoodsConfirmRefundSuccess | 订单项目退款完成 | 分销 | 订单项目退款完成 |
5. 支付相关钩子(开发支付使用)(3.1以上版本)
| 钩子名称 | 钩子说明 | 相关插件(实例) | 钩子介绍 |
| :--- | :--- | :--- | :--- |
| payconfig | 支付配置 | 微信,支付宝,银联 | 查询外界调用的支付配置显示信息 |
| pay | 支付 | 同上 | 实现支付 |
| payReturn | 同步回调 | 同上 | 实现支付同步回调 |
| payNotify | 异步回调 | 同上 | 实现支付异步回调 |
| refund | 支付退款 | 同上 | 实现支付原路退款 |
| transfer | 支付转账 | 同上 | 实现支付转账 |
6. 会员行为相关钩子(开发会员操作行为)(3.1以上版本)
| 钩子名称 | 钩子说明 | 相关插件 | 钩子介绍 |
| :--- | :--- | :--- | :--- |
| getMemberActionConfig | 会员行为设置 | 会员签到,点赞,分享等 | 获取会员行为相关设置 |
| memberAction | 会员行为 | 同上 | 实现会员行为 |
7. 短信开发相关钩子
| 钩子名称 | 钩子说明 | 相关插件 | 钩子介绍 |
| :--- | :--- | :--- | :--- |
| smsconfig | 获取短信配置 | 阿里云短信 | 获取短信相关配置包括logo,配置信息等等 |
| smssend | 发送短信 | 阿里云短信 | 发送短信 |