awsmug/torro-forms-plugin-boilerplate
Torro Forms 插件模板。
1.0.0
2018-03-07 22:16 UTC
Requires
- php: >=5.6.0
- composer/installers: ~1.0
Requires (Dev)
- phpunit/phpunit: >4.8.20 <6.0
- squizlabs/php_codesniffer: 3.*
- wimg/php-compatibility: ^8
- wp-coding-standards/wpcs: 0.14.*
This package is auto-updated.
Last update: 2024-09-07 19:40:52 UTC
README
Torro Forms 插件模板
这是一个 Torro Forms 扩展的插件模板。在构建任何 Torro Forms 扩展时,强烈建议使用此模板。
开始使用
要创建自己的插件,请下载此仓库。接下来,假设您的插件应称为 Torro Super Extension
。
- 将目录重命名为
torro-super-extension
。 - 将插件主文件重命名为
torro-super-extension.php
。 - 打开
gulpfile.js
并滚动到页面底部。 - 将
replacements
对象中的每个值替换为您新的插件名称或插件作者数据,格式适当。例如,将my-new-plugin-name
替换为torro-super-extension
,将MY_NEW_PLUGIN_NAME
替换为TORRO_SUPER_EXTENSION
等等。将插件命名空间供应商、插件 URL、作者名称、作者电子邮件和作者 URL 替换为您相应数据。 - 保存更改。
- 在控制台中运行
npm install
。 - 在控制台中运行
gulp init-replace
。 - 再次打开
gulpfile.js
并删除从INITIAL SETUP TASK
开始的整个底部部分,然后保存文件。 - 检查
composer.json
和package.json
文件。您可能需要根据您的偏好更新一些详细信息。 - 检查
gulpfile.js
顶部的config
对象。您可能需要根据您的偏好更新一些详细信息。 - 运行
gulp build
一次以编译所有内容。
现在您可以开始了!还有一件事:如果您想将插件发布到 wordpress.org,建议您删除 /languages
目录,并将 config.domainPath
设置为 false
,然后从 gulpfile.js
中删除 pot
任务。然后,根据需要从 Extension::load_textdomain()
方法中删除现在不再需要的参数。
实际开发
调整 src/extension.php
文件以满足您的需求。这是您的扩展将被启动的地方。您可以在其中实例化扩展所需的服务,设置钩子(然后将被 Torro Forms 主插件自动调用)等。
模板中的所有其他类和资源都是可选的,仅作为示例代码。请注意,您应坚持使用模板中使用的目录结构 - 它是针对 Torro Forms 基础插件定向的。
常见 Gulp 任务
gulp sass
:编译 CSS/Sassgulp js
:编译 JavaScriptgulp pot
:刷新 POT 文件gulp header-replace
:用最新数据替换插件标题gulp readme-replace
:用最新数据替换说明中的标题和描述gulp build
:运行上述所有任务