欢迎加入 插件 / 主题制作团队:QQ 群入口(后台「插件管理」页亦有同款按钮)。
支持的插件类型
定义于 PluginService::TYPES:
| type | 用途 | 基类 |
|---|---|---|
addon |
功能扩展(日志、通知等) | app\common\lib\Plugin |
gateway |
支付网关 | GatewayPlugin → GatewayInterface |
sms |
短信驱动 | SmsPlugin → SmsDriverInterface |
mail |
邮件驱动 | MailPlugin → MailDriverInterface |
certification |
实名认证 | CertificationPlugin → RealnameProviderInterface |
server / reserver / oauth |
魔方插件兼容目录 | Plugin |
生命周期
上传/市场安装 → 磁盘有文件 → 后台「安装」→ install() → kd_addons 登记 → enable
启用 → 加载 hooks.php
停用 → status=0,钩子不再加载
卸载 → uninstall() → 删除 kd_addons
主类必须实现的方法(按需)
public function install() // 建表等,返回 true/false
public function uninstall() // 删表等
public function enable() // 启用时
public function disable() // 停用时
配置读写继承自 Plugin::getConfig() / setConfig(),合并 config.php 与数据库。
手把手教程:请先读 04a 插件开发详细教程(含完整示例与排错)。示例目录 public/plugins/addon/hello_world/ 由开发者自行创建。
最小 addon 示例
目录 public/plugins/addon/hello_world/
HelloWorld.php
<?php
namespace addon\hello_world;
use app\common\lib\Plugin;
class HelloWorld extends Plugin
{
public $info = [
'name' => 'HelloWorld',
'title' => 'Hello 示例',
'description' => '演示插件',
'author' => 'Your Name',
'version' => '1.0.0',
];
public function install() { return true; }
}
hooks.php
<?php
add_hook('after_user_register', function ($param) {
// 用户注册后逻辑
});
config.php
<?php
return ['enabled' => 1];
钩子注册
全局函数(app/common.php):
add_hook('hook_name', callable $fn, int $priority = 50);
run_hook('hook_name', $params);
触发时使用 CamelCase 或 snake_case 均可,例如:
HookService::trigger('UserLogin', ...)同时匹配user_login- 魔方别名:
AfterInvoicePaid→order_paid
常用钩子见 11-hooks。
后台 API
| 接口 | 说明 |
|---|---|
GET /admin/addon/index?type=addon |
扫描本地插件 |
POST /admin/addon/install |
安装 |
POST /admin/addon/uninstall |
卸载 |
POST /admin/addon/enable / disable |
启停 |
GET/POST /admin/addon/config |
读写配置 |
权限模块:plugin
接口中的 /admin/ 为示例前缀。自定义后台路径后,请使用当前站点的后台前缀;插件菜单和请求不要硬编码实际部署地址。
与业务系统集成
| 能力 | 接入方式 |
|---|---|
| 支付 | 实现 GatewayInterface,driver 键 plugin:payjs |
| 短信/邮件 | 实现对应 Interface,安装后在系统设置选驱动名 |
| 实名 | 实现 RealnameProviderInterface,后台选 plugin:http_api |
详见 06–08 章。
从市场 / 压缩包安装
在插件市场取得适配当前版本的插件包,按说明放入对应类型目录,再在 本地插件 中安装、配置和启用。市场内嵌页无法打开时,可使用新窗口浏览。详见 插件市场。
示例插件需按教程自行创建,不代表正式包已预装。管理员审计为系统内置功能,无需另装审计插件。
下一章:04a 插件开发详细教程 · 05-marketplace