README

创建WordPress插件

这是一个骨架WordPress插件，可以构建WordPress插件。此模板包括基础插件文件、自动加载的PHP文件、由Mantle提供的单元测试、通过Webpack编译的前端资源，以及通过GitHub Actions的持续集成。操作配置为测试插件并构建发布版本。构建标签工作流程将创建*-built分支以及一个自动构建和标记/发布插件的发布工作流程。构建分支和发布将包括任何编译的前端资源（如果使用它们）。

插件支持前端资源，可以在src/assets.php或入口点文件index.php内部进行队列。对于不需要前端资源的插件，以下配置脚本将提示您删除前端文件，如果您不想使用它们。

入门

按照以下步骤开始

1. 在此存储库顶部按下“使用模板”按钮，以创建一个包含此骨架内容的新存储库。
2. 运行make（或php ./configure.php）以运行一个脚本，该脚本将替换所有文件中的占位符。
3. 享受创建您的插件！ 🎊

创建WordPress插件

贡献者：author_username

标签：vendor_name, create-wordpress-plugin

稳定标签：0.0.0

至少需要：5.9

测试到：6.1

需要PHP：8.1

许可证：GPL v2或更高版本

WordPress插件骨架。

安装

您可以通过Composer安装此软件包

composer require alleyinteractive/create-wordpress-plugin

用法

在WordPress中激活插件并按以下方式使用它

$plugin = Create_WordPress_Plugin\Skeleton\Example_Plugin();
$plugin->perform_magic();

测试

运行npm run test以在JavaScript文件上运行Jest测试。运行npm run test:watch以保持测试运行器打开并监视更改。

运行npm run lint以在所有JavaScript文件上运行ESLint。在运行开发或生产构建时也会进行linting。

运行composer test以运行PHPUnit和插件中的PHP代码的测试。单元测试代码以PSR-4格式编写，可在tests目录中找到。

目录和入口点

在entries目录中创建的所有目录都可以作为入口点，并将使用@wordpress/scripts编译到build目录中，并附带相应的index.asset.php资源映射。

构建入口点

要生成新的入口点，请运行以下命令

npm run create-entry

要生成新的slotfill，请运行以下命令

npm run create-slotfill

该命令将引导用户通过创建入口点或slotfill的几个选项。入口点使用@alleyinteractive/create-entry脚本进行构建。运行帮助命令以查看所有选项

npx @alleyinteractive/create-entry --help

访问包README以获取更多信息。

队列入口点

您还可以在入口目录中包含一个 index.php 文件，用于排队或注册脚本。然后，该文件将被移动到构建目录，并在 functions.php 文件中使用 load_scripts() 函数自动加载。或者，如果脚本需要在其他地方排队，src/assets.php 文件中有一些辅助函数用于获取资源。

使用 create-block 构建动态块

使用 create-block 命令和 @alleyinteractive/create-block 脚本创建自定义块，并按照提示在 blocks/ 目录中生成所有块资源。块注册、脚本创建等将由 create-block 脚本自动构建。运行 npm run build 编译和构建自定义块。块使用 src/assets.php 中的 load_scripts() 函数排队。

更新 WP 依赖项

将项目中使用的 WordPress 依赖包 更新到最新版本。

要更新 @wordpress 依赖项到最新版本，请使用 packages-update 命令

npx wp-scripts packages-update

此脚本提供以下自定义选项

• --dist-tag – 在更新 npm 包时允许指定自定义 dist-tag。默认为 latest。这在使用 @wordpress/dependency-extraction-webpack-plugin 时特别有用。它允许在本地测试等情况下安装给定 WordPress 主要版本使用的 npm 依赖项版本。示例

npx wp-scripts packages-update --dist-tag=wp-WPVERSION`

其中 WPVERSION 是您要针对的 WordPress 版本。版本必须包含主版本和次要版本（例如，6.1）。例如

npx wp-scripts packages-update --dist-tag=wp-6.1`

发布插件

该插件使用 编译发布工作流程 编译和标记发布。每当在根目录的 composer.json 文件或插件的标题中检测到新版本时，该工作流程将自动构建插件并使用新版本标记它。构建标记将包含插件可能需要的所有必需的前端资源。这对于发布到 WordPress.org 或子模块化都很有用。

当您准备好发布插件的新版本时，可以运行 npm run release 来启动设置新发布的流程。

更改日志

有关最近更改的更多信息，请参阅 CHANGELOG。

致谢

此项目由 Alley Interactive 积极维护。喜欢您看到的内容？加入我们工作。

• 作者名称
• 所有贡献者

许可证

GNU 通用公共许可证（GPL）。有关更多信息，请参阅 许可证文件。