如何将插件提交到 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 存储库提交插件？ 您是否正在考虑使用免费增值业务模式？ 在下面的评论中发出声音！