在 WordPress 插件啟動時建立資料表

在 WordPress 插件開發中，register_activation_hook 是一個非常有用的工具，它允許開發者在插件啟動時執行一段特定的程式碼。這通常用於初始化插件的設置、建立資料庫表格、添加 WordPress 任務計劃或進行其他初始化操作。通過這個過程，您可以確保插件在第一次啟動時已經做好了必要的準備工作。

register_activation_hook 的基本概念

register_activation_hook 函數允許您在插件啟用時執行自訂的操作。這在插件開發中非常重要，因為它確保了插件在首次啟用時能夠正確設置和初始化。例如，您可以使用這個鉤子來建立資料庫表格，確保插件在使用過程中有合適的數據存儲。

使用 register_activation_hook 建立資料表

我們將通過以下步驟來實現當插件啟用時自動建立資料庫表格。這個資料表將用於存儲物聯網（IoT）設備的相關信息。

• 範例代碼：

  // 將插件的啟用鉤子綁定到自訂的初始化函數
  register_activation_hook(__FILE__, 'System_DBinstall');
  
  // 自訂函數：在插件啟動時建立資料表
  function System_DBinstall()
  {
      // 載入 WordPress 的升級功能
      require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
      global $wpdb;
  
      // 設定資料表的字元集和排序方式
      $charset_collate = $wpdb->get_charset_collate();
  
      // 定義資料表名稱
      $table_name = $wpdb->prefix . 'iot_device'; // 加上 prefix 以防止與其他表衝突
  
      // 建立資料表的 SQL 語句
      $sql = "CREATE TABLE $table_name (
          id mediumint(9) NOT NULL AUTO_INCREMENT,
          device_name CHAR(20) NOT NULL,
          device_state mediumint(2) NOT NULL,
          UNIQUE KEY id (id)
      ) $charset_collate;";
  
      // 使用 dbDelta 函數來建立或更新資料表
      dbDelta($sql);
  }
  

  代碼解釋：

  • register_activation_hook(__FILE__, 'System_DBinstall')：這行代碼將插件啟動時的鉤子綁定到 System_DBinstall 函數。當插件啟動時，這個函數將被執行。
  • require_once(ABSPATH . 'wp-admin/includes/upgrade.php')：這行代碼載入 WordPress 的升級工具，提供 dbDelta 函數來建立或更新資料表。
  • global $wpdb;：這行代碼獲取 WordPress 的資料庫物件，允許我們使用它來執行資料庫操作。
  • $charset_collate = $wpdb->get_charset_collate();：這行代碼設置資料表的字元集和排序方式，確保資料表與 WordPress 的設置一致。
  • $table_name = $wpdb->prefix . 'iot_device';：這行代碼定義資料表的名稱，並加上 WordPress 的表前綴（prefix），以防止與其他插件或系統表的名稱衝突。
  • dbDelta($sql);：這行代碼使用 dbDelta 函數來執行 SQL 語句，建立或更新資料表。如果資料表已存在且結構需要修改，dbDelta 會自動處理這些變化。

測試插件啟用時的資料表建立

完成代碼後，您可以啟用插件並檢查資料庫是否成功建立了新的資料表。

• 測試步驟：
  1. 將插件代碼保存到 wp-content/plugins/ 目錄下的一個文件中，確保文件名與插件名稱一致。
  2. 登錄 WordPress 後台，導航到 “插件” 頁面，找到剛剛上傳的插件並啟用它。
  3. 使用資料庫管理工具（如 phpMyAdmin）檢查資料庫，確認是否建立了名為 wp_iot_device 的新資料表（wp_ 為預設表前綴）。
  4. 在資料表中檢查欄位名稱和結構是否與預期一致。