README

入门插件

YOOtheme 入门套件为构建您的下一个 YOOtheme Pro 扩展提供了一个最小和简单的起点。轻松为 YOOtheme Pro 创建模块以扩展其功能。例如，向自定义设置添加设置面板、向页面构建器添加元素或将所需资产文件加载到站点中。根据应用程序的需求定制模块后，自动构建 Joomla 插件和 WordPress 插件以分发到您的客户项目。

要求

安装 Composer v2.5+，它用于安装 PHP 包。

此外，使用 Node 和 npm 安装 Task，这是运行构建任务所需的。

npm install -g @go-task/cli

创建新插件

要创建新插件，请在 WordPress 的插件文件夹（wp-content/plugins）或 Joomla 的插件文件夹（plugins/system）中运行以下命令，具体取决于您偏好的开发环境。将 PLUGIN_NAME 替换为您的插件名称，例如 myplugin。

composer create-project yootheme/starter-plugin PLUGIN_NAME

您将需要提供额外的插件信息，这些信息将用于插件元数据。

输入插件标题：插件标题，例如 My Plugin
输入插件描述：插件描述
输入作者名称：作者名称
输入作者电子邮件：作者电子邮件
输入作者网址：作者网址，例如 https://example.com
输入更新服务器网址：更新服务器文件网址，例如 https://example.com/updates

这将创建一个新的 myplugin 目录，其中包含所需的插件文件。

.
├── build                   # Plugin blueprint files
│   ├── joomla
│       ├── myplugin.php   # Joomla plugin
|       ├── myplugin.xml   # Joomla plugin metadata
│   ├── wordpress
│       ├── myplugin.php   # WordPress plugin
├── .env                   # Metadata
├── vendor                 # Development dependencies
├── README.md
└── Taskfile.yml           # Tasks

设置插件

在终端中打开您的新插件文件夹，并使用以下任务之一将必要的插件文件从 build 文件夹复制到插件根目录。

task setup-wordpress
task setup-joomla

现在该插件可以在 WordPress 或 Joomla 中被发现和安装。

创建新模块

要创建新模块，请运行以下命令，并将 MODULE_NAME 替换为您的模块名称，例如 my-module。

composer create:module MODULE_NAME

您将需要进一步的问题来配置模块。

输入模块命名空间：输入 PHP 命名空间，例如 MyPlugin\MyModule
添加资产文件示例？[y/N] 按回车键选择否。
添加设置示例？[y/N] 按回车键选择否。
添加自定义 LESS 示例？[y/N] 按回车键选择否。
添加自定义源示例？[y/N] 按回车键选择否。
添加翻译文件示例？[y/N] 按回车键选择否。

阅读模块文档了解有关创建的文件和代码示例的更多信息。

注意：对于系统特定的模块，请将 wordpress 或 joomla 添加到名称中，例如 my-module-wordpress 或 my-module-joomla。构建任务只会将相关的模块复制到 WordPress 和 Joomla 的 zip 存档中。

创建新元素

要创建新元素，请运行以下命令，并将 ELEMENT_NAME 替换为您的元素名称，例如 my-element。如果有多个模块，请选择提供的列表中的一个模块。

composer create:element ELEMENT_NAME

可选地定义创建元素应使用的模块。

composer create:element ELEMENT_NAME MODULE_NAME

您将需要进一步的问题来配置元素。

输入元素标题：元素标题，例如 My Element
输入元素组：按 Enter 键选择 Custom。
创建多个项目元素？ [y/N] 按 Enter 键选择 No。

阅读元素文档以了解更多关于创建的文件和代码示例的信息。

构建分发文件

要为 WordPress 和 Joomla 创建插件的安装可压缩存档，请运行以下任务。创建的 zip 文件位于 dist 文件夹中。

task build

或者，单独创建存档。

task build-wordpress
task build-joomla

发布和版本控制

要提升插件版本号或更改插件标题或描述等元数据，请打开 .env 文件并编辑选项。

TITLE='My Plugin'
NAME='myplugin'
VERSION='0.0.1'
DESCRIPTION='Lorem ipsum'
DATE='{{ now | date "2006-01-02" }}'
COPYRIGHT='Copyright (C)'
LICENSE='GNU General Public License'
AUTHOR='My Company'
AUTHOREMAIL='me@example.com'
AUTHORURL='https://example.com'

之后，重新运行设置任务以更新开发环境中的插件（WordPress 或 Joomla），并运行构建任务以创建分发文件。

更新服务器

要启用 WordPress 和 Joomla 的单击更新，构建任务会生成必要的更新服务器文件，WordPress 的 dist/update.json 和 Joomla 的 dist/update.xml。这些文件基于 .env 文件中的包信息进行配置。

# Update server
UPDATEURI='https://example.com/updates'

# Package information
TYPE='plugin'
STABILITY='stable'
DOWNLOADURL='https://example.com/downloads'
PHPMINIMUM='7.4'
JOOMLAMINIMUM='(5\.[01]|4\.[01234]|3\.10)\.'
WORDPRESSMINIMUM='6.2'

将这些文件上传到 UPDATEURI URL。这是您的插件检查更新和检索相关下载文件的位置。确保将 dist 文件夹中的 zip 存档上传到 DOWNLOADURL 中指定的位置。

更新命令和任务

命令和任务脚本有自己的 starter-utils Github 仓库。要更新包到最新版本，请定期运行 composer update。

Github

要将插件作为 Git 仓库使用，请运行 git init -b main 并遵循将本地仓库添加到 GitHub 使用 Git 下的步骤。

许可协议

MIT

yootheme/starter-plugin

维护者

详细信息