开发文档 ›全部章节 ›常见问题 ›函数与钩子速查

13. 函数与钩子速查

这页可以当小抄用。列出来的都在主程序里真实存在,没列的就没有;要用别的双击进代码看一眼。

13.1 视图与插件里能直接调的函数

写法作用
tplcfg('key')取当前模板配置:Config.php 的默认值被数据库里的覆盖值替换后的结果
dtr('name')站点信息,不传参拿整组;后台「站点设置」里那些字段
tpl_url('css/style.css')本模板静态资源地址,指向 templates/当前模板/public/pc/,一定要用它,别写死路径
url('sort', ['id'=>3, 'page'=>2])生成前台地址,自动带伪静态后缀和子目录
nav_url('https://...')友链地址清洗,空值会退回 #
nav_on($href)当前页是不是这个链接,用来给导航加 on
cut($s, 80)截断,UTF-8 安全
e($s)输出转义,凡是用户写的内容都必须过它
ad(1)广告位 1 的代码,后台关掉广告就返回空
site_stats('list')站点总数:list / wz / sort / apply
plugin_active('pay')插件装了且开启,模板判断「这功能让插件接管」用它,别用 plugin_installed()
Config::get('site_head', '')直接读站点设置里的任意键
Hooks::fire('front_head')放钩子,插件往里塞东西
sysmsg($text, true)后台提示跳转
json_out($data, 1)接口输出

13.2 全量钩子清单

钩子名用法触发位置典型用途
front_headfire </head> 前插件插 css、js、meta
front_body_startfire <body> 后插全局脚本
front_slot_headfire 页头之后顶部通栏
front_nav_extrafire 导航条末尾加导航入口
front_slot_homefire 首页中间首页推荐位
front_slot_sidefire 侧栏侧栏模块
front_slot_detailfire 内页正文后相关推荐、免责声明
front_footer_extrafire 页脚链接区插件挂前台入口最常用的就是它
front_body_endfire </body> 前统计代码
front_indexfilter 首页数据数组改首页要用的变量,返回处理后的数组
front_navfilter 导航页数据数组改导航页
front_newestfilter 最新收录页数据数组这套数据最终喂给 sort 视图,$list_route 标着 newest
front_wzallfilter 文章首页数据数组改 /news.html 那页要用的变量
front_targetfire 站点或文章被访问埋点用
front_gofire 外链跳转统计跳转
front_404fire 命中 404记日志
admin_headfire 后台每个页面头部插件给后台加 css/js
admin_slot_form_sitefilter 后台站点编辑表单在表单里加字段
admin_slot_form_articlefilter 后台文章编辑表单同上
admin_slot_form_applyfilter 后台投稿审核表单同上
front_slot_form_applyfilter 前台申请收录的表单在表单里加字段,default 和 azure 这类模板都留了位置
article_endfilter 文章正文收尾正文读得到才输出,返回一段 HTML 拼在正文后面;付费文没解锁时不触发
user_tabsfilter 会员中心标签数组给会员中心加标签页
user_tab_htmlfilter 标签页内容 HTML配套上一条输出内容
register_checkfilter 注册前的检查返回字符串就是给用户看的拒绝理由
register_form_extrafire 注册表单末尾加字段
login_form_extrafire 登录表单末尾加字段。注意:这个位置只有 forum 模板的登录页留了,别的模板里挂不进去
apply_submittedfire 投稿提交后通知、送审
apply_rejectedfire 投稿驳回后通知
site_savedfire 站点新增或修改后同步
site_passfire 站点审核通过同步
article_savedfire 文章保存推送
text_checkfilter 用户提交文本入库前敏感词拦截

13.3 插件基类可重写的方法

方法什么时候被调
register(): void必须实现,插件开启时框架调它,用来挂钩子
routes(): array注册前台路由,[正则, 回调] 的数组
boot(): void默认就是调 register(),要额外初始化再重写它
adminForm(): ?string后台设置弹窗的 HTML,返回 null 就没设置
adminSave(array $post): void后台点保存时调
adminAction(string $action): void/admin/plugin/run/插件名/动作,输出 HTML 片段
adminApi(string $action): void/admin/plugin/api/插件名/动作,只出 JSON
cronTask(): ?array向定时任务中心报名
asset($rel)取插件自己的静态资源地址
renderFront($view, $data)渲染插件视图并套客户当前模板的头尾
config($key, $default) / saveConfig($kv)读写 config.json,开关走框架
configPath()config.json 的绝对路径
打包规则 第 10 节
作者 QQ 260468289
QQ 群 1023163759

内容有问题去论坛发帖,或直接联系老李 QQ 260468289。