您编写了下一个 Hello Dolly 插件并希望全世界都能使用它。您应该怎么做呢?

1. 测试一次,再测试一次

希望您的插件能在许多不同的情况和托管环境中被大量用户使用。您应该确保已对插件进行了充分测试,以保证其在任何情况下都能正常工作,且不会让用户感到沮丧。

2. 选择一个好名字

插件名称应体现您及其作品的独特性。在选择名称时,请确保不侵犯商标或踩到他人的产品名称。如果您不是为 FaceRange(一家虚构公司)工作,就不应该将您的插件命名为“FaceRange 的跳舞松鼠”,而更好的名称应该是“为 FaceRange 设计的跳舞松鼠”之类的。想出一个好名字可能很难,所以请花点时间。提交后无法更改插件 URL,但显示名称可以更改无数次。

显示名称是根据主插件文件中的头部信息生成的,因此请注意措辞。

3. 编写优秀的文档

README.txt 文件是开始的最佳选择,因为它是所有插件的标准参考点。您应该确保包含以下内容:

  • 简洁描述您的插件实际做什么。如果功能很多,可能最好拆分为两个插件。
  • 安装说明,特别是如果有特殊配置需要完成。如果用户需要注册到您的服务,请确保提供链接。
  • 获取支持的途径说明,以及您支持和不支持的内容。

4. 提交您的插件

要提交插件,需要完成三个步骤:

  1. 在 WordPress.org 注册,使用有效的、定期检查的电子邮件地址。如果您代表公司提交插件,请使用官方公司邮箱进行验证。
  2. 在邮件客户端中将 plugins@wordpress.org 加入白名单,以确保收到邮件通信。
  3. 提交您的插件,附带简要说明其功能的概述以及完整的、可直接使用的插件 zip 文件。该 zip 文件必须是插件的完整版本,就像您手动通过插件安装程序上传时使用的版本一样。

一旦插件进入审核队列,我们将在 14 个工作日内审查代码是否存在任何问题。大多数问题可以通过遵循指南来避免。如果我们发现问题,将联系开发者并寻求解决方案。一旦批准,您将收到一封电子邮件,说明如何访问 Subversion Repository(版本控制仓库),您可以在其中存储您的插件。

通过 SVN 在该仓库中上传您的插件(以及说明文件)后,它将在 插件目录 中出现。

5. 发布第一个版本

WordPress.org 插件目录是潜在用户下载和安装您插件的最简单方式。WordPress 与插件目录的集成意味着用户可以通过几次点击更新您的插件。

当您准备好发布第一个版本时,请注册。审核流程完成后,您将获得用于代码的 Subversion Repository。我们有关于 在 WordPress.org 上使用 SVN 的文档,如果您使用 GIT,这可能与您熟悉的流程略有不同。

6. 拥抱开源

开源是我们这个时代最强大的理念之一,因为它促进了跨界的协作。通过鼓励贡献,您允许他人像您一样热爱您的代码。有多种方式可以将您的代码开源:

  • Github 使其他人参与您的项目变得简单。其他开发者和用户可以轻松提交 bug 修复或报告、功能请求或全新的贡献。Github 拥有 优秀的文档门户,甚至如果您从未使用过 Git,还有一个 交互式演示。
  • WordPress.org 插件目录提供并要求您使用 Subversion 仓库。

7. 倾听您的用户

您经常会发现,您的用户会对您的代码进行比您想象的更多的测试。这可以是非常宝贵的反馈。

通过 WordPress.org 发布您的代码意味着您的插件自动拥有一个支持论坛。请使用它!您可以订阅以通过电子邮件接收新帖子,并及时回复您的用户。他们只是想像您一样热爱您的插件。

Jetpack 有一篇关于 撰写优秀的 bug 报告 的文章,您可以参考。

8. 定期发布新版本

最好的插件是那些随着时间的推移不断迭代、逐步进行小改进的插件。不要因等待太久更新而使您的辛勤工作过时。请记住,频繁的升级可能导致“更新疲劳”,用户将停止升级。在太少更新和太多更新之间保持平衡非常重要。

9. 清洗并重复

就像生活中的其他方面一样,最好的成果来自耐心和努力工作。