WordPress 插件開發(fā)入門指南：使用 WordPress 插件樣板

WordPress 插件開發(fā)的學(xué)習(xí)曲線較低，并沒有構(gòu)建插件的唯一方法。插件可以像 Hello Dolly 一樣簡單，只是一個單文件；也可以根據(jù)各種需求和功能構(gòu)建得非常復(fù)雜。WordPress 插件樣板旨在提供一個標(biāo)準(zhǔn)化、高質(zhì)量的基礎(chǔ)，幫助您構(gòu)建下一個優(yōu)秀的插件。在本系列的第一部分中，我們將深入探討該樣板，包括文件和文件夾的結(jié)構(gòu)以及樣板的代碼組織。

關(guān)鍵要點

• WordPress 插件樣板為構(gòu)建 WordPress 插件提供了標(biāo)準(zhǔn)化、高質(zhì)量的基礎(chǔ)，學(xué)習(xí)曲線低，并且可以靈活地用于簡單或復(fù)雜的插件結(jié)構(gòu)。
• 樣板的 3.0.0 版本在代碼組織和插件內(nèi)部關(guān)注點的分離方面帶來了重大改進，可以通過克隆 git 倉庫或從 GitHub 倉庫下載 zip 文件輕松獲取。
• 樣板遵循推薦的 WordPress 編碼和文檔標(biāo)準(zhǔn)，提供有用的入門指南和工具推薦，并包含五個用于各種功能的默認(rèn)類，使其成為插件開發(fā)人員的絕佳起點。

背景

WordPress 插件樣板最初是由 Tom McFarlin 發(fā)起的，旨在提供一種標(biāo)準(zhǔn)化的面向?qū)ο蠓椒▉順?gòu)建 WordPress 插件。由于樣板構(gòu)建在插件 API 之上，并遵循 WordPress 推薦的編碼標(biāo)準(zhǔn)和文檔標(biāo)準(zhǔn)，因此您可以確信自己處于安全可靠的環(huán)境中。樣板最近更新到 3.0.0 版本，在代碼組織以及插件內(nèi)部關(guān)注點的進一步分離方面帶來了重大改進。如果您已經(jīng)熟悉使用舊版樣板 (v2.6.2) 開發(fā)插件，則可能需要一些時間來重新學(xué)習(xí)最新版本中的新增內(nèi)容，其中包括新的文件夾結(jié)構(gòu)。此樣板不再由 Tom McFarlin 本人維護（在撰寫本文時），他已經(jīng)將接力棒傳給了 Devin Vinson。開發(fā)仍在按計劃繼續(xù)進行，因此如果您有任何問題，請隨時在 GitHub 倉庫中報告。我們也歡迎您的貢獻(xiàn)。

獲取樣板副本

獲取 WordPress 插件樣板副本最簡單的方法是克隆 git 倉庫本身。

<code>git clone https://github.com/DevinVinson/WordPress-Plugin-Boilerplate.git</code>

或者您可以始終從 GitHub 倉庫下載 zip 文件。由于 3.0.0 版本已發(fā)布，因此不能簡單地將插件直接復(fù)制到您的 wp-content/plugins 目錄中。這是因為插件的實際源代碼不包含在根目錄中，而實際上位于名為 trunk 的子目錄中?，F(xiàn)在不用擔(dān)心這個問題，我們稍后將在本文中討論新的文件夾結(jié)構(gòu)。README.md 文件中詳細(xì)介紹了如何正確安裝樣板的完整說明。簡而言之，您可以：

• 將 trunk 目錄復(fù)制到 wp-content/plugins 文件夾
• 復(fù)制整個樣板目錄，然后為 trunk 子目錄創(chuàng)建到 wp-content/plugins// 的符號鏈接。創(chuàng)建符號鏈接將取決于您使用的操作系統(tǒng)。

完成此操作后，您現(xiàn)在應(yīng)該在管理面板的插件列表中找到一個名為 WordPress Plugin Boilerplate 的插件，假設(shè)您沒有對樣板本身進行任何修改。只需激活插件即可開始使用！

使用在線生成器自定義插件

激活后，您將擁有一個基本上不執(zhí)行任何操作的“普通”插件——至少目前是這樣。您還需要對整個樣板的代碼庫運行搜索和替換操作，此過程可能非常繁瑣且耗時。幸運的是，Enrique Chavez 創(chuàng)建了一個非官方生成器，可以自動化此過程。只需訪問 http://ipnx.cn/link/6340831392e9cd8af9598274f4b3c5c0 并填寫頁面底部的表單即可生成個性化的 WordPress 插件樣板副本。

文件夾結(jié)構(gòu)

讓我們更仔細(xì)地看看與舊版本相比，WordPress 插件樣板 3.0.0 版本是如何組織的。如前所述，實際的插件代碼包含在一個名為 trunk 的子目錄中，而不是根目錄中。這是為了遵循 WordPress 官方插件存儲庫中使用的標(biāo)準(zhǔn)，該存儲庫包含三個主要目錄：assets、branches 和 trunk。樣板已經(jīng)提供了其中的兩個：assets 和 trunk。以下是樣板中包含的完整目錄和文件（在撰寫本文時）：

<code>git clone https://github.com/DevinVinson/WordPress-Plugin-Boilerplate.git</code>

以下是每個文件和文件夾的功能簡要說明：

• .gitignore：為大多數(shù)不應(yīng)存在于 git 存儲庫中的內(nèi)容提供合理的默認(rèn) .gitignore。
• CHANGELOG.md：樣板更改的標(biāo)準(zhǔn)變更日志，包含更改日期。
• README.md：一個有用的入門指南，其中列出了安裝說明，以及其他一些部分，例如工具推薦和鳴謝。
• assets：此目錄包含在您決定將插件發(fā)布到 WordPress 插件存儲庫時需要提供的推薦資源。此目錄中包含的所有圖像均為發(fā)布的推薦分辨率。
• trunk：這是您將要開發(fā)的實際插件。有一些文件夾將代碼庫分為管理和面向公眾的功能。我們將詳細(xì)介紹每個子目錄的含義。
  • admin：admin 目錄中包含三個目錄，即 css、js 和 partials。顧名思義，所有面向管理的功能都應(yīng)放在此處。默認(rèn)情況下，plugin-name-admin.js 和 plugin-name-admin.css 將添加到您的 wp-admin 中。class-plugin-name-admin.php 將提供通用功能，您可以在其中定義特定于管理的掛鉤。
  • public：此目錄與 admin 目錄提供的功能非常相似，唯一的區(qū)別是 public 目錄應(yīng)用于存儲所有面向公眾的功能代碼庫。
  • languages：一個起始 .pot 文件，您可以在其中為插件提供翻譯功能。
  • includes：這可能是幾乎所有神奇之處發(fā)生的地方。默認(rèn)情況下包含五個起始類，我們將在下一節(jié)中討論。
  • LICENSE.txt：默認(rèn)情況下包含 GPL v2 許可證的副本。
  • README.txt：插件 README 文件的起點。此文件涵蓋了您可以進一步填寫以在 WordPress 插件存儲庫中提供良好的插件頁面的所有部分。
  • plugin-name.php：插件的入口點。在此處，包含一個通用的插件文件頭，您可以根據(jù)自己的喜好進行修改。如果您需要在插件激活和/或停用時包含某種功能，則還會在此文件中注冊 register_activation_hook 和 register_deactivation_hook。

包含的類

如前所述，trunk/includes 目錄中提供了五個默認(rèn)類。讓我們看看每個類都做什么：

• class-plugin-name-activator.php：此類在插件激活期間實例化。它只有一個靜態(tài)方法 activate()，該方法注冊到 register_activation_hook。每當(dāng)您需要在插件激活時執(zhí)行某些操作（例如創(chuàng)建自定義表或保存默認(rèn)選項）時，請使用此類。
• class-plugin-name-deactivator.php：class-plugin-name-deactivator.php 的對應(yīng)類。它也只有一個靜態(tài)方法 deactivate()，可用于在插件停用期間運行任何功能。
• class-plugin-name-i18n.php：插件 i18n 功能的起點。它有一個屬性 $domain，用于存儲插件文本域?？梢允褂霉卜椒?set_domain() 設(shè)置此屬性。最后，每當(dāng)加載插件時，都會調(diào)用此類中的 load_plugin_textdomain() 方法。
• class-plugin-name-loader.php：樣板中可能最重要的類。它包含兩個屬性 $actions 和 $filters，所有在插件中注冊的掛鉤都將存儲在此處。它提供兩個簡單的包裝函數(shù) add_action() 和 add_filter()，用于將操作或過濾器添加到 $actions 和 $filters 屬性中。這不要與 WordPress 默認(rèn)的 add_action() 和 add_filter() 函數(shù)混淆，因為此類實際上并沒有直接注冊它們。所有掛鉤都只會在另一個名為 run() 的方法期間注冊。
• class-plugin-name.php：將所有部分粘合在一起的類。它包含有關(guān)插件的重要信息，例如插件名稱和版本。此外，它將使用 load_dependencies() 方法加載依賴項，這將包含以上四個類，并且將使用 set_locale() 方法設(shè)置插件文本域。之前注冊的所有管理和公共掛鉤也可以在此處定義。此類還提供簡單的 get 方法，例如 get_plugin_name() 用于返回插件名稱，get_version() 用于返回當(dāng)前插件版本，以及 get_loader() 用于保留 class-plugin-name-loader.php 的實例。

結(jié)論

簡而言之，WordPress 插件樣板為插件開發(fā)人員提供了一個絕佳的起點。它遵循推薦的 WordPress 編碼標(biāo)準(zhǔn)以及 WordPress 文檔標(biāo)準(zhǔn)，因此您知道自己從一開始就走在了正確的道路上。此外，由于樣板已經(jīng)提供了您所需的大部分內(nèi)容，因此發(fā)布到 WordPress 插件存儲庫變得更加容易。一旦我們熟悉了代碼組織和文件夾結(jié)構(gòu)，我們將在本系列的第二部分中探討如何使用 WordPress 插件樣板開發(fā)實際插件。

以上是使用WordPress插件樣板加快開發(fā)的詳細(xì)內(nèi)容。更多信息請關(guān)注PHP中文網(wǎng)其他相關(guān)文章！