🧩 插件开发指南
emlog支持插件机制,这样使得开发者可以方便地向系统中添加自己需要的功能。
实现原理
在emlog整个运行过程中我们设定了一些动作事件,遇到这些事件时emlog会自动的调用插件绑定到该事件的上的所有插件函数,从而实现插件的功能。
挂载点函数:doAction
doAction 函数内置于emlog核心代码中,就是所谓的插件挂载点。
//这是首页head头的挂载点,首页加载的时候会执行该挂载点上挂载的插件函数。
doAction('index_head')
插件挂载: addAction
addAction 用于插件向挂载点挂 载自身函数,写在插件文件中。 有两个参数:挂载点名称 和 插件自身函数名称。
// 插件的 add_some_style 函数挂载到系统的 index_head 挂载点上,只要系统执行到 index_head 挂载点时,就会调用 add_some_style 函数.
addAction('index_head','add_some_style');
function add_some_style() {
// 添加一些样式等操作
}
开发规范
文件结构
- 插件目录:/content/plugins,插件目录下每一个文件夹即为一个插件
- 插件英文别名:如系统自带的小贴士插件英文别名为: tips,仅识别 插件英文别名/插件英文别名.php” 目录结构的插件,如: tips/tips.php
文件 | 说明 |
---|---|
xxx.php | 插件主文件 |
xxx_callback.php | 事件回调相关函数文件 |
xxx_setting.php | 插件后台设置页面(仅管理员可见) |
xxx_user.php | 插件后台设置页面(所有人可见) |
xxx_show.php | 插件前台页面 |
preview.jpg | 插件图标,用于后台插件列表展示,尺寸:75x75 像素 |
上面表格中的 xxx 为插件英文别名,下面有插件文件的详细介绍。