跳到主要内容
万能墙开放平台
插件开发教程

15 分钟写出第一个插件

全部内容基于万能墙真实的插件平台(清单 + 钩子 + 接口 + 后台页 + 数据 + 定时任务),示例可直接复制运行。

你能做出什么

万能墙的插件体系允许你在完全不修改核心代码的前提下:

  • 给前台注入 HTML(页头 / 页体顶部 / 页脚 / 导航)
  • 注册新的 API 接口(自动出现在接口文档里)
  • 增加后台管理页(自动按权限显示在「插件管理」里)
  • 增加前台页面(plugin.php?p=你的slug&view=xxx)
  • 写短代码 [你的标签],在帖子内容里生效
  • 建自己的数据表、上传目录、定时任务
  • 监听核心事件(发帖、评论、注册、删除…)与过滤核心输出

一个插件就是一个目录,放进 backend/plugins/<slug>/ 就会被识别。

目录结构

text
backend/plugins/my_plugin/
├── plugin.json     # 清单(必需):名称、版本、能力、设置项、生命周期
├── plugin.php      # 入口(必需):插件启用时被 require,在这里注册钩子
└── lifecycle.php   # 可选:安装 / 卸载回调

第 1 步:写清单 plugin.json

json
{
  "slug": "my_plugin",
  "name": "我的第一个插件",
  "version": "1.0.0",
  "author": "你的名字",
  "description": "在页脚显示一句问候语",
  "homepage": "https://example.com",
  "license": "MIT",
  "requires": { "core": ">=1.0.0", "php": ">=7.4" },
  "capabilities": ["admin_ui"],
  "priority": 50,
  "settings": [
    { "key": "text", "label": "问候语", "type": "text", "default": "你好,万能墙!",
      "help": "会显示在每个页面的页脚" }
  ]
}

> slug 必须是小写字母、数字、下划线或短横线,2~40 位;它同时是目录名、接口前缀(按需)与市场的唯一标识,发布后不能改。

第 2 步:写入口 plugin.php

php
<?php
/**
 * Plugin Name: 我的第一个插件
 * Version: 1.0.0
 * Description: 在页脚显示一句问候语
 * Author: 你的名字
 */

// 1) 页脚注入:往 plugin_render_footer 这个过滤器上挂一段 HTML
addFilter('plugin_render_footer', function ($html) {
    $text = pluginSetting('my_plugin', 'text', '你好,万能墙!');
    return $html . '<div style="text-align:center;padding:10px;color:#888;font-size:12px">'
         . htmlspecialchars($text, ENT_QUOTES, 'UTF-8') . '</div>';
});

// 2) 注册一个只读 API:GET api?action=my_hello
registerApiRoute('my_hello', [
    'method' => 'GET',
    'auth'   => 'none',
    'desc'   => '返回一句问候(示例接口)',
    'no_params' => true,
], function ($ctx) {
    return [
        'message' => 'hello from my_plugin',
        'time'    => date('c'),
    ];
});

// 3) 记一条日志,方便在后台「插件日志」里看到插件跑起来了
pluginLog('my_plugin', 'info', '插件已加载');

第 3 步:装到墙上试

1. 把 my_plugin/ 整个目录放进 backend/plugins/;

2. 后台 → 插件管理 → 找到「我的第一个插件」→ 点启用;

3. 打开首页,页脚应该出现你写的问候语;

4. 访问 api?action=my_hello,应返回 {"success":true,"code":"OK",...,"data":{"message":"hello from my_plugin"}};

5. 在插件设置里改一句问候语,刷新首页即可看到变化。

顺带一提:下划线风格的 API 也能用

如果你手上的插件是用 add_action / add_filter / register_api_route / plugin_setting

这种下划线风格写的,不用改代码:平台为常见的插件 API 都提供了同义别名

(add_filter = addFilter、plugin_setting = pluginSetting、plugin_table = pluginTableName …),

两种写法行为完全一致。

第 4 步:打包上传到开放平台

把 my_plugin/ 目录压成 zip(zip 里第一层就是插件目录,不要多套一层文件夹):

text
my_plugin-1.0.0.zip
└── my_plugin/
    ├── plugin.json
    └── plugin.php

然后到本站 开发者控制台 → 提交新插件 上传。站长审核通过后,所有万能墙站长就能在插件市场一键安装了。

常见坑(新手 90% 会踩)

| 现象 | 原因 |

| --- | --- |

| 后台插件列表里找不到 | 目录放错层级(必须是 backend/plugins/<slug>/plugin.php),或 plugin.json 不是合法 JSON |

| 页面没变化 | 忘记在插件管理里启用;或钩子名写错(对照「扩展点清单」) |

| api?action=xxx 返回 METHOD_NOT_ALLOWED | 方法不匹配:写接口要用 POST,读接口声明 GET |

| 中文乱码 | 文件必须是 UTF-8 无 BOM |

| 改了代码没生效 | 停用再启用一次插件,或等清单缓存(按目录 mtime 自动失效) |