# 5. 插件事件
## 事件說明
事件的定義寫在`插件名稱類`文件里面,方法命名方式以Hook結尾,字母駝峰式命名。
## 插件能使用的事件
> 2.1.220504版本起插件事件不在使用下劃線調用,但依然支持舊版的下劃線方式
事件名稱插件名稱類使用方式描述參數說明addons\_init
2.1.220504版本起:addonsInitaddonsInitHook插件初始化,這個事件能影響到前臺、后臺,優先級最高-addonMiddlewareaddonMiddlewareHook插件全局中間件,只要訪問任意插件前臺時觸發請求的Request對象addonsBeginaddonsBeginHook插件路由調度前事件,訪問插件控制器時觸發請求的Request對象addonModuleInitaddonModuleInitHook插件控制器初始化前事件,訪問插件控制器時觸發請求的Request對象addonsActionBeginaddonsActionBeginHook插件控制器操作方法執行前事件,訪問插件控制器操作方法時觸發傳入控制器對象與將要操作的方法indexRouteindexRouteHook訪問前臺時,在路由初始化時觸發,無adminRouteadminRouteHook訪問后臺時,在路由初始化時觸發無apiRouteapiRouteHook訪問api時時,在路由初始化時觸發無configInitconfigInitHook訪問前臺或后臺時,站點配置初始化后觸發(前后臺的基礎類)站點配置adminLoginSuccessadminLoginSuccessHook后臺登錄成功后標簽位登錄信息indexHeadindexHeadHook前臺模板頭部標簽位無indexFooterindexFooterHook前臺模板底部標簽位無themeChangethemeChangeHook模板主題切換事件傳入index\_theme,或admin\_themeuploadAfteruploadAfterHook文件上傳后觸發傳入文件信息數組uploadDeluploadDelHook文件刪除后觸發傳入刪除的模型對象addonConfig\_save插件保存配置時觸發(已廢棄)提交的配置表單插件標識ConfigSave插件或模板配置保存時觸發(2.1.220220新增)提交的配置表單,例如你的插件叫:demo, 事件定義為:demoConfigSaveHookapiAuthMiddlewareapiAuthMiddlewareHookAPI權限中間件請求Request對象apiLoginMiddlewareapiLoginMiddlewareHookAPI登錄中間件請求Request對象HttpRunHttpRunHook應用開始標簽位(TP內置)無HttpEndHttpEndHook應用結束標簽位(TP內置)當前響應對象實例RouteLoadedRouteLoadedHook路由加載完成(TP內置)無LogWriteLogWriteHook日志write方法標簽位(TP內置)當前寫入的日志信息## 使用方式
例如插件名稱叫`demo`,在`Demo`插件名稱類里面,若要使用`indexHead`前臺模板頭部事件。這里首先需要模板有放置該標簽事件,可前往默認模板找到head.html文件,即可看到`{:hook("indexHead")}`,當訪問前臺頁面執行到`{:hook("indexHead")}`時就會調用下面的`indexHeadHook`方法。
完整寫法如下
```
<pre class="calibre16">```
<span class="token"><</span><span class="token">?</span>php
declare <span class="token1">(</span>strict_types<span class="token">=</span><span class="token3">1</span><span class="token1">)</span><span class="token1">;</span>
namespace addons\demo<span class="token1">;</span>
use think\Addons<span class="token1">;</span>
class <span class="token6">Demo</span> extends <span class="token6">Addons</span>
<span class="token1">{</span>
public <span class="token2">function</span> <span class="token6">install</span><span class="token1">(</span><span class="token1">)</span>
<span class="token1">{</span>
<span class="token2">return</span> <span class="token3">true</span><span class="token1">;</span>
<span class="token1">}</span>
public <span class="token2">function</span> <span class="token6">uninstall</span><span class="token1">(</span><span class="token1">)</span>
<span class="token1">{</span>
<span class="token2">return</span> <span class="token3">true</span><span class="token1">;</span>
<span class="token1">}</span>
<span class="token5">// 前臺模板執行到<head></head>時觸發,通常用于加載JS、CSS達到特定的需求</span>
public <span class="token2">function</span> <span class="token6">indexHeadHook</span><span class="token1">(</span><span class="token1">)</span>
<span class="token1">{</span>
<span class="token5">// 加載js</span>
<span class="token2">return</span> <span class="token4">"<script src='/static/main.js'></script>"</span><span class="token1">;</span>
<span class="token5">// 或直接渲染視圖,可參考插件視圖</span>
<span class="token2">return</span> $this<span class="token">-</span><span class="token">></span><span class="token6">fetch</span><span class="token1">(</span><span class="token4">'index/index'</span><span class="token1">)</span><span class="token1">;</span>
<span class="token1">}</span>
<span class="token1">}</span>
```
```
## 擴展
當我們在寫業務邏輯時,需要自己定義一些事件標簽位來給其他插件實現功能擴展,那么我們可以參考下面來實現。
**1. hook方法**
系統有提供`hook`方法來觸發事件,方法說明:
```
<pre class="calibre16">```
<span class="token5">/**
* $event 事件名稱
* $params 傳入參數
* $once = true 表示返回一個結果,$once = false 表示返回全部結果
* $original = true 表示 返回TP trigger原始數據,false - 返回字符串,如果原樣返回數據是數組即會轉換成字符串
*/</span>
<span class="token6">hook</span><span class="token1">(</span>$event<span class="token1">,</span> $params<span class="token1">,</span> $once<span class="token1">,</span> $original<span class="token1">)</span>
```
```
**2. 觸發事件**
例如定義觸發`showTest`事件。
```
<pre class="calibre16">```
<span class="token5">// 控制器觸發,傳入數組</span>
<span class="token6">hook</span><span class="token1">(</span><span class="token4">'showTest'</span><span class="token1">,</span> <span class="token1">[</span><span class="token4">'a'</span><span class="token">=</span><span class="token">></span><span class="token4">'測試'</span><span class="token1">]</span><span class="token1">)</span><span class="token1">;</span>
<span class="token5">// 模板觸發,傳入數組</span>
<span class="token1">{</span><span class="token1">:</span><span class="token6">hook</span><span class="token1">(</span><span class="token4">"showTest"</span><span class="token1">,</span><span class="token1">[</span><span class="token4">'a'</span><span class="token">=</span><span class="token">></span><span class="token4">'測試'</span><span class="token1">]</span><span class="token1">)</span><span class="token1">}</span>
<span class="token5">// 接收返回值:輸出原始數據。第四個參數給true即可</span>
$arr <span class="token">=</span> <span class="token6">hook</span><span class="token1">(</span><span class="token4">"showTest"</span><span class="token1">,</span><span class="token1">[</span><span class="token4">'a'</span><span class="token">=</span><span class="token">></span><span class="token4">'測試'</span><span class="token1">]</span><span class="token1">,</span><span class="token3">true</span><span class="token1">,</span><span class="token3">true</span><span class="token1">)</span><span class="token1">;</span>
```
```
> 注意:當有多個插件定義showTest事件時,返回值是數組的,并不建議這樣來使用事件
上面定義了`showTest`觸發事件方法,那么在其他插件就可以定義`showTest`事件來實現擴展,如下
```
<pre class="calibre20">```
<span class="token"><</span><span class="token">?</span>php
declare <span class="token1">(</span>strict_types<span class="token">=</span><span class="token3">1</span><span class="token1">)</span><span class="token1">;</span>
namespace addons\demo<span class="token1">;</span>
use think\Addons<span class="token1">;</span>
class <span class="token6">Demo</span> extends <span class="token6">Addons</span>
<span class="token1">{</span>
public <span class="token2">function</span> <span class="token6">install</span><span class="token1">(</span><span class="token1">)</span>
<span class="token1">{</span>
<span class="token2">return</span> <span class="token3">true</span><span class="token1">;</span>
<span class="token1">}</span>
public <span class="token2">function</span> <span class="token6">uninstall</span><span class="token1">(</span><span class="token1">)</span>
<span class="token1">{</span>
<span class="token2">return</span> <span class="token3">true</span><span class="token1">;</span>
<span class="token1">}</span>
<span class="token5">// 對應showTest</span>
public <span class="token2">function</span> <span class="token6">showTestHook</span><span class="token1">(</span><span class="token1">)</span>
<span class="token1">{</span>
echo <span class="token4">"測試"</span><span class="token1">;</span>
<span class="token1">}</span>
<span class="token1">}</span>
```
```
- 簡介
- 下載與安裝配置
- 下載
- 虛擬主機安裝
- 百度云虛擬主機
- 創業云虛擬主機
- Linux下寶塔安裝
- 寶塔一鍵部署
- Windows下寶塔安裝
- phpEnv下安裝
- phpStudy下安裝
- 偽靜態(url重寫)
- 安裝系統
- 調試模式與env文件
- 重新安裝與安裝文件說明
- 后臺使用幫助
- 后臺入口文件
- 首頁面板
- 配置中心
- 站點配置
- SEO設置
- SEO設置-靜態生成
- 文檔屬性
- 站點模塊
- V2.2.2版本 -
- V2.2.3版本 +
- 模型管理
- 欄目管理
- 字段類型與組件
- 前言
- 前端組件
- 驗證規則
- text 單行文本
- textarea 多行文本
- radio 單選
- checkbox 復選
- select 下拉列表
- selects下拉列表(多)
- selectpage 動態下拉
- editor編輯器
- image圖片
- images圖片(多)
- number數字
- date日期
- datetime日期和時間
- downfile文件上傳
- downfiles文件上傳(多)
- array 數組(鍵值對)
- 內容管理
- 自定義URL
- 多語言
- 界面多語言
- 內容多語言
- 多語言URL地址
- 附件管理
- 應用中心
- 標簽語法
- 標簽使用必讀
- 列表標簽
- content 內容列表標簽
- contentpage 內容列表分頁
- wfpage 瀑布流分頁
- filter 篩選標簽
- order 排序標簽
- 內容標簽
- guestbook 留言(表單)標簽(廢棄)
- form 表單標簽
- pre 上一篇標簽
- next 下一篇標簽
- prenext 上一篇下一篇(高級)標簽
- fileinfo 獲取附件信息(文件下載)
- 內容分頁
- raw 格式化編輯器文本(即將廢棄)
- 全局標簽
- seo 標簽
- channel 欄目標簽
- arcone 獲取單條文檔
- breadcrumb 面包屑導航標簽
- adv 站點模塊標簽
- date 日期格式化標簽
- substr字符(標題)截取標簽
- volist 循環標簽
- language 獲取語言列表標簽
- query 查詢數據庫內容
- include 導入模板文件標簽
- 原生PHP與php標簽
- map生成位置地圖
- thumb 生成縮略圖
- addons 插件檢測
- 標簽管理
- taglist標簽(獲取標簽列表)
- tagarclist根據標簽獲取文章內容列表
- 導入標簽
- 模板開發
- 1. 創建模板
- 2. 模板目錄結構
- 3. 模板描述文件(重要) info.ini
- 4. 變量輸出格式
- 4. 模板變量
- 5. 獲取站點配置
- 6. 模板界面多語言
- 7. 模板靜態目錄及調用靜態文件
- 8. 模板定義插件事件
- 9. 模板搜索頁
- 10. 模板配置JSON
- 11. 導入演示數據
- 12. 卸載刪除演示數據
- 13. 模板文件打包
- 14. 整站源碼打包
- 插件開發
- 1. 創建插件
- 2. 目錄結構
- 3. 插件名稱類
- 4. 插件信息(info.ini)
- 5. 插件事件
- 6. 配置文件
- 7. install 安裝目錄
- 8. 創建菜單
- 9. 插件控制器
- 10. 插件視圖
- 10-1 插件主題化
- 11. 插件模型
- 12. 模型事件
- 13. 插件內置函數
- 13-1 插件函數庫
- 14. 插件多語言
- 15. 插件中間件
- 16. 插件路由
- 17. 插件驗證器
- 18. 標簽庫
- 19. 第三方類庫
- 20. 數據庫文件導入
- 插件打包
- 后臺前端使用幫助
- 二次開發幫助(更新中)
- 后臺前端開發幫助
- 路由(鏈接地址、訪問規則)
- URL訪問
- 路由定義
- URL生成
- 附錄
- 數據字典
- 助手函數庫