personare/plugin-boilerplate

Personare插件模板。

维护者

详细信息

github.com/Personare/plugin-boilerplate

源代码

问题

安装: 8

依赖项: 0

建议者: 0

安全: 0

星级: 2

关注者: 4

分支: 1

开放问题: 23

类型:wordpress-plugin

v2.0.0 2020-10-27 18:05 UTC

Requires

Requires (Dev)

GPL-2.0-only 8c22b76bead0e012039a9964fb230b091e51ff64

This package is auto-updated.

Last update: 2024-09-06 14:34:21 UTC

README

此插件旨在作为模板使用，主要用于从头开始创建WordPress插件时，但已具有明确的结构，适用于单元测试，代码静态分析器和依赖注入容器。

需求

  • PHP >= 7.3
  • Composer

自动发布

此项目有一个语义发布操作，每次向master分支推送时都会运行以检查是否需要生成新的发布版本，它将遍历提交以检查是否符合约定提交格式。

重要：进行squash提交时，必须将squash消息修改为符合约定提交格式的消息，否则将不会自动生成发布版本。

快速入门

  1. 进入wp-content/plugins。
  2. 执行composer create-project personare/plugin-boilerplate nome-do-seu-novo-plugin。
  3. 重命名字符串.
  4. 激活您的全新插件。

别忘了重命名

将以下所有字符串重命名为您正在开发的项目中具有意义的名称。

  • MY_APP_
  • MyApp
  • my-app
  • plugin-boilerplate
  • GPL-2.0-only

脚本

  • composer ci将执行CI中所有重要的脚本，如果您想单独运行它们，请参考composer.json；
  • yarn lint将执行JavaScript + SASS的lint；
  • yarn build是生成bundle的命令；

在PHPStorm中将Phan配置为“外部工具”

  • 在首选项 -> 工具 -> 外部工具中点击添加新的工具。输入您认为最好的名称，将“run_phan.sh”脚本作为“程序”选择，并将项目目录作为“工作目录”选择，最后将“$FILE_PATH$:$LINE$”作为“输出过滤器”点击“高级选项”。您可以在工具 -> 外部工具中执行external tools。

如果出现权限错误，请在终端中执行chmod +x run_phan.sh。

使用示例

请参考src/WordPress/目录内的文件，您将找到如何在此结构中声明hooks的良好示例，如果您想注册CPT，请参考src/WordPress/Services/ExampleServiceProvider.php，如果需要注册分类法，请参考src/WordPress/Services/ExampleCategoryServiceProvider.php。