[TOC] # 插件基本结构 ## 文件结构 ~~~ tips 插件文件夹 | |——tips.php 插件核心文件(必须) |——tips_callback.php 激活禁用插件时的回调文件(可选) |——tips_show.php 插件前台显示页面(可选) |——tips_setting.php 插件配置页面(可选) ~~~ **插件文件夹命名与插件核心文件名保持一致** > tips_callback.php包含2个方法:激活回调方法callback_init()和禁用回调方法callback_rm() > 若建立了tips_show.php,则可通过“http:博客地址/?plugin=tips”访问插件前台显示页面 > 若建立了tips_setting.php,则可通过“http:博客地址/admin/plugin.php?plugin=tips”访问插件配置页面 ## 注释 ``` /* Plugin Name: 插件名称 Version: 版本号(1.0.1) Plugin URL: 插件地址 Description: 插件描述 Author: 作者 Author URL: 作者地址 */ ``` # 插件实现过程 ## 插件原理分析 > 在emlog整个运行过程中我们设定了一些动作事件,遇到这些事件时emlog会自动的调用插件绑定到该事件的上的所有插件函数,从而实现插件的功能。 > 在include/lib/function.base.php中,定义了2个方法,来实现Emlog的挂载点原理;在include/model/plugin_model.php中,定义了activePlugin和inactivePlugin启用和禁用2个方法,来通过pluginname_callback.php实现回调方法,定义了getPluginData方法,来通过pluginname\_setting.php实现插件设置页面;在include/controller/plugin_controller.php中,定义了loadPluginShow方法,来通过pluginname_show.php实现显示页面。 > 注:以上pluginname为插件名。 ### 挂载点代码实现 ``` /** * 该函数在插件中调用,挂载插件函数到预留的钩子上 * @param string $hook 执行动作的名称:其他的参数则可以在调用本函数时依次传入,函数会自动的发送给钩子函数 * @param string $actionFunc 绑定事件的名称:绑定到该事件钩子上的函数名称 * @return boolearn */ function addAction($hook, $actionFunc) { global $emHooks; if (!@in_array($actionFunc, $emHooks[$hook])) { $emHooks[$hook][] = $actionFunc; } return true; } /** * 执行挂在钩子上的函数,支持多参数 eg:doAction('post_comment', $author, $email, $url, $comment); * @param string $hook 执行动作的名称:其他的参数则可以在调用本函数时依次传入,函数会自动的发送给钩子函数 */ function doAction($hook) { global $emHooks; $args = array_slice(func_get_args(), 1); if (isset($emHooks[$hook])) { foreach ($emHooks[$hook] as $function) { $string = call_user_func_array($function, $args); } } } ``` ### 挂载点使用示例 ``` doAction('save_log',$id);//调用save_log函数 ``` * 这是emlog的添加日志事件,在添加日志后会触发,参数为新日志的$id号码. * 那么系统会自动的将$id传入到每一个绑定到本事件的钩子函数中。 ``` addAction('save_log','plugin_addlog');//定义plugin_addlog函数 ``` * 例子中将plugin_addlog函数绑定到系统的save_log事件中,只要系统执行到了save_log挂载点时,就会调用plugin_addlog函数. # 插件开发标准 ## 插件命名规则 插件名只能以半角的字母、数字、下划线(_)、横杠(-) 组合而成,且只能以字母作为开头 ## 函数/变量命名标准 插件的所有函数/变量采用 "插件名_" 作为前缀来命名 ## 插件安全性 1、插件函数主文件前需要增加: ``` !defined('EMLOG_ROOT') && exit('access deined!'); ``` 2、如果你的插件需要接收一些参数,请务必严格过滤每一个变量的数据,比如: ``` $id = intval($_GET['id']); $action = addslashes($_GET['action']); ``` 3、前台链接使用绝对地址 # 当前插件挂载点及说明 > 延用旧版本挂载点,如略有偏差,请温柔的反馈。 挂载点:doAction('adm_main_top') 所在文件:admin/views/header.php 描述:后台红线区域扩展: ***** 挂载点:doAction('adm_head') 所在文件:admin/views/header.php 描述:后台头部扩展:可以用于增加后台css样式、加载js等 ***** 挂载点:doAction('adm_siderbar_ext') 所在文件:admin/views/header.php 描述:后台侧边栏 功能扩展 子菜单扩展,用于插件单独页面。 ***** 挂载点:doAction('save_log', $blogid) 所在文件:admin/save_log.php 描述:新增日志、修改日志扩展点 ***** 挂载点:doAction('del_log', $key) 所在文件:admin/admin_log.php 描述:删除日志操作扩展点 ***** 挂载点:doAction('adm_writelog_head', $key) 所在文件: admin/add_log.phpadmin/add_page.phpadmin/edit_log.php admin/edit_page.php 描述:可以再红框处显示扩展内容,如插入网络相册照片的插件。 ***** 挂载点:doAction('comment_post') 所在文件:./index.php 描述:发表评论扩展点(写入评论前)。可用于垃圾评论防范 ***** 挂载点:doAction('comment_saved’) 所在文件:include/model/comment_model.php 描述:发表评论扩展点(写入评论后)。用于发布评论成功的后续操作,如发通知邮件 ***** 挂载点:doAction('log_related',$logData) 所在文件:content/templates/default/echo_log.php 描述:阅读日志页面扩展点、用于增加日志相关内容 ***** 挂载点:doAction('index_head') 所在文件:Content/templates/default/header.php 描述:前台头部扩展:可以用于增加前台css样式、加载js等 ***** 挂载点:doAction('index_footer') 所在文件:content/templates/default/footer.php 描述:首页底部扩展点 ***** 挂载点:doAction('comment_reply', $commentId, $reply) 所在文件:admin/comment.php 描述:回复评论扩展点 ***** 挂载点:doAction('data_prebakup') 所在文件:admin/data.php 描述:扩展备份数据库页面,可以对插件增加的表进行备份 ***** 挂载点:doAction('rss_display') 所在文件:rss.php 描述:Rss输出扩展 ***** 挂载点:doAction('attach_upload') 所在文件:include/lib/function.base.php 描述:扩展附件上传,如增加图片水印效果等 ***** 挂载点:doAction('url_rewrite') 所在文件:include/lib/function.base.php 描述:扩展url重写,可以自定义其他url优化方案 ***** 挂载点:doAction('adm_comment_display') 所在文件:admin/views/comment.php 后台评论显示扩展,可以用于查询评论人ip所在地域 ***** 挂载点:doAction('index_loglist_top') 所在文件:content/templates/default/log_list.php 描述:日志列表顶部扩展点,如显示公告等 ***** 挂载点:doAction('diff_side') 所在文件:content/templates/default/side.php 描述:侧边栏控制扩展点 ***** 挂载点:doAction('reply_twitter', $r, $name, $date, $tid) 所在文件:t/index.php 描述:回复碎语扩展点,用于回复邮件提醒等 ***** 挂载点:doAction('post_twitter', $t) 所在文件: /m/index.php /admin/twitter.php 描述:发布碎语扩展点,用于碎语和其他微博类产品同步等 ***** 挂载点:doAction('adm_footer') 所在文件:admin/views/footer.php 描述:后台底部扩展:可以用于增加后台js等