awsmug/torro-forms-plugin-boilerplate

Torro Forms 插件模板。

1.0.0 2018-03-07 22:16 UTC

This package is auto-updated.

Last update: 2024-09-07 19:40:52 UTC


README

Build Status Code Climate Test Coverage Latest Stable Version License

Torro Forms 插件模板

这是一个 Torro Forms 扩展的插件模板。在构建任何 Torro Forms 扩展时,强烈建议使用此模板。

开始使用

要创建自己的插件,请下载此仓库。接下来,假设您的插件应称为 Torro Super Extension

  1. 将目录重命名为 torro-super-extension
  2. 将插件主文件重命名为 torro-super-extension.php
  3. 打开 gulpfile.js 并滚动到页面底部。
  4. replacements 对象中的每个值替换为您新的插件名称或插件作者数据,格式适当。例如,将 my-new-plugin-name 替换为 torro-super-extension,将 MY_NEW_PLUGIN_NAME 替换为 TORRO_SUPER_EXTENSION 等等。将插件命名空间供应商、插件 URL、作者名称、作者电子邮件和作者 URL 替换为您相应数据。
  5. 保存更改。
  6. 在控制台中运行 npm install
  7. 在控制台中运行 gulp init-replace
  8. 再次打开 gulpfile.js 并删除从 INITIAL SETUP TASK 开始的整个底部部分,然后保存文件。
  9. 检查 composer.jsonpackage.json 文件。您可能需要根据您的偏好更新一些详细信息。
  10. 检查 gulpfile.js 顶部的 config 对象。您可能需要根据您的偏好更新一些详细信息。
  11. 运行 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/Sass
  • gulp js:编译 JavaScript
  • gulp pot:刷新 POT 文件
  • gulp header-replace:用最新数据替换插件标题
  • gulp readme-replace:用最新数据替换说明中的标题和描述
  • gulp build:运行上述所有任务