如何開發一個基本的 WordPress 外掛

在這節課中，我們將學習如何從頭開始開發一個簡單的 WordPress 外掛。這個過程將帶您從創建文件夾到編寫基本功能代碼，最終讓您的外掛在 WordPress 後台中可用。通過這個練習，您將掌握 WordPress 外掛開發的基本技能，並能夠為您的網站添加自定義功能。

步驟 1：創建外掛文件夾

首先，我們需要為外掛創建一個專用的文件夾。這個文件夾將用於存放所有與外掛相關的文件。

• 操作說明：
  1. 在您的 WordPress 安裝目錄中，導航到 wp-content/plugins/ 資料夾。
  2. 創建一個新的文件夾，命名為 my_simple_plugin。
• 範例：

  wp-content/plugins/my_simple_plugin/
  

步驟 2：創建主要的 PHP 檔案

在剛剛建立的文件夾中，創建一個主要的 PHP 檔案。這個文件將包含您的外掛代碼，並且是 WordPress 識別這個外掛的入口文件。

• 操作說明：
  1. 在 my_simple_plugin 文件夾中，創建一個新文件，命名為 my_simple_plugin.php。
  2. 使用文本編輯器（如 VSCode、Sublime Text）打開這個文件。
• 範例：

  wp-content/plugins/my_simple_plugin/my_simple_plugin.php
  

步驟 3：添加外掛的標頭資訊

每個 WordPress 外掛都需要在其主要 PHP 文件中包含一個特殊的註解區域，這個區域包含外掛的基本資訊，如名稱、作者、版本等。這些資訊將告訴 WordPress 這是個有效的外掛，並允許您在後台啟用或停用它。

• 操作說明：
  1. 在 my_simple_plugin.php 文件的最頂部，添加以下註解內容。
• 範例：

  /**
  * Plugin Name: my_simple_plugin
  * Plugin URI: https://www.wang-sy.com/
  * Description: 我是範例模組
  * Version: 1.0
  * Author: Wang.sy
  * Author URI: https://www.wang-sy.com/
  * License: GPL-2.0+
  * License URI: https://www.wang-sy.com/licenses/
  * Domain Path: /languages
  * Text Domain: my_simple_plugin
  */
  

  標頭資訊名稱解釋：

  • Plugin Name: 外掛的名稱。這是唯一必須的標頭，決定了外掛在 WordPress 管理後台中的顯示名稱。
  • Plugin URI: 外掛的官方網頁 URL，用於提供外掛的詳細資訊或支援。
  • Description: 外掛的簡短描述，將顯示在 WordPress 外掛頁面中，讓用戶了解這個外掛的用途。
  • Version: 外掛的版本號，用於追蹤外掛的更新和維護。
  • Author: 外掛作者的名稱，可以是個人或公司名稱。
  • Author URI: 作者的網站 URL，提供更多關於作者的資訊。
  • License: 外掛使用的許可證類型，建議使用 GPL-2.0+ 或其他開源許可證。
  • License URI: 許可證的詳細 URL，讓用戶了解外掛的法律條款。
  • Domain Path: 翻譯文件的存放路徑，用於多語言支持。
  • Text Domain: 外掛的翻譯識別符，用於區分外掛的翻譯與其他外掛或 WordPress 核心的翻譯。

步驟 4：添加外掛內容代碼

現在，我們可以開始編寫外掛的功能代碼。這個代碼將定義外掛實際執行的操作。在這個範例中，我們將在每篇文章的底部添加一段自定義文本。

• 操作說明：
  1. 在 my_simple_plugin.php 文件中，添加以下代碼，這段代碼將使用 WordPress 的 add_filter 函數來修改文章內容。
• 範例：

  function my_simple_plugin_add_content($content) {
      $content .= '<p>This is added by My Simple Plugin!</p>';
      return $content;
  }
  add_filter('the_content', 'my_simple_plugin_add_content');
  

  代碼解釋：

  • my_simple_plugin_add_content: 這個函數接受文章的內容作為參數，然後在內容的末尾添加一段自定義文本，最後返回修改後的內容。
  • add_filter(‘the_content’, ‘my_simple_plugin_add_content’): 這行代碼將 my_simple_plugin_add_content 函數掛載到 WordPress 的 the_content Hook 上，這意味著每當文章內容被顯示時，這段代碼都會被執行。

步驟 5：啟用外掛並測試功能

最後，我們需要在 WordPress 後台啟用這個外掛，並測試其功能。

• 操作說明：
  1. 登錄到您的 WordPress 管理後台。
  2. 導航到「插件」頁面，您應該可以看到 my_simple_plugin 列在外掛列表中。
  3. 點擊「啟用」來啟動這個外掛。
  4. 打開一篇文章，檢查文章底部是否顯示了 This is added by My Simple Plugin! 的文本。