萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

Typecho 插件開發教程(三):配置存儲與表單組件實戰

承接前兩節,本文詳細講解 Typecho 插件如何通過 Typecho_Widget_Helper_Form 體系實現配置頁面的自動生成、數據持久化與讀取,以「百度站長平台鏈接提交插件」為例演示完整流程。

一、完善啟用/禁用提示

public static function activate() {
    // 可在這裡創建表、寫入默認配置等初始化操作
    return '插件安裝成功,請進入設置填寫准入密鑰';
}

public static function deactivate() {
    // 可選:清理數據、移除定時任務等
    return '插件卸載成功';
}

返回字符串將在後台顯示為綠色/紅色提示條,提升用戶體驗。

二、配置表單構建(config() 方法)

public static function config(Typecho_Widget_Helper_Form $form) {
    // 文本輸入框:API 調用地址
    $api = new Typecho_Widget_Helper_Form_Element_Text(
        'api',                    // name:存儲鍵名
        null,                     // options:下拉選項(文本框為 null)
        null,                     // value:默認值
        _t('接口調用地址'),       // label:顯示標題
        '請登錄百度站長平台獲取'   // description:幫助文本
    );
    $form->addInput($api);

    // 更多表單類型示例:
    // 下拉選擇:Typecho_Widget_Helper_Form_Element_Select
    // 複選框:Typecho_Widget_Helper_Form_Element_Checkbox
    // 隱藏域:Typecho_Widget_Helper_Form_Element_Hidden
    // 密碼框:Typecho_Widget_Helper_Form_Element_Password
    // 單選組:Typecho_Widget_Helper_Form_Element_Radio
}

三、表單元素構造函數五大參數詳解

參數名稱說明
$name表單項名稱對應數據庫 options 表 name 字段,唯一標識
$options選項數組Select/Checkbox/Radio 使用,格式 ['value'=>'Label']
$value默認值未保存配置時顯示的初始值
$label顯示標題後台配置頁左側標籤文本
$description描述/幫助標籤下方灰色小字提示

四、配置的讀取與使用

插件啟用後,配置自動持久化到 typecho_options 表(name=plugin:插件名:api)。在其他掛點(如 action_contents_post_edit)中讀取:

$options = Typecho_Widget::widget('Widget_Options');
$apiUrl = $options->plugin('BaiduSubmit')->api; // 插件名對應目錄名
if ($apiUrl) {
    // 調用百度推送 API
}

五、常見坑點與避雷指南

  • 修改 $name 需重啟插件:配置已持久化,改名後舊鍵值仍留在數據庫,新鍵值為空。需禁用再啟用插件重置。
  • Typecho_Widget_Helper_Form_Element_Fake:僅作佔位/分組標題,不產生輸入控件,不保存數據。
  • 高級驗證:繼承 Typecho_Widget_Helper_Form_Element 重寫 validate() 實現自定義校驗(如 URL 格式、API 連通性測試)。
  • 多實例配置:若插件需支援多站點不同配置,需自行實現存儲邏輯(如 plugin:插件名:site_id:key)。

六、最佳實踐清單

  1. 所有用戶可見文本包裹 _t() 支援多語言。
  2. 敏感配置(Token、密鑰)使用 Element_Password 並啟用 HTTPS 後台。
  3. 提供「測試連接」按鈕(需自定義 JS/AJAX)提升易用性。
  4. 配置變更記錄操作日誌,便於審計追溯。

掌握 Form 組件體系,即可快速構建專業級插件配置界面,專注業務邏輯而非 HTML 拼接。

copyright © 萬盛學電腦網 all rights reserved