WordPress中文开发手册

WordPress插件开发 — 插件开发者常见问题

#提交和批准

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

没有官方的平均值,因为没有两个插件是一样的。如果你的插件很小,所有的代码都是正确的,应该在七天之内批准。如果您的插件有任何代码问题,您需要花费更长时间来纠正问题。无论哪种方式,您将收到来自plugins@wordpress.org的电子邮件地址,因此请将其添加到您的电子邮件白名单中,耐心等待我们的回复。

##如果我的插件有问题,我需要解决多长时间?

从我们与您联系的时间起,我们允许七天的时间,当我们希望您完成更正。这是我们必须保持排队的唯一方法之一。如果您需要超过七天的时间,我们会拒绝您的请求,您可以在完成后重新提交。

你有什么特别的东西我应该避免吗?

我们寻找一些非常明显的东西,所有这些都列在我们的指南中。大多数人可以总结为“不要成为垃圾邮件发送者”,而是触及人们最多的工作:

作为服务时不包括一个readme.txt文件。
readme.txt文件是插件目录中插件显示信息的主要来源。它应该是现在的,应该解释如何使用插件和什么插件,即使你觉得很明显。
不用WP_DEBUG测试插件
我们用WP_DEBUG测试你的插件。你也应该在你提交之前。如果插件不起作用,我们推回。
包括打包的JavaScript库的自定义版本
WordPress附带了许多默认脚本(包括jQuery),我们要求您不要在您的插件中。用我们的
调用外部文件
所有插件应尽可能独立。显然,如果您的插件依赖于您自己的服务器(如Twitter)上的服务,那么远程调用JS就可以了。但是,如果您尝试将图像和JS卸载到CDN而不提供服务,那么我们不允许这样做。
“Powered By”链接
网站前端方面的所有链接都必须是“选择加入”,这意味着您的插件可能不会默认链接到访问者看到的网站或其他任何网站。
打电话回家
这不仅仅是跟踪用户,而且还不包括将任何数据发送回服务器的文件(如iframe),除非这是插件的工作原理。即使这样,我们也可能会问。

##你有不接受的插件吗?

一个插件应该是直接有益于用户的东西。它不应该要求用户编辑文件,它应该是开箱即用的。

##我可以更改我的插件的名称吗?

是和否您可以更改显示名称,但是插件 - 您的插件网址的那部分 - 在批准插件后无法更改。所以,如果您提交“我的酷工具”作为名称,您的URL将是https://wordpress.org/plugins/my-cool-tool/,也将是每个人的网站上的文件夹名称。

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

你有不允许的名字吗?

我们不允许在插件名称中使用“WordPress”,因为它是多余的,有些显而易见的是你是一个WordPress插件。同样的原因我们也一般不允许使用“插件”。只有英文字母和阿拉伯数字才能在sㄧ。。,,,,so so so so。。。。。。。。。。。。。。。。。。。。。。。我们不允许插件名称中的版本号。

我们还禁止在Web服务,工具或库之后完全命名插件,除非由正式表示Web服务,工具或库的人员提交。特别是如果这个插件涉及到这个东西。同样的,你不能用别人的商标用语开始插件。

有创意,想出你自己独特的名字。

##我已经有了一个插件,但是我想重做它!我只是再次提交,对吧?

我们宁愿你实际上只是重写现有的插件。使其成为主要版本。我们不能重命名插件,所以一个新的不会覆盖任何现有的用户,评论,支持主题,评级,下载,收藏夹等。

##我犯了一个错误,提交了一个错误名称的插件。我该怎么解决?

电邮plugins@wordpress.org并解释情况。我们可以关闭插件,让您重新提交,也可以更改显示名称。在我们批准任何事情之前,我们试图在名字中打错字,但是我们也犯错误。

#使用SVN存储库

##在什么目录我应该把我的文件?

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

确保更新trunk / readme.txt以反映新的stable标签。

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

##不能把我的文件放在trunk /的子目录中?

你可以,但不要。 WordPress.org Plugin Directory创建的.zip文件将自动将所有文件包装在目录中,因此无需将文件放入子目录中。

如果您有很多文件的复杂插件,您当然可以将它们组织到子目录中,但是readme.txt文件和根插件文件应该直接进入trunk /。

##我应该如何命名我的标签(a.k.a.版本)?

您的Subversion标签应该看起来像版本号。具体来说,它们应该只包含数字和句点。 2.8.4是一个很好的查找标签,我的内容是一个不好看的标签。不灵活?对。易于处理和消毒?你打赌!我们建议您使用语义版本控制来跟踪版本。

请注意,我们正在谈论Subversion标签,而不是readme.txt标签。那些显然可以是你喜欢的任何单词。

##我的更改日志应该是什么?

更改日志是对插件进行的所有或所有显着更改的日志或记录,包括更改的记录,如错误修复,新功能等。如果需要帮助格式化更改日志,我们建议使用保留更改日志作为所使用的格式由许多产品在那里。

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

始终保持更改日志中的当前主要版本。例如,如果您当前的版本是3.9.1,那么您将需要更改日期和3.9。旧版本应该被删除并迁移到changelog.txt文件。这将允许用户访问它们,同时保持您的自述文件更短和更相关。最多可以在自述文件的更新日志中保留最新版本的插件和一个主要版本。您的changelog.txt将不会显示在WordPress.org插件目录中,但没关系。大多数用户只想知道新功能。

##我可以指定我的插件版本的WordPress.org插件目录应该使用什么?

是的,通过在中继线目录的readme.txt文件中指定“稳定标签”字段。

WordPress.org插件目录在哪里可以获取其数据?

从您在插件文件和readme.txt文件中以及从Subversion存储库本身指定的信息。

阅读关于readme.txt如何工作的更多信息。

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

对于YouTube和Vimeo视频,只需在描述中将视频链接自行粘贴到一行。请注意,视频必须设置为允许嵌入才能使嵌入进程工作。

对于由WordPress.com VideoPress服务托管的视频,请使用wpvideo短代码。短信也可以用于YouTube和Vimeo,如果需要,就像在WordPress中一样。

##我对SVN信息库做了一些修改。 WordPress.org插件目录需要多长时间来反映这些更改?

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

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

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

##如何为我的插件页面制作酷炫的横幅之一?

您可以通过将正确命名的文件上传到assets文件夹中来创建自己的插件头。

阅读关于插件标题的更多信息。

##如何制作插件图标?

您可以通过将正确命名的文件上传到资产文件夹中来创建自己的插件图标。

阅读有关插件图标的更多信息。

##支持论坛

##如何获得论坛帖子的通知?

转到https://wordpress.org/support/plugin/YOURPLUGIN并向下滚动到帖子列表的底部。在那里,您将看到RSS链接的选项,以及注册电子邮件。

电子邮件/ rss的注册链接

点击订阅链接的电子邮件,或使用您最喜爱的阅读器中的RSS链接。

##如何获得所有我的插件的通知?

如果您正在跟踪WordPress论坛,请https://wordpress.org/support/view/plugin-committer/YOURID将列出您提交访问的任何插件的所有支持请求和评论。

不是一个comitter,只是有人列为作者?使用https://wordpress.org/support/view/plugin-contributor/YOURID

那些只是RSS。如果您需要电子邮件,请访问https://profiles.wordpress.org/YOURID/profile/notifications/并输入您要发送电子邮件的条款。

#封闭插件
##如何关闭我的插件?

如果你要求你的插件被删除,你不会得到它,除非你可以证明你的情况。通过请求关闭插件是永久性的。

从提交访问和链接到您的插件的帐户电子邮件plugins@wordpress.org。如果您的电子邮件与提交访问插件的人不匹配,您将被要求从其他电子邮件发送。

##当插件关闭时会发生什么?

当插件关闭时,插件的前端URL重定向到主插件目录,并且不再生成拉链。没有人能够通过网站下载插件,也不能通过WordPress管理员安装它。根据目录的原则,SVN存储库将保持可访问,以允许其他人下载并分支代码(如果需要)。

##为什么我的插件关闭?

这是违反指南,您在.org系统上的行为或安全问题。在所有情况下,您应该已经收到plugins@wordpress.org的电子邮件,解释为什么。

##为什么别人的插件关闭?

我们不宣传为什么我们关闭插件到插件开发人员和WordPress核心开发人员。不要打扰问。这是为了安全起见。如果我们宣布为什么我们关闭一个插件,每个人都会知道漏洞。如果我们选择不说“这是为了安全”,那么每当我们说“我们不能告诉你”,世界就会知道这是为了安全。基本上,这样做会使事情变得更安全。

##可以让别人的插件关闭吗?

如果您在plugins@wordpress.org的插件中报告安全问题或违规指南,我们将审核该报告并采取适当的措施。大多数情况下,这涉及到关闭一个插件。

有人张贴了我的插件的副本!我该怎么办?

电子邮件plugins@wordpress.org与被盗插件的链接,以及链接到我们可以下载或附加zip的链接。我们将比较两个文件,以及我们拥有的所有编码历史,以确定插件是否确实是盗窃,或者仅仅是一个未认证的分支。请记住,如果您将插件授权为GPLv2或更高版本,则只要版权保持原样并被记录,则完全可以将您的工作分叉。

##如何发送安全报告?

电子邮件plugins@wordpress.org一个清晰简明的说明的问题。确保解释你如何验证这是一个漏洞(链接到插件列表上的网站,如secunia.com是完美的)。如果您提供的报告链接,请勿删除!我们将直接传递给插件的开发人员。

##我可以在一个插件中找到一个bug吗?

我们与任何错误奖励计划没有关系,所以我们不会向您提交报告等。我们工作的唯一一个是hackerone.com/automattic,这是与Automattic属性相关的错误。一切都是你自己的,不要求我们提交事情。

你是否帮助文件或提供CVE?

不,我们目前没有能力协助。

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

也许。如果由于安全原因而关闭,请解决问题,回复电子邮件,大部分时间我们将重新打开该插件。如果违反准则的行为接近,则取决于违规行为的严重程度和性质。例如,重复违规者不太可能重新打开插件,而不是第一次使用。

如果你要求插件关闭,你会被期望解释为什么心脏变化。插件打算在开发者要求时保持关闭,并且一个月后不再重新打开。

#插件所有权

##如何让别人访问我的插件?

如果要将用户添加为提交者,那么可以访问更新代码,您需要访问https://wordpress.org/plugins/YOURPLUGIN/admin并将其用户名添加为提交者。

如果您希望他们作为作者出现,您将需要将其用户名添加到readme.txt文件。

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

任何有提交访问权限的人都可以做到转到https://wordpress.org/plugins/YOURPLUGIN/admin并将其悬停在其ID上。将显示删除链接。点击它。

##如何接管一个废弃的插件?

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

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

我们不保证将被给予任何人的插件。

##如果插件开发人员死了会怎么样?

当开发人员决定死亡时,他们将从他们自己的插件中删除,以防止不道德的访问和损害用户。如果他们是唯一的开发人员,则该插件是关闭的。所有的尝试都是找到他们的朋友和同事,为他们提供一个首先采用代码的机会,但是如果没有人可靠或愿意可以找到该插件被关闭。