juvo/wordpress-plugin-boilerplate

WordPress插件开发模板。配备bud.js、自动加载和PHPStan，功能强大。

维护者

详细信息

github.com/JUVOJustin/wordpress-plugin-boilerplate

来源

问题

安装: 170

依赖: 0

建议者: 0

安全: 0

星标: 4

关注者: 1

分支: 0

开放问题: 4

1.0.18 2024-09-13 20:35 UTC

Requires

  • php: >=8.0

Requires (Dev)

GPL-3.0-or-later 92746c1574b573bae5c94e34b631045a4e3f38b0

This package is auto-updated.

Last update: 2024-09-17 06:57:47 UTC

README

此模板是从 WordPress Boilerplate 分支出来的，但增加了一些功能和改进。这是一个现代、有组织且面向对象的框架，用于构建高质量的WordPress插件。

此模板的特点

  • 使用composer支持命名空间
  • 使用Strauss自动进行命名空间前缀
  • 通过loader轻松注册短代码、CLI命令
  • 使用现成的GitHub Actions配置PHPStan
  • 使用现成的GitHub Actions配置PHPCS
  • Bud.js，用于简单的资源打包和构建
  • 内置ESLint
  • 现成的GitHub Actions，用于构建和打包

设置

步骤1：创建您的项目

运行以下命令以创建您的项目。这将下载模板并自动运行脚本进行初始配置

composer create-project juvo/wordpress-plugin-boilerplate path/to/your-new-plugin

步骤2：配置您的插件（自动提示）

项目创建后，您将通过一系列提示来配置您的插件

  • 插件名称：输入您的插件名称。
  • 命名空间（可选）：根据您的插件名称建议默认命名空间，但允许自定义。
  • 插件短名称（可选）：为您的插件选择一个短名称；建议默认名称基于您的插件名称。

您的输入将自动调整模板以匹配您的插件身份。

步骤3：最终化（可选）

配置后，设置将通过更新文件、重命名相关项和执行清理操作来完成，包括

  • 用您指定的详细信息替换占位符。
  • 将文件重命名为与您的插件命名空间和短名称匹配。
  • 运行composer update和npm install以安装依赖项。
  • 通过删除setup.php文件进行清理。

到此为止，插件已设置完毕，准备就绪。现在您可以按照需要更改插件和readme标题。

总结

就这样！您的插件现在已准备好开发。轻松高效地开始创建下一个令人瞩目的WordPress插件。