QKCMS模板开发文档-QKCMS

首页 _ QKCMS _ QKCMS模板开发文档-专题单页

QKCMS模板开发规范

重要说明：文档中所有标签前都加了一个空格（如{ qkcms:标签名}）以防止被前台解析，实际在模板制作中请去掉这个空格。

QKCMS采用标签化模板开发体系，分为默认模板与自定义模板，分别存放于templates/与templates/skin/目录。系统使用{qkcms:标签名}格式标签，内置网站级别标签27个、文章标签24个、列表标签8个、商品标签22个、循环标签10个，支持文章列表、分页、筛选等功能调用。同时支持模板嵌套、插件调用与响应式设计，开发者无需编写复杂PHP代码，即可快速搭建页面。文档还对标签写法、参数规则、性能与安全做出规范，降低开发门槛，提升建站效率。

1. 插件开发规范

项目	说明	示例
文件命名	扩展名.php，存放目录admin/Plugin/，文件名ID_插件名.php，禁止中文名称	1_alipay.php
插件信息	使用PHP文档注释定义插件信息	/** @id 1 @name 插件名称 @version 1.0.0 @description 功能描述 @price 0 @type 工具或插件 @website 作者网站 @width 500 @height 400 */
插件类型	插件可在前台和后台调用，工具仅能在后台操作	@type 插件或 @type 工具
前台调用	特定工具可通过 @frontend_callable true 标识允许前台调用	@frontend_callable true
参数格式	输入框：参数名 = 默认值，下拉框：参数名 = 默认值\|select\|选项1,选项2,选项3	参数名1 = 参数值1
自动插入模板	使用 @tpl 字段指定模板文件相对路径，安装后自动插入调用标签	@tpl templates/footer.html
提示框函数	前端提示消息	callParentToast('消息内容', { type: 'success/error/info/warning' })
确认框函数	前端确认对话框	callParentConfirm('确认消息').then(function(result) { /* 处理结果 */ })
CSS样式	禁止使用 body、* 等全局标签样式	.plugin-class { /* 样式 */ }
HTML输出	建议使用HEREDOC语法	<<<EOT HTML内容 EOT;
安全性	禁止使用 eval()、exec() 等危险函数	使用标准PHP函数
兼容性	确保PHP 7.0+兼容	使用标准PHP函数
插件卸载与清理	卸载插件时需清理相关数据和模板修改	卸载前备份数据

2. 模板文件结构

模板类型	存放目录	说明
默认模板	templates/	系统默认模板目录
自定义模板	templates/skin/	可在后台文章发布或分类管理中绑定
模板文件备份	修改模板前建议备份原文件，避免无法恢复	定期备份重要模板

3. 模板目录结构

文件	说明
index.html	首页模板
list.html	分类列表模板
post.php	文章详情模板
category.html	分类页模板
search.html	搜索页模板
tag.html	标签页模板
footer.html	公共尾部
head.html	公共头部
goods.php	商品展示模板
member.php	会员中心模板
publish.php	投稿页面模板
comment.php	评论模板
page.php	分页模板
skin/	自定义模板目录

4. 标签化处理技术

标签格式	说明	示例
{qkcms:标签名}	标准标签格式	{ qkcms:site_name}
标签查看	后台管理面板——模板标签页面	网站级别标签27个、文章标签24个、列表标签8个、商品标签22个、循环标签10个
注意事项	文档中标签前有空格防解析	实际模板制作中不能有空格
标签调试与测试	使用标签后建议在前台测试，确保显示正常无误	多浏览器测试兼容性

5. 全局标签类型示例

标签	说明
{ qkcms:site_name}	网站名称
{ qkcms:site_title}	站点标题
{ qkcms:site_description}	站点描述
{ qkcms:current_position}	当前位置

6. 分类列表页标签示例

标签	说明
{ qkcms:category_id}	分类ID
{ qkcms:cat_name}	分类名称
{ qkcms:cat_thumbnail}	分类缩略图
{ qkcms:cat_posts}	分类文章总数

7. 列表页标签示例

标签	说明
{ qkcms:cat_name}	分类名称
{ qkcms:cat_url}	分类链接
{ qkcms:cat_thumbnail}	分类缩略图
{ qkcms:cat_posts}	分类文章总数

8. 文章页标签示例

标签	说明
{ qkcms:posts_title}	文章标题
{ qkcms:posts_content}	文章内容
{ qkcms:posts_thumbnail}	文章缩略图
{ qkcms:posts_views}	浏览量
{ qkcms:posts_comments}	评论数
{ qkcms:posts_author}	作者
{ qkcms:posts_date}	发布时间

9. 商品页标签示例

标签	说明
{ qkcms:goods_title}	商品标题
{ qkcms:goods_price}	商品价格
{ qkcms:goods_thumbnail}	商品缩略图
{ qkcms:goods_description}	商品描述
{ qkcms:goods_stock}	库存数量
{ qkcms:goods_sales}	销量

10. 文章循环标签调用示例

循环标签：{ qkcms:articles row=5 col=2 property=0 order=comment titlelen=40 description_len=100 tag="1,TAG词"}

子标签说明：

子标签	说明
[thumbnail]	缩略图
[title]	标题
[title_id]	标题ID
[url]	链接
[author_id]	作者ID
[author]	作者
[author_level]	作者等级
[author_avatar]	作者头像
[date]	时间
[views]	浏览量
[comments]	评论数
[like_count]	点赞数
[category]	分类
{cat_url}	分类链接
[description]	描述
[keywords]	关键词

参数说明：

参数	说明	示例
row	条数	row=5
col	列数	col=2
order	排序	updated(更新时间)/comment(评论量)/hot(浏览量)/keywords(第一个关键词)
category_id	分类ID	不写=当前栏目/-1=全站/数字=指定栏目
titlelen	标题长度	titlelen=40
description_len	描述长度	description_len=100
property	属性筛选	0=普通/1=头条/2=热门/3=推荐/4=公告/5=给力
tag	标签匹配	tag="1,TAG词"(需双引号，匹配标题/描述/关键词)
page	分页	page=1(配合绑定，分页循环标签处理)

11. 伪静态规则

URL格式	说明
/post_id1.php	文章页
/list_id2.html	分类列表
/search_关键词.html	搜索页
/tag_TAG词.html	标签页

12. 其他注意事项

项目	说明	示例
插件调用	插件可在前台和后台调用，工具仅能在后台操作，特定工具可通过 @frontend_callable true 标识允许前台调用	{qk_Plugin:ID}
模板嵌套	支持调用头部和尾部模板	{ qkcms:head.html} / { qkcms:footer.html}
响应式设计	确保不同设备正常显示	使用CSS媒体查询
性能优化	避免过多嵌套循环标签	合理使用缓存
安全性	禁止危险函数	禁止eval()、exec()等
兼容性	确保PHP 7.0+兼容	使用标准PHP函数
模板更新与维护	定期检查模板和插件更新，保持系统最新状态	关注官方更新公告

QKCMS模板开发文档评论区

写下你的评论...

游客

最新评论最早评论最热评论