示例插件 · 工具箱 精选 v1.0.1
官方示例插件(也是插件模板):设置项 / 自建表 / 自定义接口 / 短代码 / 页脚注入+静态资源 / 后台页 / 前台页 / 定时任务 / 核心事件,全部真实用了一遍。
插件说明
这是什么
官方示例插件,同时就是插件模板。它实现了一个真实可用的小工具(条目录入 + 展示),并把插件平台的扩展点全部用了一遍,每处都有中文注释。
它演示了什么
| 扩展点 | 怎么写的 |
| --- | --- |
| 设置项 | plugin.json 的 settings,后台自动渲染表单 |
| 自建数据表 | pluginTableName() + pluginCreateTable()(安装钩子建表) |
| 自定义接口 | registerApiRoute():GET demo_toolkit_list / POST demo_toolkit_add |
| 短代码 | [demo_toolkit count="3"] |
| 页脚注入 | addFilter('plugin_render_footer', …),顺带加载 assets/toolkit.css|js |
| 后台页 | registerAdminPage() + views/admin.inc.php |
| 前台页 | registerFrontView() → /plugin.php?p=demo_toolkit&view=index |
| 定时任务 | registerPluginCron():每天清理 7 天前的条目 |
| 核心事件 | addAction('post_purged', …) |
| 自定义钩子 | registerHookDoc() 声明给别的插件用 |
怎么当模板用
1. 复制目录改名,或先用「起始包生成器」生成干净骨架;
2. 改 plugin.json 的 slug / name / capabilities;
3. 改 plugin.php 里的表名、接口名与逻辑;
4. 上传前自检:php backend/plugin_lint_cli.php backend/plugins/你的标识。
> 想核对全部可用钩子与函数:GET /api?action=plugin_contract(公开只读,不需要源码)。
能力与权限
插件能做什么由 plugin.json 里的 capabilities 声明决定:只有声明过的能力才被放行,
越权调用会被核心拒绝。整体风险:中等风险
dbfilesadmin_uifront_ui数据收集范围
开发者未声明数据收集范围。该插件声明了可能接触站点数据的能力(db),请向开发者确认具体用途与数据范围。
安装前必读
- 备份数据库与
backend/:先备份站点数据库,以及整个backend/目录(含已有插件与配置),确认可以回滚再动手。 - 先在测试站验证:在测试环境安装并启用,走一遍前后台主要页面与插件功能,确认没有报错、没有异常外发请求,再上生产站。
- 核对 SHA-256:一键安装会自动校验,不一致会直接拒绝;手动安装请比对
0b0b68ce622bc50d6453844db8249e3c4f00e1e3a6b3875df5626df591fc4c5a(见下方版本历史)。 - 观察期:启用后留意后台日志与站点速度;插件回调出错只记日志并计入熔断,不会拖垮整站,但异常频繁时会被自动停用。
安装方式
方式一:后台一键安装(推荐)
万能墙后台 →「插件管理」→「插件市场」→ 搜索 demo_toolkit → 点「一键安装」。
后台会从本站下载 zip、核对 SHA-256、解压到 backend/plugins/,最后点「启用」即可。
方式二:手动安装
- 下载 zip 并解压,得到
demo_toolkit/目录(内含plugin.json与plugin.php); - 把整个目录放到站点
backend/plugins/下; - 后台「插件管理」里点「启用」,再按需配置设置项。
方式三:核对哈希后安装
curl -sO https://liuwall.lhuiye.cn/download.php?slug=demo_toolkit&version=1.0.1
shasum -a 256 demo_toolkit-1.0.1.zip