WordPress.org 插件目录

WordPress.org 插件目录

WordPress.org 为任何希望在我们的目录中开发插件的人提供免费托管。

此处托管的所有插件都可以访问:

提示:请务必查看 开发者常见问题解答

如果您需要在 WordPress.org 上托管的帮助,您可以通过 Slack in 联系插件团队#pluginreview

要求

简要概述:

警报:所有插件和开发人员都必须遵守我们的详细插件指南

如何 …

如果您刚刚开始,了解如何提交插件、使用 SVN 等会有所帮助。

 

详细的插件指南

最后更新时间:2022 年 12 月 21 日

笔记:添加仅阻止插件?请阅读区块特定指南

插件目录

WordPress 插件目录的目标是为所有 WordPress 用户(从非技术人员到开发人员)提供一个安全的地方,以下载与 WordPress 项目目标一致的插件。

为此,我们希望确保开发人员为该目录提交插件的过程简单透明。作为我们不断努力使插件目录包含过程更加透明的一部分,我们创建了一个开发人员指南列表。我们努力为所有开发者创造一个公平的竞争环境。

如果您有改进指南的建议或对此有疑问,请发送电子邮件plugins@wordpress.org告知我们。

开发商期望

开发人员、所有具有提交访问权限的用户以及所有正式支持插件的用户都应遵守以下准则:

违规可能会导致插件或插件数据(对于先前批准的插件)从目录中删除,直到问题得到解决。根据违规的性质和同行评审的结果,插件数据(例如用户评论和代码)可能无法恢复。重复违规可能会导致作者的所有插件被删除,并且开发人员被禁止在 WordPress.org 上托管插件。

插件开发人员有责任确保他们在 WordPress.org 上的联系信息是最新且准确的,以便他们收到来自插件团队的所有通知。不允许自动回复和路由到支持系统的电子邮件,因为它们历来会阻止人们及时处理电子邮件。

目录中的所有代码都应尽可能安全。安全性是插件开发人员的最终责任,插件目录会尽我们最大的努力强制执行这一点。如果发现插件存在安全问题,它将被关闭,直到问题得到解决。在极端情况下,WordPress 安全团队可能会更新该插件并进行传播,以确保公众的安全。

虽然我们试图尽可能多地解释指南的相关解释,但期望明确涵盖每种情况是不合理的。如果您不确定插件是否可能违反准则,请联系plugins@wordpress.org并询问。

指南

1.插件必须兼容GNU通用公共许可证

尽管任何与 GPL 兼容的许可证都是可以接受的,但强烈建议使用与 WordPress 相同的许可证——“GPLv2 或更高版本”。所有代码、数据和图像(存储在 WordPress.org 上托管的插件目录中的任何内容)都必须符合 GPL 或 GPL 兼容许可证。包含的第三方库、代码、图像或其他内容必须兼容。有关兼容许可证的具体列表,请阅读gnu.org 上的GPL 兼容许可证列表

2. 开发者对其插件的内容和操作负责。

插件开发人员有责任确保其插件中的所有文件都符合准则。禁止故意编写代码来规避准则,或恢复他们被要求删除的代码(请参阅#9 非法/不诚实行为)。

开发人员在上传到 SVN 之前应确认所有包含文件(从原始源代码到图像和库)的许可。此外,他们必须遵守其插件使用的所有第三方服务和 API 的使用条款。如果无法验证库的许可或 API 的条款,则无法使用它们。

3. 插件的稳定版本必须可从 WordPress 插件目录页面获取。

WordPress.org 分发的唯一版本的插件是该目录中的版本。尽管人们可能在其他地方开发代码,但用户将从目录下载,而不是从开发环境下载。

通过替代方法分发代码,同时不使此处托管的代码保持最新,可能会导致插件被删除。

4. 代码必须(大部分)是人类可读的。

目录中不允许使用类似于 的p,a,c,k,e,r混淆功能、uglify 的 mangle 或不清楚的命名约定(例如 )的技术或系统$z12sdf813d来隐藏代码。使代码变得非人类可读会迫使未来的开发人员面临不必要的障碍,并且成为隐藏的恶意代码的常见载体。

我们要求开发人员通过以下方式之一提供对其源代码和任何构建工具的公共、维护的访问权限:

我们强烈建议您记录如何使用任何开发工具。

5. 不允许使用试用软件。

插件可能不包含受限制或锁定的功能,只能通过付费或升级才能使用。试用期或达到配额后,不得禁用功能。此外,仅提供对 API 和服务的沙箱访问的插件也是试用或测试插件,不允许使用。

允许服务中的付费功能(请参阅准则 6:服务软件),前提是插件内的所有代码完全可用。我们建议使用托管在 WordPress.org 外部的附加插件,以排除高级代码。插件仅作为开发人员工具的情况将根据具体情况进行审查。

尝试向用户追加销售临时产品和功能可以接受的,只要它符合准则 11(劫持管理体验)的范围。

6. 允许软件即服务。

允许充当某些外部第三方服务(例如视频托管网站)接口的插件,即使对于付费服务也是如此。服务本身必须提供实质功能,并清楚地记录在随插件提交的自述文件中,最好带有指向服务使用条款的链接。

不允许的服务和功能包括:

7.未经用户同意,插件不得跟踪用户。

为了保护用户隐私,未经明确和授权同意,插件不得联系外部服务器。这通常是通过“选择加入”方法完成的,需要注册服务或插件设置中的复选框。有关如何收集和使用任何用户数据的文档应包含在插件的自述文件中,最好有明确规定的隐私政策。

禁止跟踪的一些示例包括:

此策略的一个例外是软件即服务,例如 Twitter、Amazon CDN 插件或 Akismet。通过安装、激活、注册和配置使用这些服务的插件,即获得对这些系统的同意。

8. 插件不得通过第三方系统发送可执行代码。

允许从记录的服务外部加载代码,但所有通信必须尽可能安全。不允许在不充当服务时在插件内执行外部代码,例如:

允许与站点交互并将软件推送到站点的管理服务,前提是该服务处理其自己的域上的交互,而不是 WordPress 仪表板内的交互。

9. 开发者及其插件不得做出任何非法、不诚实或有道德攻击的行为。

虽然这是主观且相当广泛的,但其目的是防止插件、开发人员和公司滥用最终用户以及其他插件开发人员的自由和权利。

这包括(但不限于)以下示例:

10. 未经用户明确许可,插件不得在公共网站上嵌入外部链接或积分。

插件代码中包含的所有“Powered By”或信用显示和链接都必须是可选的,并且默认情况下不会显示在用户的前端网站上。用户必须通过明确说明且易于理解的选择来选择显示任何及所有积分和链接,而不是隐藏在使用条款或文档中。插件可能不需要信用或显示链接即可运行。服务可以按照自己认为合适的方式对其输出进行品牌化,前提是代码是在服务而不是插件中处理的。

11. 插件不应劫持管理仪表板。

用户更喜欢并期望插件感觉像是 WordPress 的一部分。不断的唠叨和不必要的警报压倒了管理仪表板,会降低这种体验。

升级提示、通知、警报等必须限制范围并谨慎使用,无论是根据上下文还是仅在插件的设置页面上。站点范围内的通知或嵌入式仪表板小部件在解决后必须是可驳回或自行驳回的。错误消息和警报必须包含有关如何解决问题的信息,并在完成后自行删除。

应避免在 WordPress 仪表板内投放广告,因为它通常无效。用户通常仅在尝试解决问题时才访问设置页面。增加插件的使用难度通常不会带来好的评论,我们建议限制其中放置的任何广告。请记住:不允许通过这些广告跟踪推荐(请参阅准则 7),并且大多数第三方系统不允许后端广告。滥用广告系统的指导方针将导致开发者被上游举报。

欢迎并鼓励开发人员添加指向自己网站或社交网络的链接,以及本地(在插件内)包含图像的链接,以增强体验。

12. WordPress.org 上的公开页面(自述文件)不得发送垃圾邮件。

面向公众的页面,包括自述文件和翻译文件,不得用于发送垃圾邮件。垃圾邮件行为包括(但不限于)不必要的附属链接、竞争对手插件的标签、总共使用超过 12 个标签、黑帽 SEO 和关键字填充。

在适度的范围内允许链接到直接需要的产品,例如主题或插件使用所需的其他插件。同样,相关产品可以在标签中使用,但竞争对手不能使用。如果插件是 WooCommerce 扩展,它可能会使用标签“woocommerce”。但是,如果该插件是 Akismet 的替代品,则它可能不会使用该术语作为标签。重复使用标签或特定术语被视为关键字堆砌,是不允许的。

自述文件是为人编写的,而不是为机器人编写的。

在所有情况下,必须披露联属链接,并且必须直接链接到联属服务,而不是重定向或隐藏的 URL。

13.插件必须使用WordPress的默认库。

WordPress 包含许多有用的库,例如 jQuery、Atom Lib、SimplePie、PHPMailer、PHPass 等。出于安全和稳定性原因,插件可能不会在自己的代码中包含这些库。相反,插件必须使用与 WordPress 打包的这些库的版本。

有关 WordPress 中包含的所有 javascript 库的列表,请查看WordPress 包含和注册的默认脚本

14. 应避免频繁提交插件。

SVN 存储库是一个发布存储库,而不是开发存储库。所有提交、代码或自述文件都将触发与插件关联的 zip 文件的重新生成,因此只有准备好部署的代码(无论是稳定版本、测试版还是 RC)才应推送到 SVN。强烈建议在每次提交时包含描述性和信息性的消息。频繁的“垃圾”提交消息(例如“更新”或“清理”)使得其他人很难跟踪更改。多次快速提交仅调整插件的次要方面(包括自述文件),会对系统造成过度压力,并且可以被视为游戏最近更新列表。

一个例外是当自述文件更新只是为了表明支持最新版本的 WordPress 时。

15. 每个新版本的插件版本号必须递增。

仅当插件版本增加时,用户才会收到更新提醒。主干 readme.txt 必须始终反映插件的当前版本。有关标记的更多信息,请阅读我们有关标记的 SVN 说明以及readme.txt 的工作原理

16. 提交时必须有完整的插件。

所有插件在批准之前都会经过检查,这就是需要 zip 文件的原因。名称不能“保留”以供将来使用或保护品牌(参见#17:尊重品牌)。未使用的已批准插件的目录名称可能会提供给其他开发人员。

17. 插件必须尊重商标、版权和项目名称。

禁止使用商标或其他项目作为插件 slug 的唯一或初始术语,除非可以确认合法所有权/代表的证明。例如,WordPress 基金会已将“WordPress”一词注册为商标,在域名中使用“wordpress”属于违法行为。此政策适用于插件 slugs,我们不允许 slug 以其他产品的术语开头。

例如,只有 Super Sandbox 的员工才能使用“super-sandbox”一词,或者在“Super Sandbox Dancing Sloths”等上下文中使用他们的品牌。非员工应使用“Dancing Sloths for Superbox”等格式,以避免潜在误导用户相信该插件是由 Super Sandbox 开发的。同样,如果您不代表“MellowYellowSandbox.js”项目,则使用它作为插件的名称是不合适的。

建议使用原创品牌,因为它不仅有助于避免混淆,而且对用户来说更容易记住。

18. 我们保留尽最大努力维护插件目录的权利。

我们的目的是尽可能公平地执行这些准则。我们这样做是为了确保插件的整体质量和用户的安全。为此,我们保留以下权利:

作为回报,我们承诺谨慎使用这些权利,并尽可能尊重最终用户和开发人员。

 

规划、提交和维护插件

您已经编写了下一个Hello Dolly,并且希望全世界都使用它。你该怎么办?

1. 测试一次并再次测试

运气好的话,您的插件将被许多人在许多不同的情况和托管环境中使用。您需要确保已经测试了您的插件,以确保它可以在任何情况下工作并且不会让您的用户感到沮丧。

2. 取一个好名字

插件名称应该反映您和您的工作的独特性。当您选择名称时,请确保您没有侵犯商标或践踏他人的产品名称。如果您不是为 FaceRange(一家假公司)工作,那么您就不应该将您的插件命名为“FaceRange's Dancing Squirrels”。例如,更好的名称是“Dancing Squirrels for FaceRange”。想出一个好名字可能很困难,所以慢慢来。您的插件 URL 在提交后无法更改,但显示名称可以更改一千次。

显示名称是从主插件文件中的标头生成的,因此请注意您的 P 和 Q。

3. 编写出色的文档

README.txt文件是最好的起点,因为它是所有插件的标准参考点。您需要确保包括:

4. 提交您的插件

为了提交插件,需要三个步骤:

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

一旦插件排队等待审核,我们将在 14 个工作日内审核代码是否存在任何问题。遵循指南可以避免大多数问题。如果我们确实发现问题,我们将联系开发人员并努力寻求解决方案。获得批准后,您将收到一封电子邮件,其中包含有关如何访问存储插件的Subversion 存储库的详细信息。

通过 SVN将插件(和自述文件)上传到该存储库后,它将出现在 插件目录中。

5. 推出第一个版本

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

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

6.拥抱开源

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

7. 倾听用户的声音

您经常会发现您的用户对您的代码进行的测试用例比您想象的要多得多。这可能是非常有价值的反馈。

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

Jetpack 有一篇关于如何编写出色的错误报告的文章,您可以参考一下。

8.定期推送新版本

最好的插件是那些随着时间的推移不断迭代、不断推动微小变化的插件。不要因为等待太久才更新而让您的辛勤工作变得乏味。请记住,持续升级可能会导致“更新疲劳”,用户将停止升级。在太少的更新和太多的更新之间保持平衡很重要。

9. 冲洗并重复

就像生活的其他部分一样,最好的事情来自耐心和努力。

使用 Subversion

SVN,即 Subversion,是一个类似于 Git 的版本控制系统。它可以通过命令行或众多 GUI 应用程序之一使用,例如Tortoise SVNSmartSVN等。如果您是 SVN 新手,我们建议您先对 SVN 客户端进行比较,然后再决定哪一个最适合您。

本文档并不是对使用 SVN 的完整而有力的解释,而更像是开始使用 WordPress.org 上的插件的快速入门指南。有关更全面的文档,请参阅SVN 书籍

我们将在这里描述一些有关使用 SVN 的基础知识,因为它与 WordPress.org 托管相关。SVN 和几乎所有代码存储库服务的基本概念保持不变。

有关更多信息,请参阅以下文档:

警告:SVN 和插件目录是发布存储库。与 Git 不同,您不应该提交每一个小的更改,因为这样做会降低性能。请仅将完成的更改推送到您的 SVN 存储库。

概述

您的所有文件将集中存储在我们服务器上的svn 存储库中。从该存储库中,任何人都可以插件文件的副本签入到其本地计算机上,但是,作为插件作者,只有您有权签. 这意味着您可以更改本地计算机上的文件、添加新文件和删除文件,并将这些更改上传回中央服务器。正是这个签入过程更新了存储库中的文件以及 WordPress.org 插件目录中显示的信息。

Subversion 会跟踪所有这些更改,以便您可以在需要时返回并查看旧版本或修订版本。除了记住每个单独的修订之外,您还可以告诉 subversion 标记存储库的某些修订以方便参考。标签非常适合标记插件的不同版本,并且是确保在 WordPress.org 上看到正确版本并为用户更新的唯一完全受支持的方法。

你的帐户

您的 SVN 帐户将与您提交插件时使用的帐户的用户名(而不是电子邮件)相同。这也是您用于 WordPress 论坛的用户 ID。

请记住,大小写很重要- 如果您的用户名是 JaneDoe,那么您必须使用大写 J 和 D,否则 SVN 将失败。您可以在以下位置查看您姓名的具体大小写: https://profiles.wordpress.org/me/profile/edit/group/1/

如果您需要重置密码,请访问login.wordpress.org

SVN 文件夹

所有 SVN 存储库中默认创建三个目录。


/assets/
/tags/
/trunk/

默认情况下不再创建 /branches/ 目录,因为它未被使用。

树干

警告:不要将插件文件放在 trunk 的子文件夹中,否则/trunk/my-plugin/my-plugin.php 会中断下载。您可以使用包含文件的子文件夹。

/trunk目录是您的插件代码所在的位置。trunk可以被认为是最新最好的代码,但这不一定是最新的稳定代码。Trunk 用于开发版本。希望主干中的代码应该始终是工作代码,但它可能会不时出现错误,因为它不一定是“稳定”版本。对于简单的插件,主干可能是唯一存在的代码版本,这也很好。

即使您在其他地方(例如 git 存储库)进行开发工作,我们也建议您使 trunk 文件夹与您的代码保持最新,以便于 SVN 进行比较。

标签

/tags目录是放置插件版本的位置。您将为此处的子目录使用与插件版本控制相同的版本号。重要的是,您始终使用标签文件夹和正确的版本控制,以确保您的用户获得正确的代码。

该插件的 1.0 版将在 中/tags/1.0,1.1 版将在 中/tags/1.1,依此类推。

我们强烈鼓励使用语义软件版本控制

资产

笔记:另请参阅:您的插件资产如何工作

资产是您的屏幕截图、标题图像和插件图标所在的位置。该目录中的一些较旧的插件可能在 /trunk 中具有屏幕截图文件,但不建议这样做。所有新插件都应将其屏幕截图放在 /assets 中。这可以使插件的文件大小保持较小,因为无需将屏幕截图与插件本身一起发送到 WordPress 安装。

分支机构

默认情况下不再创建 /branches/ 目录,因为它基本上未被使用。本节可被视为已弃用,仅供参考。

/branches目录是您可以用来存储插件分支的地方。也许是正在开发的版本,或者测试代码等。

WordPress.org 系统根本使用分支目录做任何事情,它被认为是严格供开发人员根据需要使用的。由于默认情况下不再创建它,因此您可以忽略它,因为您不再需要它。

最佳实践

为了使您的代码最容易被其他开发人员访问,以下实践被认为是最佳的。

不要使用SVN进行开发

这常常令人困惑。与 GitHub 不同,SVN 是一个发布系统,而不是开发系统。您不需要提交并推动每一个小的更改,事实上这样做对系统有害。每次您将代码推送到 SVN 时,它都会为 SVN 中的所有版本重建所有zip 文件。这就是为什么有时您的插件更新长达 6 小时才显示的原因。相反,当你准备好时,你应该推一次。

使用 trunk 文件夹来获取代码

许多人用作trunk占位符。虽然可以简单地更新readme.txt主干中的文件并将所有内容放入标记文件夹中,但这样做会使比较代码中的任何更改变得更加困难。相反,主干应该包含最新版本的代码,即使该版本是测试版。

始终标记版本

虽然可以使用 trunk 作为插件的稳定标签,但实际上不支持也不推荐此功能。相反,版本应该被正确标记为迭代。这将确保与任何自动更新程序完全兼容,并允许在代码出现问题时进行回滚。

从主干创建标签

您不应将代码直接推送到标签文件夹,而应该在主干中编辑代码,在自述文件中填写稳定版本,然后将代码从主干复制到新标签。

这不仅可以让您更容易地看到任何更改,而且您可以进行更小的提交,因为 SVN 只会更新更改的代码。这将节省您的时间并减少潜在的错误(例如更新到错误的稳定标签并将错误代码推送给用户)。

不用担心标签文件夹暂时不存在。您可以使用svn cp复制 trunk 到标签,然后同时将它们推送到 SVN。

如果您在本地操作,那么您可以一次性更新主干并从中创建标签。检查存储库的根目录,更新 /trunk 中的文件,然后svn copy /trunk /tags/1.2.3(或无论版本号是什么)然后一次性提交整个内容。SVN是一个基于差异的系统,只要你使用svn进行复制操作,那么它就保留了历史记录,并且让其他人可以轻松跟进。

删除旧版本

由于 SVN 是一个发布存储库,许多开发人员选择删除其插件的旧版本(不受支持)。截至 2019 年,这不再加快发布速度,因为构建过程仅处理具有更改文件的标签。

例子

启动一个新插件

要启动您的插件,您需要将已有的文件添加到新的 SVN 存储库中。

首先在您的计算机上创建一个本地目录来存放 SVN 存储库的副本:


$ mkdir my-local-dir

接下来,查看预先构建的存储库


$ svn co https://plugins.svn.wordpress.org/your-plugin-name my-local-dir
> A my-local-dir/trunk
> A my-local-dir/branches
> A my-local-dir/tags
> Checked out revision 11325.

在我们的示例中,Subversion 已将中央 SVN 存储库中的所有目录添加到本地副本(“A”表示“添加”)。

要添加代码,请导航到my-local-dir 文件夹:$ cd my-local-dir

trunk/现在,您可以通过命令行使用复制/粘贴命令或拖放将文件添加到存储库本地副本的目录中。无论你觉得舒服什么。

警告:不要将插件文件放在 trunk 的子文件夹中,否则/trunk/my-plugin/my-plugin.php 会中断下载。您可以使用包含文件的子文件夹。

一旦您的文件位于 trunk 文件夹中,您必须让 subversion 知道您想要将这些新文件添加回中央存储库。


$ cd my-local-dir
my-local-dir/ $ svn add trunk/*
> A trunk/my-plugin.php
> A trunk/readme.txt

添加所有文件后,您将把更改检入中央存储库。


my-local-dir/ $ svn ci -m 'Adding first version of my plugin'
> Adding trunk/my-plugin.php
> Adding trunk/readme.txt
> Transmitting file data .
> Committed revision 11326.

所有签入都需要包含提交消息。

如果提交因“禁止访问”而失败,并且您知道自己具有提交访问权限,请将您的用户名和密码添加到签入命令中。


my-local-dir/ $ svn ci -m 'Adding first version of my plugin' --username your_username --password your_password

请记住您的用户名区分大小写

编辑现有文件

一旦您的插件位于目录中,您可能需要在某个时候编辑代码。

首先进入存储库的本地副本并确保它是最新的。


$ cd my-local-dir/
my-local-dir/ $ svn up
> At revision 11326.

在上面的例子中,我们都是最新的。如果中央存储库中有更改,它们将被下载并合并到您的本地副本中。

现在您可以使用您喜欢的任何编辑器编辑需要更改的文件。

如果您不使用 SVN GUI 工具(如 SubVersion 或 Coda),您仍然可以在进行更改后检查并查看本地副本和中央存储库之间有什么不同。首先我们检查本地副本的状态:


my-local-dir/ $ svn stat
> M trunk/my-plugin.php

这告诉我们,我们的本地副本trunk/my-plugin.php与我们从中央存储库下载的副本不同(“M”代表“修改”)。

让我们看看该文件到底发生了什么变化,这样我们就可以检查它并确保一切看起来正确。


my-local-dir/ $ svn diff
> * What comes out is essentially the result of a
  * standard `diff -u` between your local copy and the
  * original copy you downloaded.

如果一切看起来都不错,那么就可以将这些更改签入中央存储库了。


my-local-dir/ $ svn ci -m "fancy new feature: now you can foo *and* bar at the same time"
> Sending trunk/my-plugin.php
> Transmitting file data .
> Committed revision 11327.

现在你已经成功更新了主干。

“标记”新版本

每次正式发布插件时,都应该标记该版本代码的副本。这可以让您的用户轻松获取最新(或较旧)版本,让您更轻松地跟踪更改,并让 WordPress.org 插件目录知道应该告诉人们下载哪个版本的插件。

首先将代码复制到该tags/目录的子目录中。为了 WordPress.org 插件浏览器的缘故,新的子目录应该始终看起来像版本号。2.0.1.3很好。Cool hotness tag糟糕

我们希望使用svn cp而不是常规的cp,以便利用 SVN 的功能。


my-local-dir/ $ svn cp trunk tags/2.0
> A tags/2.0

与往常一样,检查更改。


my-local-dir/ $ svn ci -m "tagging version 2.0"
> Adding         tags/2.0
> Adding         tags/2.0/my-plugin.php
> Adding         tags/2.0/readme.txt
> Committed revision 11328.

标记新版本时,请记住将字段更新Stable Tagtrunk/readme.txt版本。

恭喜!您已更新代码!

笔记

不要在 SVN 中放入任何您不愿意且不准备部署给使用您插件的每个人的内容。这 包括供应商文件.gitignore 和其他所有内容。

您也不应该上传 zip 文件。与大多数代码存储库系统一样,SVN 希望您上传单个文件。

也可以看看

 

警报和警告

当您访问 WordPress.org 上的插件页面时,您可能会注意到特殊警报或警告。这些的存在是为了帮助访问者了解各种插件的状态。

已批准和待处理的数据

蓝色背景 - 该插件已获得批准并正在等待数据上传,但尚未对公众可见。 一旦您进行第一次提交,该插件就会公开。

已获得批准但尚未上传代码的插件将看到此消息:此消息向插件所有者显示,一旦通过 SVN 推送代码,该消息就会消失。

关闭

截至 2017 年 11 月,关闭的插件会显示一条通知:

红色背景:该插件已关闭,不再提供下载。

所有访问者都可以看到该信息,表明插件已关闭。2018 年 1 月之后关闭的插件将包含一个日期:

红色背景:该插件已于2018年2月7日关闭,不再提供下载。

60 天后,警报将更新以解释插件被关闭的原因:

详细说明插件被关闭原因的警报

插件提交者将看到以下附加注释:

蓝色背景:如果您没有请求此更改,请联系plugins@wordpress.org 了解状态。 当插件关闭时,我们会联系所有具有提交访问权限的开发人员,并说明原因,因此也请检查您的垃圾邮件。

插件被关闭的原因

除非出现极端情况,否则不会向 WordPress.org 安全团队或插件作者之外的任何人提供有关插件被关闭原因的其他详细信息。

已过时

不支持 WordPress 最近 3 个主要版本的插件有以下通知:

黄色背景:该插件尚未在 WordPress 的最新 3 个主要版本中进行测试。 它可能不再得到维护或支持,并且在与更新版本的 WordPress 一起使用时可能会出现兼容性问题。

此前,此消息提醒用户最近 2 年内未更新的插件。2018 年,它被修改为依赖更相关的数据。由于 WordPress 每年更新主要版本 2 到 3 次,并且维护的插件应该使用最新版本进行测试,因此可以通过在 WordPress 新版本发布时更新插件自述文件来避免此警报。

在 WordPress 的每个主要版本发布之前,开发人员都会收到电子邮件并要求更新此值。他们 不需要推送新版本,只需更新自述文件并将“Tested up to:”的值编辑为 WordPress 的最新版本。

 

管理插件的安全性

WordPress 插件中代码的安全性受到非常重视

警告:如果您发现存在安全问题的插件,请阅读报告插件安全问题

当 WordPress 安全团队验证插件漏洞时,他们会联系插件作者并指导他们如何修复和发布插件的安全版本。如果插件作者没有做出回应或者漏洞严重,插件/主题将从公共目录中提取,在某些情况下,由安全团队直接修复和更新。

解决安全问题

当您收到插件安全问题的报告时,可能会很可怕。首先,不要惊慌。每个人都会犯错误。最重要的是安全、及时地修复它。

  1. 确保您理解该报告。如果您不确定这意味着什么,请询问详细信息。即使是第三方记者通常也愿意花时间解释问题所在并指导您研究正确的解决方案。
  2. 让您的更改尽可能小。这将使您以后复习起来更加容易。
  3. 测试你的插件。确保安全修复不会破坏任何其他内容。确保升级不会导致奇怪的错误。继续WP_DEBUG并记录任何错误。
  4. 在更改日志中记录问题。您不需要详细说明所发生的情况,但要记录安全问题已解决。
  5. 在你的自述文件中注明记者的身份。这很好,让人们以后更愿意免费帮助你。
  6. 修改你的版本号。我们推荐SemVer,因此插件版本 3.9 的安全版本会将版本更改为 3.9.1 等等。

自动插件安全更新

自 WordPress 3.7 起,我们能够推送 插件的自动安全更新,以修复插件中的关键漏洞。许多网站都使用了插件自动更新功能,要么通过过滤器直接选择加入,要么使用 WordPress 可用的众多远程管理服务之一。

在极端情况下,插件审核团队和 WordPress 安全团队可能会确定插件问题严重到必须为所有用户进行更新。这种情况极为罕见,因为发生冲突的可能性很高。

 

批准自动更新插件并将其推广给 WordPress 用户的过程是高度手动的。安全团队审查版本中的所有代码更改,验证问题和修复,并确认插件可以安全地触发更新。推出自动更新需要修改和部署 API 代码。这与核心安全版本的标准和流程相同。

标准

我们当前考虑的安全推送标准是一个简单的列表:

  1. 安全团队是否已意识到该问题?
  2. 问题有多严重?它会对WordPress 安装的安全性以及更大的互联网产生什么影响?
  3. 该问题的修复是独立的还是添加了大量额外的多余代码?
  4. 如果插件的多个分支受到影响,是否已准备好每个分支的版本?
  5. 更新可以安全地自动安装吗?

这些要求的定义方式使得任何人都应该能够勾选每个框。

第一个标准——让安全团队意识到这个问题——至关重要。由于这是一个严格控制的过程,因此需要尽早通知WordPress安全团队。让我们知道就像通过电子邮件向我们发送plugins@wordpress.org详细信息一样简单。

插件和安全团队将与插件作者(以及报告者,如果不同)合作研究漏洞及其确切暴露情况,验证建议的修复方案,并确定将发布哪些版本以及何时发布。

 

常问问题

如何请求自动更新我的插件?

如果您觉得您的插件有足够大的用户群或者问题非常重要,请在推送代码plugin@wordpress.org 之前发送电子邮件。在电子邮件中包含供审核的更改补丁,并解释为什么您认为这应该自动化。

除了与安全相关的更改之外,我还可以包含自动更新的更改吗?

除了少数例外,没有。安全推送应该 与安全相关。我们更喜欢(并且很多时候需要)仅修复安全问题的插件版本,只需最少的代码更改,并且没有不相关的更改。

这使得每个人都可以快速查看更改并对其更加有信心。这也意味着用户受到的干扰最小。

为什么插件 A 会自动更新,而插件 B 却没有?

这不是 WordPress.org 的偏见,这只是我们一直使用的手动流程的倒退。如果我们收到有关问题的警报,我们将尽力处理。如果我们几天后发现,推出修复程序的机会窗口通常已经过去,并且不会那么有效。

如何禁用自动更新?

有多个选项可以禁用此功能。禁用核心自动更新的文章 适用于此处。任何禁用所有自动更新功能的操作都会阻止插件更新。如果您只想禁用插件更新,无论是所有插件还是单个插件,您都可以通过单个过滤器调用来实现。

如果我无法(或不想)修复我的代码怎么办?

你不必这样做。您的插件将保持关闭状态,2 或 3 个月后,插件页面将报告它因安全问题而关闭。如果您想推送修复但保持插件关闭,我们也可以这样做。只需回复电子邮件并与我们联系即可。

我只需修复报告的问题吗?

是和不是。您 确实 必须修复报告的问题,但是当您完成后, 整个插件将被重新审查,如果发现更多问题,您也将需要修复这些问题。最终目标是确保重新打开的插件是安全的。

如果我遇到指导方针问题怎么办?

当人们违反其他准则(例如包含自己的 jQuery 副本或进行未记录的外部服务调用)时,就会出现这种情况。这取决于其他问题的严重性。如果它只是您自己的 jQuery,我们可能会重新打开它并允许您按照自己的进度修复该问题。如果您要记录插件的所有安装,则需要在我们重新打开插件之前更正该问题。

 

插件开发者常见问题解答

托管 WordPress 插件有很多细节。在寻求帮助之前,请花一点时间查看您的问题是否在这里得到解答。

最后更新日期:2023 年 7 月 10 日

插件审核团队

如何联系插件审核团队?

您可以通过电子邮件联系我们plugins@wordpress.org– 我们会在 7 个工作日内回复所有电子邮件。

审核团队是否为 Automattic 工作?

不会。审核小组由 100% 志愿者组成。有些人得到全职雇主的报酬,但没有人受 WordPress.org、Automattic 或 WordPress.com 雇用

我可以加入团队吗?

请查看本手册页面

提交和评论

我在哪里提交我的插件?

转到“添加”页面并上传您的 zip。您的文件应该小于10 兆并且是一个完整的插件。我们不接受尚未准备好使用的占位符或插件。

如果我的插件超过 10 兆怎么办?

仔细检查您是否不包含未使用的文件(例如测试文件夹、文档和完整节点/供应商文件夹)。大多数面临此问题的插件都包含了最终代码中没有位置的各种开发内容。

提交后会发生什么?

您将立即收到一封自动电子邮件,告知您有关提交的信息。那时,有人会手动下载并审查您的代码。如果我们发现安全性、文档或演示没有问题,您的插件将获得批准。如果我们确定存在问题,您将收到第二封电子邮件,其中详细说明了需要修复的问题。

我的插件永久链接 (slug) 是什么?

当您提交插件时,您会收到一封自动电子邮件,告诉您插件是什么。这是根据主插件文件(带有插件标头的文件)中插件名称的值填充的。如果你设置你的,Plugin Name: Boaty McBoatface那么你的 URL 将会是wordpress.org/plugins/boaty-mcboatface,你的 slug 将会是boaty-mcboatface。如果现有插件包含您的名字,那么您将在提交时收到警告。

这也是 的插件和文本域的文件夹名称(在 SVN 中并安装在 WordPress 上),因此请仔细注意。

一旦您的插件获得批准,该名称 就无法重命名。请明智地选择。

为什么我得到的蛞蝓与我被告知的不同?

如果我们必须更改您的永久链接(slug),我们将始终通过电子邮件向您解释原因。一般来说,当您有明显的拼写错误或错误(例如 foundre 而不是Founder)或者与现有商标或其他插件存在冲突时,我们会更改您的永久链接。请务必仔细阅读您的评论电子邮件,因为我们会解释为什么我们要这样做。

为什么我的提交失败并提示我的插件名称已存在?

出现这种情况有两个原因:

  1. 您正在尝试使用 WordPress.org 上已存在的带有永久链接的插件
  2. 您正在尝试使用带有永久链接的插件,该插件存在于 WordPress.org之外并且拥有大量用户群。

第一个是显而易见的。您不能拥有两个具有相同永久链接的插件,因此您需要选择一个新插件。

第二个令人困惑,因为它告诉您该永久链接正在使用中,而不是在 WordPress.org 上。重要的是要了解插件更新 API 的工作方式是将插件文件夹名称(即永久链接)与其托管在 WordPress.org 上的每个插件进行比较。如果匹配,则会检查更新并提示用户升级。

当这种情况发生时,“原始”插件(我们不托管的插件)的用户将升级到来自 WordPress.org 的插件,如果这不是您真正想要做的,您可能会破坏他们的网站。

有时,当公司或个人私下发布其插件(例如通过 Github)并决定在 WordPress.org 上重新发布时,就会出现这种情况。在这些情况下,我们建议您给我们发送电子邮件,我们将引导您完成如何克服错误。

为什么我收到一条错误消息,提示我无法以术语开头插件名称?

该错误是为了通知您,您的显示名称不得以他人的商标用语开头。这是为了保护您和目录免受有关商标滥用的法律问题。要解决此问题,您必须更改插件的自述文件和主 PHP 文件中的显示名称。

请不要尝试通过巧妙地重命名您的插件(例如 WuuCommerce)来“解决”这个问题。所有这些只会让我们担心您将来将无法遵循指南。

为什么我收到一条错误消息,提示我无法在插件名称中完全使用某个术语?

一些商标所有者要求我们不再允许在插件名称中完全使用特定术语。如果您看到此错误,则必须从插件名称中删除该术语。

要继续提交,您必须从主插件文件和自述文件中的插件名称:行中删除“[TERM]”。

如果您尝试通过将术语从“Facerange”更改为“Face-Range”来解决此问题,我们将等待您的提交并重申您不能使用该术语。请不要试图偷偷摸摸或耍小聪明来突破这个限制。

如何提交官方插件?

以官方公司用户帐户登录并 使用该帐户提交。

我们不能接受个人开发者帐户提交的插件,除非它们显然也是公司的。例如,使用拥有 Gmail 地址的用户提交官方 Facerange 插件可能会被标记为商标侵权。

如果我使用错误的用户 ID 提交插件怎么办?

只需立即回复电子邮件并告知我们即可。我们可以为您转让所有权。如果您忘记执行此操作,您可以通过添加正确的帐户作为提交者然后让该帐户删除您自己的帐户来自行修复。

不要 重新提交您的插件。请立即告诉我们,我们会修复它。

插件获得批准需要多长时间?

没有官方平均值,因为没有两个插件是相同的。如果您的插件很小并且所有代码都正确,则应该在初次审核后的十四天内获得批准。

如果您的插件有任何代码问题,您将需要很长时间才能纠正这些问题。无论哪种方式,您都会plugins@wordpress.org收到一封包含状态的电子邮件,因此请将其添加到您的电子邮件白名单中并耐心等待我们的回复。

我发送了修复程序,但没有人回复。我应该等多久?

我们的目标是在七 (7) 个工作日内回复所有评论。如果少于这个数字,就说明我们真的很忙。如果已经过去两天了,例如周末或假期,那么您不应该期待回复。

请记住,审核团队由 100% 志愿者组成,他们都有全职工作和其他志愿者职责。我们确实会及时回复,但我们也有 WordPress 之外的生活。

如果我的插件有问题,我需要多长时间修复它?

没有时间表,只要我们知道您正在努力并且我们认为您正在取得进展,我们就会开放审核。您的插件将在 3 个月后被拒绝,但审核将保持开放状态。

为什么我的插件在三个月后被拒绝?

如果您的插件审核在三 (3) 个月后仍未完成,我们将拒绝您的提交,以保持队列的可维护性。在任何时间点,我们都有 700 人进行中期审核,我们认为 3 个月是一个相当合理的时间范围。

我终于修复了我的插件。我应该重新提交吗?

否。回复电子邮件。即使已经过去18个月了。迄今为止最长的时间已经有3年了。我们不介意是否需要一段时间。

我一次可以提交多少个插件供审核?

只有一个。

为什么我不能一次提交多个插件?

事实证明,允许人们同时提交多项内容不利于审核过程。所有插件中经常发现错误,导致相同的电子邮件被发送多次。此外,人们常常对自己正在进行的审查感到困惑,从而使需要解决的问题变得混乱。通过将其更改为一次一次,这些问题的混乱程度显着下降。

此外,许多新用户不知道如何使用 SVN,最终提交了多个插件但从未使用过任何一个。这可能会消耗我们的资源,所以我们确实限制人员。

由于所有插件都会在两周内获得初步审核,因此这应该不是什么难事。

我可以使用多个帐户提交多个插件吗?

不可以。如果您这样做,我们将暂停您的所有辅助帐户。请不要试图绕过一次一次的规则。

我需要在特定日期批准我的插件,我该怎么办?

尽早提交。除非该插件旨在解决安全或法律问题,否则我们不允许插队。如果 与其中之一相关,请发送电子邮件plugins@wordpress.org 说明情况。

有哪些具体事情是我应该避免做的?

我们寻找一些非常明显的事情,所有这些都列在我们的指南中。大多数可以概括为“不要成为垃圾邮件发送者”,但我们来谈谈人们最常做的事情:

再次强调,这是一个简短的概述。请阅读指南,因为完整列表非常详细。

有您不接受的插件吗?

我们不接受“不做任何事情”、非法或鼓励不良行为的插件。这包括黑帽 SEO 垃圾邮件、内容旋转器、仇恨插件等。

同样,我们不接受框架插件或库插件。如果您的插件必须要求其他插件或主题进行自身编辑才能使用您的插件,那么它就是一个库。如果您的插件是一个模板,可以通过直接自定义文件来构建更多代码,那么它就是一个框架或样板。框架和库应该与每个插件一起打包(希望不会与使用框架或库的其他插件冲突)。至少在核心支持插件依赖之前。

我们也不接受其他人作品的 100% 副本或重复 WordPress 核心中的功能的插件。基本上,你的插件应该做一些新的事情,或者以新的方式,或者解决一个特定的问题。

我想重做、升级或重新命名我现有的插件。我就再提交一次吧?

不,你应该重写并升级现有的插件。使其成为主要版本发布。我们无法重命名插件或转移用户,因此新插件不会继承任何现有用户、评论、支持主题、评级、下载、收藏夹等。基本上,您会将所有当前用户排除 在外,这太卑鄙了。

我的提交犯了一个错误。我该如何修复它?

每次提交都会收到带有说明的自动回复。回复该邮件或电子邮件plugins@wordpress.org并解释情况。

我们可以在批准之前更正插件,因此我们通常能够为您解决该问题。如果没有,我们会让您知道该怎么做。在批准任何事情之前,我们会尝试找出名称中的拼写错误,但我们也会犯错误。

插件名称中有一些我不能做的事情吗?

我们有以下限制:

我们鼓励每个人发挥创造力,想出独特的鼻涕虫。我们会自动更正任何具有不可接受的 slug 的插件。如果对最佳选择有疑问,我们将与您联系以确定。

使用 SVN 存储库

我把我的文件放在哪里?

将代码文件直接放在trunk/存储库的目录中。每当您发布新版本时,通过将当前主干修订版复制到该目录的新子目录来标记该版本tags/

确保您进行更新trunk/readme.txt以反映新的稳定标签。

自述文件的图像(例如屏幕截图、插件标题和插件图标)位于assets/SVN 结帐根目录中的目录(您可能需要创建)。例如,这将与tags/和处于同一水平。trunk/

我可以将文件放在 的子目录中吗trunk/

不可以。这样做会导致拉链生成器损坏。

如果您有包含大量文件的复杂插件,您当然可以将它们组织到子目录中,但readme.txt 文件 和根插件文件应直接放入trunk/.

我应该如何命名我的标签(又名发布)?

您的 Subversion 标签应该看起来像版本号。具体来说,它们应该只包含数字和句点2.8.4是一个好看的标签,一个my neato releaso是一个糟糕的标签。我们建议您使用语义版本控制来跟踪版本,但我们不强制执行此操作。

请注意,我们在这里讨论的是Subversion标签,而不是 readme.txt 搜索类型标签。

我应该在 SVN 中保留多少个旧版本?

尽可能少。很少有人需要发布存储库中的旧代码。请记住,SVN 不适用于您的代码版本控制。你可以使用 Github 来做类似的事情。SVN 应该有您当前的发行版本,但您不需要所有以前版本的所有次要版本。对他们来说,最后一两个就很好了。

我可以在我的插件中包含 SVN 外部组件吗?

不可以。您可以将svn externals添加到您的存储库,但它们不会添加到可下载的 zip 文件中。

我可以将 zip 和其他压缩文件放入我的插件中吗?

不。

我可以包含缩小的 JS 吗?

是的!但是,您要么必须在插件中保留非缩小文件,要么通过自述文件指导人们在哪里可以获得非缩小文件。

缩小可以,但是隐藏就不行了。所有代码都必须是人类可读的才能包含在该目录中。

您的 WordPress.Org 页面

我的插件什么时候“上线”?

一旦您将代码推送到 SVN 文件夹,您的插件就会上线。如果您还没有准备好,请不要推送代码,因为除了关闭插件 之外没有“关闭”开关。由于关闭插件是永久性的,因此我们建议您在准备好上线之前不要推送代码。

WordPress.org 插件目录从哪里获取数据?

来自您在插件文件和readme.txt 文件中指定的信息,以及来自 Subversion 存储库本身。阅读readme.txt 如何工作以获取更多信息。

您还应该充分利用主插件文件中的插件标头。这些将定义您的用户名如何显示在 WordPress.org 托管页面以及 WordPress 管理员中。我们建议使用所有这些标头来完整记录您的插件。

我可以指定 WordPress.org 插件目录应使用我的插件的哪个版本吗?

是的,通过指定Stable Tagtrunk 目录的readme.txt 文件中的字段。

我们要求您不要使用“trunk”作为稳定标签,因为这会使回滚变得比需要的更加复杂。

“已测试”值应该是哪个版本的 WordPress?

从逻辑上讲,无论您测试到什么版本。但是,切勿超出当前候选版本。如果没有,请不要高于活动版本。所以如果WordPress的稳定版本是6.0.9,你可以使用6.0到6.0.9,一切都会好起来的。如果有 6.1-RC 版本,那么您可以使用 6.1,但不能再更高了。

不要试图耍小聪明而使用 6.5 或 7。这将导致您的页面出现错误。

每次更新自述文件时是否都需要发布新版本的插件?

不需要。如果您只是对自述文件或图标/标题进行外观更改,则无需发布新版本。只需确保更新 trunk 和 tag 文件夹即可。

每次更新代码时都需要发布新版本的插件吗?

是的。不然没人更新。

我的变更日志中应该包含哪些内容?

更改日志是对插件所做的所有或所有显着更改的日志或记录,包括错误修复、新功能等更改的记录。如果您需要帮助格式化更改日志,我们建议保留更改日志,因为这是使用格式通过许多产品。

我的变更日志中应该保留多少个版本?

始终将当前的主要版本保留在更改日志中。例如,如果您当前的版本是 3.9.1,您将需要在更改日志中包含该版本和 3.9。应删除旧版本并将其迁移到changelog.txt文件中。这将使用户能够访问它们,同时使您的自述文件更短、更相关。最多,将插件的最新版本和一个主要版本保留在自述文件的更改日志中。您的插件在 WordPress.org 插件目录中将changelog.txt可见,但这没关系。大多数用户只是想知道有什么新鲜事。

如何在插件描述页面上包含视频?

对于 YouTube 和 Vimeo 视频,只需将视频链接单独粘贴到您的描述中。请注意,视频必须设置为允许嵌入,嵌入过程才能正常工作。对于由 WordPress.com VideoPress 服务托管的视频,请使用[wpvideo]短代码。如果需要,短代码也可用于 YouTube 和 Vimeo,就像在 WordPress 中一样。

为什么我的插件说它没有经过最新 WordPress 版本的测试?

当您忽略在自述文件的标题中使用正确的“已测试”值时,就会发生这种情况。该值应该是您测试插件的最新版本的 WordPress。如果最新的WordPress主要4.9版本是 4.9,那么您应该具有指示兼容性的值。您不需要更新次要版本(如果您的自述文件与 4.9 兼容,那么它将涵盖 4.9 到 4.9.1000)。

请记住,如果您安装未发布的 WordPress 版本(例如 6.0),您将看到相同的消息。

插件目录需要多长时间才能反映我的更改?

WordPress.org 插件目录每隔几分钟更新一次。但是,根据更新队列的大小,您的更改可能需要更长的时间才会显示。请至少提前6 小时联系我们。

如何为我的插件页面制作那些很酷的横幅之一?

您可以通过将正确命名的文件上传到文件夹中来制作自己的插件标头assets。阅读插件标头以获取更多信息。

如何制作插件图标?

您可以通过将正确命名的文件上传到文件夹中来制作自己的插件图标assets。阅读插件图标以获取更多信息。

我可以在我的插件横幅/图标中使用官方徽标吗?

通常不会。

您的插件图标 永远不应该是未更改的官方徽标,例如 Facerange。这将侵犯他们的财产。您不得在横幅或图标中使用官方徽标作为您的品牌。即使您有权在自己的网站上这样做,我们在这里也没有该权限。

就像您的插件名称一样,我们建议您的图标和标题对您来说是独一无二的。这样它们往往更容易被记住。

我的自述文件中可以使用多少个标签?

根据指南,插件的自述文件中的标签仅限于 12 个。这是为了控制垃圾邮件。也就是说,只有前五个标签会显示在 WordPress.org 上,原因大致相同。前 12 个标签用于搜索,其余标签将被忽略,因此标签填充根本没有帮助。

此外,任何只有您使用的标签都不会显示,因为它们不会帮助任何人找到另一个类似的插件。

插件名称

获得批准后我可以更改插件名称吗?

是和不是。您可以更改显示名称,但插件(插件 URL 中属于您的部分)一旦获得批准,就无法更改。这就是为什么我们在提交时多次警告您。

要更改显示名称,请编辑主插件文件并将“插件名称:”的值更改为新名称。您还需要编辑 readme.txt 中的标题以匹配。

为什么我不能使用某人的商标/品牌作为我的插件名称?

简而言之,因为你不是他们。

如果您为 BooCommerce 编写了附加插件,则不得将其命名为“BooCommerce 改进的产品搜索”,因为这会生成 slug,boocommerce-improved-product-search并且会与“BooCommerce”的商标发生冲突。也就是说,提交名称“Boo Improved Product Search”是可以接受的,该名称将使用 slug bc-improved-product-search(“bc”不是商标,您会看到)。

另一个例子,如果您有一个插件与一家名为 Amazorn 的流行云托管公司集成了服务,您可以将其称为“My Service Integration for Amazorn”,但您不能使用“Amazorn – My Service Integration 。 

考虑一下 Keurig 现实生活中的例子。如果您制作了环保酿造杯,您可以将其营销为“EcoBrew Pod for Keurig”,但您不能尝试将其营销为“Keurig EcoBrew Pod”。后者意味着与 Keurig 有直接关系,并且在某些国家/地区实际上是违法的。为了保护您,我们需要您谨慎对待公认的品牌名称和商标。总是谨慎行事;如果他们来告诉我们关闭您的插件,因为您将他们的术语用作 显示名称中的第一个单词,我们就必须这样做。

注意:我们不再有权允许新插件用作woo其永久链接的开头,并且需要强制使用wc

公司可以允许我在我的永久链接中使用他们的商标吗?

不。

虽然我们知道公司可以并且确实授予使用权限,但我们不接受它们作为永久链接,原因非常重要:一旦插件获得批准,我们就无法更改您的永久链接。这意味着,如果公司后来改变主意并撤销批准,该插件将被关闭,所有用户都将被放弃。

为了对插件在目录中的长期生存具有前瞻性和主动性,我们不接受“许可”。永久链接不得以商标(或众所周知的品牌/术语)开头,除非是由官方所有者创建的。

我可以更改插件的 URL/slug 吗?

插件的 URL 一旦获得批准就无法更改,我们会在整个过程中的多个地方警告您这一点。

因此,我们拒绝了大多数使用“新”插件来替换旧插件的请求,只是为了获得更好的插件。

这是因为我们无法在插件之间迁移用户,也无法重定向流量。这意味着提交一个新插件来更改 slug 对插件的 SEO 和声誉非常不利,因为用户将被放弃。大多数插件实际上并不需要新的 URL,而只是想编辑其显示名称。

除非存在与您的 slug 相关的严重拼写错误、语言或法律问题,否则我们不太可能批准新的 slug。如果这样做,我们将标记您的帐户,以表明将来的重命名请求将被拒绝。

如何更改插件的显示名称?

您需要在自述文件 插件主文件中更改它。

我可以随意设置我的显示名称吗?

请勿使用粗俗、诽谤或其他故意辱骂性的语言。如果您不是官方消息来源,则您不能声称自己是官方消息来源,或者看似声称自己是官方消息来源。例如,如果您制作了一个连接到 Frozbaz 服务的插件,您应该将您的插件称为“Frozbaz 服务连接器”——这样,您就已经明确表示您正在为服务制作插件,而不是服务。

如果您要组合多种服务(例如,流行电子商务插件的支付网关),我们强烈建议您提供一个原始的、唯一的显示名称。

我可以在显示名称中使用 WordPress 或插件吗?

目前是的,但你不应该。这是非常多余的,并且实际上不会以任何方式、形式或形式帮助您的 SEO。我们已经将 WordPress 插件放入您的页面标题中。

我应该在插件名称中使用商标或注册符号吗?

假设您确实申请了商标,您当然 可以,但这种情况并不常见。甚至谷歌或 Facebook 也没有这样做。只需使用您的商标术语并拥有其日志(如您的 SVN 日志),您通常就已经完成了保护您的品牌所需的法律行动。详情请咨询律师。

搜索

我的插件需要多长时间才会出现在搜索中?

通常在插件提交到 SVN 后 6 到 14 天。这是因为我们必须添加您的数据、解析它并将其共享到我们所有 高度缓存的服务器。这不是瞬时的。另外作为一个新插件,我们没有使用数据,因此您可能需要稍等一下。

我怎样才能排名更高?

为该语言编写一份好的自述文件,及时回复支持帖子,获得好评。

我的网址和显示名称哪个更重要?

两者都不。使您的显示名称易于记忆且具有描述性,同时将其控制在 5 个单词以内,以获得最大效益。

支持论坛

我如何收到论坛帖子的通知?

转到https://wordpress.org/support/plugin/YOURPLUGIN 并查看右侧的侧边栏。单击“订阅此插件”按钮以获取电子邮件警报。

我如何收到所有插件的通知?

每个插件支持论坛页面的顶部都有一个“订阅”按钮。单击该按钮,您将收到电子邮件。您可以在以下位置查看您订阅了哪些插件论坛集 https://wordpress.org/support/users/YOURID/subscriptions

对于 RSS,访问https://wordpress.org/support/view/plugin-committer/YOURID将列出您有权提交访问的任何插件的所有支持请求和评论。不是提交者,只是被列为作者的人?使用 https://wordpress.org/support/view/plugin-contributor/YOURID

您还可以前往https://profiles.wordpress.org/YOURID/profile/notifications/ 并输入您希望通过电子邮件发送的任何条款。请小心,如果您使用通用术语,情况可能会升级。

如何授予支持帐户访问我的插件的权限?

您可以将支持代表添加到您的插件中。支持代表可以将论坛主题标记为已解决或粘性(与插件作者和贡献者相同),但没有对该插件的提交访问权限。

用于管理插件支持代表的 UI 可以在插件页面上的高级视图中找到,位于管理提交者旁边。一旦某人被添加为支持代表,他们在回复插件支持主题或评论时将获得插件支持徽章。

你们会删除对我的插件的差评或评论吗?

一般不会。评论反映了个人对您的产品的体验。如果他们不喜欢,我们就无法改变。如果您认为评论无效(例如针对不同的插件),请使用 modlook 帖子上的按钮。论坛团队的一名成员将进行调查。

滥用 modlook 功能可能会导致您的插件被暂停。请明智地使用它。

什么是“马甲”?

当有人在论坛上创建多个帐户时就会发生这种情况,通常是为了给自己一些五星级评论,或者创建虚假的支持票以显得反应更快。马甲行为违反了我们的准则,将导致评论和帖子被删除,还可能导致您的帐户和所有插件被删除。不要这样做,也不要明目张胆地指责别人这样做。

封闭插件

如何关闭我的插件?

自 2020 年 4 月起,您可以随时关闭自己的插件。为此,请转到插件页面上的高级https://wordpress.org/plugins/myplugin/advanced/选项卡(即)并向下滚动到关闭此插件部分。在那里您将看到一条警告消息和一个按钮。

“关闭此插件”功能的图片,并注明“警告:关闭您的插件是一项永久性操作。如果不联系插件团队,您将无法重新打开它。”  下面有一个按钮,上面写着“我明白”。

如果您同意警告并想要关闭插件,请按按钮。

请记住,除非您能证明自己的情况合理,否则您将无法恢复插件。按请求关闭插件是永久性的

如果我不小心关闭了插件怎么办?

发送电子邮件plugins@wordpress.org并要求重新打开您的插件。不过,我们会询问您是如何做到这一点的,以便我们改进该功能的功能。

为什么它不允许我关闭我自己的插件?

假设您以正确的帐户登录,可能是因为您的用户太多。如果您的插件有超过 10,000 个用户,您需要发送电子邮件plugins@wordpress.org并请求我们关闭它。

我可以暂时关闭我的插件吗?

不。

我们不允许这样做,因为这会给用户带来糟糕的体验。隐藏插件会让用户认为该插件已因安全或指南问题而被删除,这导致他们不再信任您。我们无法阻止他们的想法,因此我们禁止“临时”关闭。

一般来说,当他们的插件有一个正在修复的错误,或者当他们无法支持它时,人们希望这样做。我们建议您尽快修复错误,或者如果您不支持该插件,请更新自述文件以说明它当前不受支持以及原因。

如果这是一个全新的插件,您应该将其称为“公共测试版”,以便人们了解其状态。

插件关闭时会发生什么?

当插件关闭时,页面显示为已关闭并且不再生成 zip。没有人能够通过网站下载该插件,也无法通过 WordPress 管理员安装它。SVN 存储库将保持可访问性,以允许其他人根据目录的原则下载和派生代码(如果需要)。

60 天后,关闭消息将发生变化,以提醒人们 关闭的原因,但仅限于最广泛的术语(违反指南、安全等),而不是明确的详细信息。

为什么我的插件被关闭了?

插件因违反准则、安全问题或应作者请求而被关闭。如果出现活跃问题(例如版权侵权、滥用和安全),所有具有插件提交访问权限的帐户都会收到通知。

如果某个插件在 6 个月内从未使用过(即没有代码推送到 SVN)、SVN 已损坏超过 12 个月,或者插件的自述文件表明其已弃用,我们可能会关闭,恕不另行通知

为什么别人的插件被关闭了?

截至 2017 年,插件数据库中跟踪了插件关闭原因。插件关闭六十天后,关闭原因将被公开:

因“作者请求”原因而关闭的插件示例

请注意:我们不会公开披露插件被关闭的确切原因的详细信息。

我可以关闭别人的插件吗?

如果您向 报告插件中的安全问题违反准则的行为plugins@wordpress.org,我们将进行审查并采取适当的措施。大多数时候,这涉及关闭插件。除非您提出要求,否则我们不会公开您的姓名,以保护您免受强烈反对。

有人发布了我的插件的副本!我该怎么办?

plugins@wordpress.org 包含被盗插件链接的电子邮件。请附上我们可以下载您的文件的链接或附上 zip 文件。我们将比较这两个文件以及我们拥有的所有编码历史记录,以确定该插件是否确实是盗窃,或者只是一个未经认可的分叉。

请记住,如果您将插件许可为 GPLv2 或更高版本,那么只要版权保持完整并且您获得认可,就完全可以分叉您的作品。

如果有人复制了我的部分代码但没有注明来源,我该怎么办?

plugins@wordpress.org立即发送电子邮件!特别是如果您的代码不是 GPL。虽然我们确实允许人们分叉其他插件并将该代码包含在他们自己的插件中,但它必须始终被记入。版权和学分是一个要求。

您会关闭另一个侵犯品牌/商标的插件吗?

我们尽最大努力维护版权和商标要求,并防止品牌混淆。在插件获得批准之前,我们经常要求他们进行一些更明显的更改。也就是说,当目录中有 60,000 个插件,并且某些术语非常常见(例如“弹出”或“一体化”)时,URL 或名称的“不同”程度是有限的。因此,我们要求开发人员更改插件的 显示名称,以免再造成冲突或混乱。

如果有人明显侵犯您的版权、商标或现有品牌,无论是通过显示名称还是使用商标图像,请向我们发送电子邮件并提供plugins@wordpress.org 一些证据,我们将联系开发商并要求更改。

我们确实希望这些都是 合理的要求。也就是说,如果您向我们发送投诉并列出 12 个插件,这些插件都使用术语“最佳联系表单”(因为这是您的插件名称),我们将审核这些插件,并且仅在它们过度使用该短语时才将其关闭。如果他们使用一次(即“这是法罗群岛最好的联系表单插件”),那么这是可以接受的。如果他们在短语中填充关键字,我们更有可能因关键字填充而关闭它们。简而言之,如果您的插件名称非常通用,就会发生这种情况,而且通常不是 侵权案件。

另请注意,如果这不是您的商标,我们将无法接受您的报告。管理和维护商标所有者的责任,而不是用户的责任。

如何发送安全报告?

通过电子邮件plugins@wordpress.org清晰简洁地描述问题。请阅读我们有关报告安全问题的文档以了解详细信息

你们是否为发现插件中的错误提供奖励?

不会。我们与任何错误赏金计划没有关系,因此我们不会向他们提交您的报告等。我们唯一合作的网站是hackerone.com/automattic,该网站针对与 Automattic 属性相关的错误。其他的一切都是你自己的,不要要求我们提交东西。

您是否帮助提交或提供 CVE?

不可以。我们没有能力协助解决 CVE。

我的插件被关闭了,我可以重新打开它吗?

或许。如果它因安全原因而关闭,请修复问题,回复电子邮件,大多数时候我们会重新打开该插件,除非它存在更多安全问题或严重的指南问题。如果因违反准则而被关闭,则取决于违规的严重程度和性质。例如,与初次犯罪者相比,惯犯重新打开插件的可能性较小。

如果您要求关闭该插件,您将需要解释为什么改变主意。插件旨在在开发人员请求时保持关闭状态,并且在一个月后不会再次重新打开。

所有插件必须通过当前标准和安全审查才能恢复。这不是可选的。与您解决所有潜在问题的一次较长时间的关闭相比,用户会因为多次关闭您的插件而对您失去更多信心。

当我的员工/同事违反准则时,为什么我的插件被关闭?

代表插件的每个人,从支持技术到开发人员,都是插件所有者的责任。如果他们严重违反准则,那么业主应该接受这些后果并采取纠正措施。如果没有发生这种情况,插件就会关闭。在这些情况下,我们会通知插件所有者并解释原因,并尽力保持插件开放。

我所有的插件都被关闭了!我怎样才能把它们找回来?

我们关闭开发人员的所有插件的情况非常罕见。一般来说,发生这种情况的原因如下:

  1. 您要求我们关闭您的所有插件
  2. 电子邮件问题
    1. 电子邮件被退回,我们无法取得联系
    2. 该电子邮件向我们发送了自动回复,并且至少发送了两次警告来解决这个问题
  3. 指南问题
    1. 之前曾对行为进行谴责和/或发出过最终警告
    2. 向名录和/或志愿者发出法律威胁
    3. 该违规行为被视为“极其严重”(死亡威胁、数百个袜子木偶、骚扰等)

如果您要求我们关闭它们,您必须解释 为什么改变主意。

如果您遇到电子邮件问题,则必须解决它们,并且需要使所有插件符合当前的安全标准和准则。

至于最后一个……一般来说你不会再回来了。如果我们针对您的行为向您发出最终警告,并且在不到一年的时间内您再次启动时遇到问题(或未能解决我们提到的所有问题),我们将不会重新开放您的插件。

我刚刚收到最后警告。我该怎么办?

首先,也是最重要的一点,要认真对待。该电子邮件将准确列出问题所在以及我们选择升级为最终警告的原因。插件所有者应解决所有问题,停止造成新的违反准则的行为,并密切监视任何同事的行为。简而言之,停止违反准则,停止找借口,为任何不当行为道歉,并改正方向。

我们最不想做的就是禁止某人并禁用他们的所有插件。这对社区来说并不健康。同时,如果开发人员无法或不愿意遵守与其他人相同的规则,那么将其保留在目录中是有害的,并且对其他人不尊重。

插件所有权

如何让其他人访问我的插件?

要将用户添加为提交者,即授予他们更新代码的权限,请转到https://wordpress.org/plugins/YOURPLUGIN/advanced 并将其用户名添加为提交者。

要让他们显示为作者,请将他们的用户名添加到readme.txt 文件中。

不要将普通用户添加为作者。它仅适用于帮助开发的人。这意味着如果有人“启发”了您,您不应该将他们添加为作者。

如何从我的插件中删除某人的访问权限?

任何具有提交访问权限的人都可以执行此操作。转到https://wordpress.org/plugins/YOURPLUGIN/advanced他们的 ID 并将其悬停在其上。将出现删除链接。点击它。

请不要删除自己。

如何更改插件所有者?

转到“高级”选项卡并向下滚动到“危险区域”。在那里您将看到“传输您的插件”部分。从下拉列表中选择某人,然后单击按钮。

有关更多详细信息,请阅读有关传输插件的文档

我尝试转移我的插件,但它说我不能。为什么不?

拥有大量用户(超过 10,000 名)的插件或被认为对 WordPress 项目至关重要的插件(例如特色插件或测试版插件)只能通过向插件团队提出书面请求来转移。请阅读有关传输插件的文档以了解详细信息

如何接管废弃的插件?

我们允许用户采用当前不再开发的现有插件

我们要求您首先尝试与原始开发人员联系,以便他们可以添加您。在某些情况下,这是不可能的,您应该从修复插件开始。确保它符合编码标准、安全,并更新版权信息以包含您自己。然后您可以联系我们了解插件采用事宜

我们保证您会获得任何人的插件,即使在成功审核之后也是如此。

这些购买我的插件的优惠合法吗?

简短回答:可能不会。

许多开发人员会收到未经请求的电子邮件或购买其插件的报价。我们发现其中绝大多数都是欺诈性的,不 建议您跟进。

虽然合法的优惠确实存在,但它们通常来自与插件相关的官方公司,或者来自成熟的插件公司。那些以“我们正在联系 WordPress 社区……”或“我们正在寻求获取现有的 WordPress 插件……”开头的内容不应被信任。此类购买通常会通过跟踪用户或其他严重违反准则等卑鄙策略来破坏插件(以及原始开发者)的声誉。

如果您确实选择出售您的插件(或将其赠送给其他人),请确保新所有者了解存储库的所有准则。如果他们违反了我们的条款,该插件将被删除,并且我们可能不会根据违规程度将其返还。任何拥有插件访问权限的人都对其用户行为拥有所有权和责任。垃圾邮件、插入跟踪数据和添加垃圾功能是破坏插件的最快方法。

我们主张只将您的插件提供给您亲自审查过的人,并且您信任他们会对您的代码和用户负责。

当插件开发者去世时会发生什么?

当开发人员被确定死亡时,他们将从自己的插件中删除,以防止不道德的人获得访问权限并伤害用户。如果他们是唯一的开发者,则该插件可能会被关闭。我们尽一切努力寻找他们的朋友和同事,为他们提供首先采用代码的机会,但如果找不到可靠或愿意的人,则插件将被关闭。