wp-forge/wp-plugin

使用Composer创建新的WordPress插件

维护者

详细信息

github.com/wp-forge/wp-plugin

源代码

问题

安装: 9

依赖项: 0

建议者: 0

安全: 0

星星: 1

关注者: 2

分支: 0

开放问题: 0

类型:wordpress-plugin

1.0.5 2023-11-03 19:33 UTC

Requires

GPL-2.0-or-later c9959c9e2e565c951e49bb1d33c6075a43468158

This package is auto-updated.

Last update: 2024-09-03 21:07:28 UTC

README

这是一个WordPress插件脚手架模板，可以通过Composer轻松安装。

需求

安装

在终端运行此命令

composer --remove-vcs create-project wp-forge/wp-plugin

请确保将目录名追加到命令末尾，以自定义项目安装的文件夹名称！

安装过程将检查您的环境所需的PHP版本和PHP扩展。如果出现问题并且您仍然想强制安装，只需将--ignore-platform-reqs标志添加到命令中。

备注

  • `.scripts`和`.templates`文件夹仅用于脚手架目的，在您的最终项目中不会存在。
  • 我们使用@wordpress/env包来提供本地开发环境。此包需要在您的机器上安装Docker。如果您不想使用Docker，可以删除package.json文件中的@wordpress/env包和删除.wp-env.json文件。
  • 我们使用钩子文件夹的概念。而不是在您的插件中散布许多WordPress钩子，`hooks`文件夹包含一个`actions`和`filters`文件夹，其中每个文件名对应于钩子的名称（除下划线外用短划线代替）。属于特定钩子的所有项目都添加到相应的文件中，使找到、编辑和以一致的方式添加钩子变得容易。
  • 此仓库有一个`source`文件夹，您可以在其中存储任何需要构建步骤的文件（例如scss和js）。`assets`文件夹是存储将在您的插件中使用的编译文件的文件夹。默认情况下，我们忽略assets/css和assets/js文件夹。
  • 目前，此模板不实现任何类型的构建过程。这是将来将添加的功能。
  • 此仓库创建一个.nvmrc文件。如果您使用NVM，您将能够运行nvm use来自动切换到此项目的正确版本Node。它将默认为安装时的Node版本。
  • 此模板为您创建GitHub Action工作流程。如果您要在WordPress.org插件目录中公开发布您的插件，您需要在GitHub存储库设置中添加SVN_USERNAME和SVN_PASSWORD环境变量。
  • 如果您的插件要公开发布，则使用`.wporg`文件夹来存储将上传到WordPress.org插件存储库的资产。

提醒

不要忘记

  • 运行git remote add origin <url>以添加您的远程存储库
  • 将SVN_USERNAME和SVN_PASSWORD环境变量添加到您的GitHub存储库设置中（如果您的插件要公开发布）
  • 通过运行git push -u origin master将代码推送到GitHub