laegel/wp-plugin-maker-cli

该包最新版本(0.2.0)没有可用的许可证信息。

wp-plugin-maker CLI

0.2.0 2018-05-07 21:27 UTC

This package is not auto-updated.

Last update: 2024-09-18 08:34:34 UTC


README

WP 插件制作器 CLI

安装

composer global require laegel/wp-plugin-maker-cli

是的,这是一个全局包,所以不要本地安装,也不要期望它能在本地工作!

在您的 $PATH 中配置 ~/.composer/vendor/bin 目录,以便全局使用。

命令

init

--name: 连字符小写的字符串,将用于创建插件文件夹名称。插件的主命名空间将从连字符小写转换为 WordPress 类命名约定(下划线大小写)

此命令将初始化一个干净的插件。必须在您的 WordPress 插件目录 中使用。

generate

--name: 下划线大小写的字符串,将用作类名。将追加 "_Controller" 到名称。 [--folder]: 控制器将要保存的文件夹。可以是 "All"(默认值)、"Admin"、"Front"、"CLI" 或 "Rest"。 [--type]: 控制器类型。可以是 "controller"(默认值)或 "custom_type"。

您可以使用此命令生成新的控制器/自定义类型。必须在您的生成的插件目录中使用。

build

要逐个生成操作/过滤器文件,请使用 build。必须在您的生成的插件目录中使用。

watch

要生成操作/过滤器文件并继续在您的插件上工作,请使用 watch。必须在您的生成的插件目录中使用。

生成结构

my-plugin
|-- .gitignore
|-- composer.json
|-- plugin.php
|-- require-admin.php (after build)
|-- require-cli.php (after build)
|-- require-front.php (after build)
|-- require-rest.php (after build)
|-- wpm-info.php
|-- src
|   |-- Admin
|   |   |-- (empty)
|   |-- All
|   |   |-- (empty)
|   |-- CLI
|   |   |-- (empty)
|   |-- Front
|   |   |-- (empty)
|   |-- Rest
|   |   |-- (empty)
|   |-- Plugin.php
|   vendor
|   |-- (packages)

其他文件是什么?

  • .gitignore: 由于您可能使用 Git 保存项目,此文件已经生成。真体贴心!
  • composer.json: 您的插件将准备好使用 Composer(但您不需要在 Packagist 上注册它,多亏了 WP-Packagist
  • plugin.php: 插件初始化文件,其中保存了您的插件元数据。您可以更新元数据,但除非您真的知道自己在做什么,否则不应更改其他内容(不要更改)。
  • wpm-info.php: 奇怪文件!但它被 WPM CLI 用于生成文件。也许还有其他东西。您可以使用它来保存一些特殊的插件数据(例如版本,如果您不忘记同步它)