如何開發 WooCommerce 日誌紀錄外掛

每次遇到想要跟我學習 WordPress 外掛開發的朋友來信，總是只能丟些教學文件給他們，畢竟我也不知道他們想做什麼東西，只能提供官方文件給他們參考，雖然這幾年來也寫了不少，但好像都缺少比較完整的開發教學。

想到之前為了教老婆開發而整理出的一套課程大綱，似乎有這個契機可以把它發展下去，但如果只是講理論而沒應用好像無法立即派上用場，於是想到可以整合之前寫過的小工具作為內容，就可以設計出真的能做出東西的教材。

剛好上週為了除錯的事情順手寫了一支日誌外掛，整合理論與實務的教學計畫如下：

前言

日誌紀錄是開發者與網站維護人員最重要的好夥伴，除了可以在開發當下輸出執行結果來確認程式的邏輯外，當網站發生錯誤時也能從紀錄中去檢查問題所在原因。查看 WooCommerce 的日誌紀錄步驟為：進入後台側選單 > 點選 WooCommerce > 狀態 > 日誌紀錄 > 選擇日誌檔 > 查看，就會顯示相關的資訊。

一、WooCommerce 內建日誌紀錄的問題

WooComerce 內建的日誌有以下幾個痛點：

選單的目錄層級過多，日誌檔太多時東西不好找
要更新日誌內容必須點選查看，直接重新整理頁面會回到預設的日誌檔
日誌紀錄的時間是由舊到新，如果單一檔案內容太多必須要捲很長的頁面才能看到最新一筆紀錄
日誌紀錄的時間非本地時間，查看時腦海中必須自行轉換
紀錄種類標示不清，難以一眼區分該紀錄是重大錯誤還是單純的訊息通知

二、WooCommerce 日誌紀錄外掛開發目標

為了解決以上問題，本篇教學將會介紹如何開發一支 WooCommerce 專用的外掛，本外掛預期會達到的效果如下：

可以在後台 WooCommerce 選單下點擊日誌紀錄選單後直接進行查看，節省多次點擊的步驟
可以設定要查看的日誌檔名稱，設定完成後僅會顯示該日誌檔的紀錄，以減少翻查時間
日誌使用表格條列式呈現，並以日誌檔名稱、日期、本地時間做分類，排序方式由新到舊
日誌表格突顯紀錄類型，讓使用者可以很容易的區分需要注意的紀錄
開發完成後導入 Github Action 打包 zip 檔供使用者第一次下載安裝
開發完成後導入自主託管更新機制，讓使用者不需另行下載安裝 zip 檔便能在後台自動更新

三、適合對象

正在學習 PHP 的新手
想要了解 WordPress 開發基礎知識的 PHP 工程師
想要開發 WordPress 外掛的創業者
想設計 WordPress 課程的老師
想撰寫 WordPress 書籍的作者

四、課程大綱

1. 認識 WordPress 外掛開發基礎知識

介紹 WordPress 運作的組成：Nginx、MySQL、PHP
介紹開發環境的專有名詞：本機、測試主機、正式主機
使用 Local WP，介面操作教學
介紹 WordPress 是由哪些檔案所構成
介紹外掛的基礎組成：主程式、標頭宣告
介紹 PHP 變數、函式、輸出
介紹 WordPress 勾點、常用 API、資料表
介紹 FTP、打包上傳
介紹 Git、Github、開發流程、分支
安裝 WordPress Coding standard、自動格式化
介紹外掛檔案拆分邏輯，使用 Autoload、Packagist
PHP 物件導向基礎知識

2. WooCommerce 日誌紀錄外掛後端開發流程

讀取 WooCommerce 日誌紀錄檔
解析日誌內容，組合日誌紀錄陣列
註冊 REST API Endpoint 提供第三方讀取紀錄

3. WooCommerce 日誌紀錄外掛前端開發流程

註冊後台選單
使用 Master CSS 設計版面
使用 PHP 輸出頁面內容

4.外掛發布與更新維護

整合 Github Actions 發行安裝檔
版本控管分支策略
整合自主託管外掛更新機制

不知道這樣的教學內容對你會有所幫助嗎？有的話回信跟我說，讓我知道可以繼續發展下去～

WordPress 開發日常