向 WordPress 官方插件目录提交插件,是一个对代码质量和安全性有较高要求的过程,有一套比较成熟的规范和流程。下面我帮你梳理了核心要求和具体步骤,可以照着一步步来。
核心要求:提交前的必要准备
在动手提交之前,需要先确保你的插件满足官方的一系列硬性要求,否则很可能会在审核中被驳回。
开源许可证:插件必须兼容 GNU General Public License v2 或更高版本。官方强烈建议直接使用与WordPress相同的"GPLv2 or later"许可证。
代码规范与安全:这是审核中最容易被卡住的地方。代码需要遵循WordPress编码标准,并特别注意三个最常见的驳回原因:
未转义的输出:需要对所有动态输出的数据进行转义(Escaping)。
未过滤的数据:需对所有用户输入或外部数据进行过滤(Sanitizing)。
缺少Nonce验证:在处理表单数据时必须使用Nonce进行安全验证。
功能完整可用:提交的插件必须是可直接使用的完整版本,不接受占位符或半成品。同时,插件中不能包含限制功能、需要付费解锁的"试用版"模式。
尊重用户:
不能在未经用户明确许可的情况下,收集或追踪用户数据。
插件自带的前端"Powered By"等外链和宣传,默认必须是关闭的,需要用户主动开启才能显示。
无商标侵权:插件名称不能包含已注册的商标词汇,以避免法律纠纷。
详细步骤:从提交到发布
整个流程大致可以分为准备、提交、审核和上线几个阶段。
第一步:准备阶段
注册账号:首先需要去 WordPress.org 官网注册一个账号,后续所有操作都将基于此账号。
自我检查:提交前,强烈建议用官方的 Plugin Check 工具扫描一下插件,它能帮你提前发现很多常见问题。
第二步:正式提交
访问提交页面:登录后,访问插件提交专用页面:https://wordpress.org/plugins/developers/add/。
上传插件:将你的插件打包成 .zip 格式(注意大小需在 10MB 以内)并上传。
确认插件标识(Slug):系统会根据你主文件中的"Plugin Name"自动生成一个唯一的插件标识符(slug),它将作为插件URL的一部分。一旦插件被批准,这个slug将永久无法更改,所以选择时请慎重。
第三步:等待审核
手动审核:提交后,插件会进入一个审核队列,由官方的审核团队进行人工审查。这个过程通常需要 1到10天,官方目标是在5个工作日内完成,但根据插件的复杂度,可能需要更久。
处理反馈:如果审核发现问题,你会收到一封来自 plugins@wordpress.org 的邮件,告知你需要修改的地方。请直接回复那封邮件,不要重新提交,并在修复后耐心等待。官方团队全是志愿者,回复可能需要一些时间。
第四步:发布与维护
获得SVN仓库:一旦插件通过审核,你将被授予一个专属的 Subversion (SVN) 仓库访问权限,这是插件未来的"家"。
上传代码:你需要使用SVN将你的插件代码提交到这个仓库。除了主代码文件,还必须在插件根目录包含一个符合规范的 readme.txt 文件,用于生成插件在目录页面的描述。
正式上线:代码上传后不久,你的插件页面就会在 WordPress 官方插件目录中自动生成并公开。之后,每当发布新版本,都需要通过SVN更新代码,并同时更新 readme.txt 中的版本号,用户就能收到更新通知了。
这个过程虽然稍显复杂,但能确保插件目录的整体质量和安全性。如果你的插件有独特的页面或功能,也可以在插件描述中告诉我,我来帮你优化一下readme.txt的写法,让它更吸引人。