如何將插件提交到 WordPress.org 存儲庫

已發表: 2021-06-02

在 WordPress.org 存儲庫上託管插件是啟動成功的免費增值業務的最流行（和有效）的方式之一。如果這是您第一次向存儲庫提交插件，某些步驟可能不清楚或令人困惑，這就是為什麼我概述了指導您的過程。如果您將來需要引用它，我還建議將此頁面添加為書籤。

準備提交

首先，您需要獲得插件審查團隊的批准才能在存儲庫中託管您的產品。為此，您需要在 WordPress.org 上擁有一個帳戶。沒有？不用擔心——你可以在這裡註冊。

創建插件的 Readme.txt 文件

接下來，您需要創建一個降價格式的 readme.txt 文件，該文件將用於您在 WordPress.org 上的插件列表頁面。它需要包含以下信息：

插件名稱
貢獻者（您的 WordPress.org 用戶 ID）
插件標籤
至少需要（WordPress 版本）
測試高達（WordPress版本）
穩定標籤（插件版）
許可證（GPLv2 或更高版本）
許可證 URI：www.gnu.org/licenses/gpl-2.0.html
描述（插件的完整描述）
常見問題
截圖
變更日誌

作為參考，這裡是一個標準的 readme.txt 文件模板。

為確保您正確格式化和構建了插件的 readme.txt 文件，請使用 WordPress 自述文件驗證器。

仔細選擇您的插件名稱

在初次提交之前花時間選擇“正確”的插件名稱很重要，因為它會影響插件的列表 URL，這會影響您的 WordPress.org 列表的 SEO，並最終影響插件的自然曝光和增長。

以下是插件提交頁面中涵蓋名稱影響的相關部分：

您的插件的 URL 將根據您的主插件文件（帶有插件標頭的文件）中的Plugin Name的值填充。 如果您將您的設置為Plugin Name: Boaty McBoatface ，那麼您的 URL 將是https://wordpress.org/plugins/boaty-mcboatface ，例如您的 slug 將是boaty-mcboatface 。 如果有一個以您的名字命名的現有插件，那麼您將是boaty-mcboatface-2 ，依此類推。 它的行為與 WordPress 帖子名稱完全相同。

因此，當您選擇初始名稱時，請考慮針對 SEO 而不是品牌進行優化。問問自己你想定位哪些關鍵字並從中推斷出名稱。您可以在此處找到一些命名提示。

請記住，您始終可以在初次提交後更改插件的名稱——因此，即使您選擇了一個您不喜歡的名稱，您也可以在以後更改它（並且可以多次更改）。您無法更改的是插件的 slug，因此，初始命名很重要。

另請注意，slug 是根據主插件文件中的插件名稱創建的，它可能與 readme.txt 文件中的插件名稱值不同。

提交你的插件

一旦你確定了一個好的 SEO 名稱——並且你的插件和 readme.txt 文件已經準備好——前往添加你的插件頁面並提交它以供審查。

審核過程是手動的，可能需要 1 到 10 天，具體取決於審核隊列和插件的複雜性。如果發現任何問題，您將收到一封電子郵件，詳細說明上述問題以及如何解決這些問題。

一旦問題得到解決（如果有的話），您將通過電子郵件收到批准。您的插件此時尚未公開，但您仍然可以通過命令行或 SVN 客戶端上傳、編輯和刪除文件。

提示：為確保您不會錯過重要的電子郵件，我建議將[email protected]列入白名單，這是 WordPress.org 插件審查團隊用於與插件開發人員溝通的電子郵件地址。

上傳插件

現在您已被授予訪問 SVN 存儲庫的權限，下一步是將您的插件上傳到 WordPress.org 存儲庫。在此之前，我們建議您熟悉使用 Subversion 和 WordPress 的基礎知識。

我將使用本教程的命令行界面。如果您不喜歡它並且更喜歡使用可視化客戶端，請考慮適用於 Windows 的 TortoiseSVN 和適用於 Mac 的 Cornerstone。

在將插件文件上傳到 SVN 存儲庫之前，您需要創建一個本地文件夾來存儲文件和資產。此命令將創建一個本地目錄：

$ mkdir my-awesome-plugin

為了保持一致性，最好根據您在初始提交後分配的slug來命名文件夾和插件的主 PHP 文件。在此示例中，我假設您的插件名稱是My Awesome Plugin並且您批准的 slug 是my-awesome-plugin 。

現在，查看和下載預構建的存儲庫：

$ svn checkout https://plugins.svn.wordpress.org/my-awesome-plugin local/path/to/my-awesome-plugin

這將給出以下回報：

A my-awesome-plugin/branches
A my-awesome-plugin/tags
A my-awesome-plugin/trunk
Checked out revision #####

這裡， A表示目錄已從中央存儲庫添加到本地文件夾。接下來，您需要將插件的文件和文件夾複製到trunk文件夾中：

$ rsync -r local/path/to/wordpress/wp-includes/plugins/my-awesome-plugin/* local/path/to/my-awesome-plugin/trunk

並將它們添加到存儲庫。

$ svn add trunk/*

作為回報，您將被要求進行身份驗證。登錄後，您將收到如下所示的響應：

A trunk/my-awesome-plugin.php
A trunk/readme.txt

重要提示： WordPress.org 將trunk文件夾視為插件的頂級文件夾。因此，不要照原樣複製整個插件文件夾， trunk應該只包含插件的內容。

避免這種情況： trunk/my-awesome-plugin/my-awesome-plugin.php

添加所有文件後，將更改提交回中央存儲庫：

$ svn commit -m 'My first plugin version'

這將返回以下響應：

Adding trunk/my-awesome-plugin.php
Adding trunk/readme.txt
Transmitting file data.
Committed revision 9999999.

要上傳插件圖標、橫幅和屏幕截圖，您可以在 SVN 本地存儲庫中創建一個新的資產文件夾：

$ mkdir local/path/to/my-awesome-plugin/assets

您可以在此處了解插件資產的工作原理。

準備好資產後，將插件資產添加到 SVN 存儲庫：

$ svn add assets/*

再次提交更改：

$ svn commit -m 'Assets upload'

而已！您的插件現在可供下載，您可以開始推廣它。

發布新版本

對於插件的下一個更新版本，步驟會略有不同。在發布新版本之前，請更新trunk/readme.txt file中的Stable Tag字段和插件標頭註釋中的版本號。準備好插件文件後，將它們複製到 /tags 的子文件夾並將子文件夾的名稱設置為新版本，例如1.0.1 。

$ svn copy trunk tags/1.0.1

  A tags/1.0.1

提交更改。

$ svn commit -m 'Version 1.0.1 release'

  Adding tags/1.0.1
  Adding tags/1.0.1/my-awesome-plugin.php
  Adding tags/1.0.1/readme.txt
  Committed revision 999999.

就這樣，你的插件的新版本就準備好了！

發布管理提示

從發布新版本到在 WordPress.org 插件列表頁面上可供下載時，您可能會注意到一些延遲。給它幾個小時，如果您仍然看不到它，您可以通過電子郵件發送[電子郵件保護] ，因為系統不時會出現問題。
根據經驗，為減少同步問題，建議您的trunk文件夾中的插件版本與tags文件夾中最新版本中的插件版本相同。

下一步是什麼？

從本質上講，免費插件的開發人員熱衷於貢獻對世界有用的東西。最重要的是，我們希望我們的產品能夠解決人們可能遇到的特定問題。但是，無論您的插件多麼出色，如果人們找不到它，它也無濟於事。

提高免費插件可見性的一個很好的下一步是優化 SEO 的 readme.txt 文件，這是我們在這裡探索的內容。

如果您想從插件中賺錢，僅僅讓您的產品免費在線是不夠的——您希望人們發現它、使用它、喜歡它，並（希望）升級到您的付費版本！如今，WordPress 開發人員身兼數職，從產品製造商到企業主再到營銷人員，為了讓合適的人看到您的插件，您需要開發和完善您的營銷技能。

這是我們在 WordPress 產品製造商營銷手冊中深入探討的主題。我還強烈建議您查看以下關於銷售 WordPress 插件和主題的備忘單——它是創建成功 WordPress 業務（從構思到啟動再到增長）的簡明、可操作的路線圖。

獲取我們的免費副本

銷售主題和插件的備忘單

增長路線圖，其中包含 WordPress 產品開發的每個里程碑的簡明、可操作的提示。

感謝訂閱！

- 我們剛剛將您的“銷售主題和插件備忘單”副本發送至.

您的電子郵件中有錯字嗎？單擊此處編輯電子郵件地址並再次發送。

您是否打算向 WordPress.org 存儲庫提交插件？ 您是否正在考慮使用免費增值業務模式？ 在下面的評論中發出聲音！