本文分析emlog5下的模板基本结构以及基本变量、函数的作用，详细了解本文，有助于更快掌握emlog5的模板开发基础。

emlog的模板位于安装目录content\templates\文件夹下，每个模板都是一个单独的文件夹，文件夹以模板名字命名。通过后台上传安装的模板都保存在这个目录下。

模板文件目录说明

一般来说，一个模板都会包含以下几个部分：

• images文件夹：存放模板所需图片。
• echo_log.php：显示日志内容。
• footer.php：页面底部。
• header.php：页面头部。
• log_list.php：显示日志列表内容。
• main.css：模板的css文件。
• module.php：模板公共代码，包含侧边widgets、评论、引用、编辑等，该文件是模板最核心的模块。
• page.php：自定义的页面内容的模板。
• preview.jpg：在后台模板选择界面显示的模板预览图，300×225 jpg格式。
• side.php：模板侧边栏文件，如制作单栏模板则该文件不是必须的。
• t.php：显示emlog系统自带的微博（碎语）内容。
• 404.php 自定义404页面未找到时的报错页面

在一般的emlog模板开发中，以上提及的部分中echo_log.php、log_list.php、module.php、page.php、t.php、header.php以及preview.jpg是不可或缺的，一旦缺省，模板将无法运行。此外的side.php、footer.php、main.css、images文件夹等，只需要对模板代码做小部分更改，那么它们都是可以改名、移动、甚至删除的。

下面我们将对以上各模块进行简要分析：

公共代码分析

通过预览整个模板中的各个文件，你会发现以下代码同时存在于多个文件中，这些代码分别有以下用途： 

if(!defined('EMLOG_ROOT')) {exit('error!');} 

此行代码存在于模板目录下的每个php文件起始部分(事实上为了安全起见，该行代码也在admin目录下的几乎所有php文件起始部分存在)，其作用是防止代码所在的php脚本被直接访问执行。 

require_once View::getView('side'); 
require_once View::getView('footer'); 

这两行代码存在于log_list.php、echo_log.php、page.php、t.php里面，其作用是调用模板文件夹下的side.php和footer.php的代码到当前文件的当前位置。

View是emlog的模板视图控制器，View::getView('文件名','文件后缀')将返回当前模板安装路径下对应的文件。getView函数的第二个参数为缺省参数，在不传入值的情况下，将默认作为.php文件后缀返回文件路径。

header.php

开头注释内容是模板信息，该信息显示在模板选择界面

Template Name:模板名称

Description:模板介绍描述

Author:模板作者

Author Url:作者或模板发布的URL

Sidebar Amount:标记该模板有几个侧边栏，一般为1，有些模板有两个侧边栏则标记2。这样可以在后台widgets里识别管理（具体可下载体验官方收录的模板G7）。

之后是具体代码部分：

if(!defined('EMLOG_ROOT')) {exit('error!');}

该行代码同样存在于其它模板文件中，为防止该文件被直接执行。

require_once View::getView('module');
// 加载模板公共代码

$site_title：站点标题

$site_key：关键字

$site_description：输出博客设置的摘要

BLOG_URL：博客首页的URL，输出形如http://www.emlog.pro/

TEMPLATE_URL：模板文件夹的URL，用于加载模板内的css、js及其他内容，输出形如http://www.emlog.pro/content/templates/default/ * BLOG_URL.Option::get('topimg')：这句可以无视，因为只默认模板可以自定义banner，其它模板没这功能（卡片语：很没营养的设定，嗯。）

判断当前是否首页，是则给导航加current类，用于表现当前位置。 ……. 如后台设置在前台显示碎语，则输出…….中的内容。 判断当前URL是否为碎语并选择加类名。 ……. 输出自定义页面的链接

footer.php

Option::EMLOG_VERSION：获得版本号。

$icp：获得后台设置的ICP备案号。

页脚底部挂载点加入。

log_list.php

页脚底部挂载点加入。

$value['logid'] 该变量为当前日志的id

显示置顶标记，该函数位于模板module.php内。 输出日志URL 输出日志标题

输出日志的作者，该函数位于模板module.php内。

输出日志发布时间，参数'Y-n-j G:i l'用于定义日期格式。

输出日志所属的分类，该函数位于模板module.php内。

当管理员或作者登陆时显示“编辑”链接，该函数位于模板module.php内。

输出日志摘要（没有摘要则输出全文）。

如日志有附件则输出附件，该函数位于模板module.php内。

输出日志的标签，该函数位于模板module.php内。

输出当前日志的评论数。

输出当前日志的引用量。

输出当前日志的浏览量。

显示当前列表页的翻页功能。

加入侧边栏及加入页脚。

echo_log.php

该文件功能函数与列表页一致，但参数有区别，注意区分。

$logid 该变量为当前日志的id。

显示置顶标记，该函数位于模板module.php内。 

输出日志标题。 

输出日志的作者，该函数位于模板module.php内。

 输出日志发布时间，参数'Y-n-j G:i l'用于定义日期格式。 

输出日志所属的分类，该函数位于模板module.php内。 

当管理员或作者登陆时显示“编辑”链接，该函数位于模板module.php内。 

输出日志全文内容。 

如日志有附件则输出附件，该函数位于模板module.php内。 

输出日志的标签，该函数位于模板module.php内。 

日志页显示评论数。

日志页显示引用数。

日志页显示浏览量。

相关日志的挂载点，与3.x版本不同，4.0带第二参数。 

输出邻近，就是上一篇及下一篇，该函数位于模板module.php内。

输出该日志被引用的信息列表，与3.x不同注意区分。

输出该日志评论列表，与3.x不同注意区分。

输出发表评论框，与3.x不同注意区分。

page.php

该文件写法与echo_log.php类似，不再重复。

t.php

与之前相同的内容不再重复。 

输出头像。

输出作者名。 

输出碎语内容。 

根据当前url输出博客地址，主要用于js，解决跨域问题。 

输出碎语所在数据库中的id号。

发布碎语的时间。

$reply_code ：其值为‘n’或‘y’，后台设置是否启用碎语回复验证码。

输出验证码。

side.php

侧边栏，主要负责根据后台widgets设置信息输出侧边栏内容。建议该文件内代码保持不变。

module.php

模板公共代码，包含侧边widgets、评论、引用、编辑等。 该文件由若干函数组成，被博客前台文件调用，可在内自定义函数实现更多功能。 

如在自定义函数内调用emlog缓存时，假设读取user缓存信息，则形如： global $CACHE; $user_cache = $CACHE→readCache('user'); 

如需要操作数据库，则形如： $DB = MySql::getInstance(); $res = $DB→query($sql); 

以上两点与3.x不同，请注意区分。

404.php

用于自定义404页面的模板。

最后附：前台模板部分挂载点一览

doAction('index_footer'); 页脚底部挂载点

doAction('index_loglist_top'); 首页日志列表顶部挂载点

doAction('log_related', $logData); 相关日志挂载点

doAction('diff_side'); 侧边栏挂载点

emlog支持插件机制，这样使得开发者可以方便地向emlog中添加自己需要的功能。

一、插件实现原理

在emlog整个运行过程中我们设定了一些动作事件，遇到这些事件时emlog会自动的调用插件绑定到该事件的上的所有插件函数，从而实现插件的功能。

二、插件挂载点

挂载点

函数：doAction 本函数内置于emlog核心代码中，就是传说中的插件挂载点。 

本函数有一个固定的参数：$hook。$hook是执行动作的名称，其他的参数则可以在调用本函数时依次传入，函数会自动的发送给钩子函数。

例子:

doAction('save_log',$id);
这是emlog的添加日志事件,在添加日志后会触发,参数为新日志的$id号码.
那么系统会自动的将$id传入到每一个绑定到本事件的钩子函数中。

添加事件调用方法

函数: addAction 本函数是插件用来想挂载点挂载方法的函数，写在插件文件中。 

函数有两个参数：$hook, $actionFunc。

$hook 是绑定事件的名称, $actionFunc 是绑定到该事件钩子上的函数名称。

例子:

addAction('save_log','plugin_addlog');
例子中将plugin_addlog函数绑定到系统的save_log事件中,只要系统执行到了save_log挂载点时,就会调用plugin_addlog函数。

插件文件系统

插件目录：/content/plugins/ 仅识别 “插件目录/插件名/插件名.php” 目录结构的插件。 

例如：emlog默认的tips插件，其文件夹名称为tips，程序文件名称为tips.php

插件的激活与关闭

在emlog后台的插件管理中，点击每个插件后的状态按钮即可激活/关闭插件。

自emlog4.0.0起增加激活和关闭插件函数，来完成激活和关闭时的一些初始化工作。如果插件需要，可以给插件增加 plugin_callback.php 文件，其中包含两个函数： callback_init()为插件激活时调用，callback_rm()为插件关闭时调用。

插件前台显示页面

如果想让插件在前台输出一个页面，可以在插件中定义一个 pluginname_show.php 的文件。此时插件的前台显示地址为：http:博客地址/?plugin=pluginname，这样就可以在pluginname_show.php文件构建插件的页面显示。 

插件后台显示配置页面

如果你想让插件在后台输出一个设置页面，可以在插件中定义一个 pluginname_setting.php 的文件，此时插件的后台配置地址为：http:博客地址/admin/plugin.php?plugin=pluginname

三、插件开发标准

插件命名规则

插件名只能以半角的字母、数字、下划线()、横杠(-) 组合而成，且只能以字母作为开头。

函数/变量命名标准

插件的所有函数/变量采用 "插件名" 作为前缀来命名。

例如：$emlogplugin_var emlogplugin_dosomething() 

采用这样的命名方式可以避免于其他插件的函数或者变量出现冲突.。

插件文件名称

插件主文件名称必须与插件所在文件夹名称相同，设定插件参数的配置程序文件名称必须为 “插件名称_setting.php” (注:该文件为可选，如果你的插件需要用户配置参数才需要该文件来完成配置功能)。

例如：emlogplugin/emlogplugin.php emlogplugin_setting.php

安全性

在插件文件开头增加限制语句，插件函数文件需要增加: 

!defined('EMLOG_ROOT') && exit('access deined!'); 

如果不增加该语句，那么直接访问插件的程序文件php会爆出博客的物理路径，对博客的安全造成威胁。 

如果你的插件需要接收一些参数，请务必严格过滤每一个变量的数据。

例如：获取外部获取一个int型的参数，$id = $_GET['id']，这样写是不安全的，要改为：$id = intval($_GET['id'])； 如果是一个字符型的参数，$action = $_GET['action']，这样写也是不安全的，要改为：$action = addslashes($_GET['action'])。

更多安全方面的内容可以参考一下这篇文章《PHP 安全指南》

前台链接使用绝对地址。

四、当前插件挂载点及说明

1、挂载点：doAction('adm_main_top')

• 所在文件：admin/views/header.php
• 描述：后台红线区域扩展

2、挂载点：doAction('adm_head')

• 所在文件：admin/views/header.php
• 描述：后台头部扩展：可以用于增加后台css样式、加载js等

3、挂载点：doAction('adm_siderbar_ext')

• 所在文件：admin/views/header.php
• 描述：后台侧边栏 功能扩展 子菜单扩展，用于插件单独页面。

4、挂载点：doAction('save_log', $blogid)

• 所在文件：admin/save_log.php
• 描述：新增日志、修改日志扩展点

5、挂载点：doAction('del_log', $key)

• 所在文件：admin/admin_log.php
• 描述：删除日志操作扩展点

6、挂载点：doAction('adm_writelog_head', $key)

• 所在文件：
• admin/add_log.phpadmin/add_page.phpadmin/edit_log.php
• admin/edit_page.php
• 描述：可以再红框处显示扩展内容，如插入网络相册照片的插件。

7、挂载点：doAction('comment_post')

• 所在文件：./index.php
• 描述：发表评论扩展点（写入评论前）。可用于垃圾评论防范

8、挂载点：doAction('comment_saved’)

• 所在文件：include/model/comment_model.php
• 描述：发表评论扩展点（写入评论后）。用于发布评论成功的后续操作，如发通知邮件

9、挂载点：doAction('log_related',$logData)

• 所在文件：content/templates/default/echo_log.php
• 描述：阅读日志页面扩展点、用于增加日志相关内容

10、挂载点：doAction('index_head')

• 所在文件：Content/templates/default/header.php
• 描述：前台头部扩展：可以用于增加前台css样式、加载js等

11、挂载点：doAction('index_footer')

• 所在文件：content/templates/default/footer.php
• 描述：首页底部扩展点

12、挂载点：doAction('comment_reply', $commentId, $reply)

• 所在文件：admin/comment.php
• 描述：回复评论扩展点

13、挂载点：doAction('data_prebakup')

• 所在文件：admin/data.php
• 描述：扩展备份数据库页面，可以对插件增加的表进行备份

14、挂载点：doAction('rss_display')

• 所在文件：rss.php
• 描述：Rss输出扩展

15、挂载点：doAction('attach_upload')

• 所在文件：include/lib/function.base.php
• 描述：扩展附件上传，如增加图片水印效果等

16、挂载点：doAction('url_rewrite')

• 所在文件：include/lib/function.base.php
• 描述：扩展url重写，可以自定义其他url优化方案

17、挂载点：doAction('adm_comment_display')

• 所在文件：admin/views/comment.php
• 后台评论显示扩展，可以用于查询评论人ip所在地域

18、挂载点：doAction('index_loglist_top')

• 所在文件：content/templates/default/log_list.php
• 描述：日志列表顶部扩展点，如显示公告等

19、挂载点：doAction('diff_side')

• 所在文件：content/templates/default/side.php
• 描述：侧边栏控制扩展点

20、挂载点：doAction('reply_twitter', $r, $name, $date, $tid)

• 所在文件：t/index.php
• 描述：回复碎语扩展点，用于回复邮件提醒等

21、挂载点：doAction('post_twitter', $t)

• 在文件：
• /m/index.php
• /admin/twitter.php
• 描述：发布碎语扩展点，用于碎语和其他微博类产品同步等

22、挂载点：doAction('adm_footer')

• 所在文件：admin/views/footer.php
• 描述：后台底部扩展：可以用于增加后台js等