在 Marketplace 中列出插件

Note

您是否已经为 Mautic 的先前版本开发了插件？请参阅下面的 Updating existing Plugins for usage with the Marketplace 部分。

准备您的插件以用于 Marketplace

Warning

非常重要的是，您必须仔细遵循以下步骤。例如，bundle 名称中的拼写错误可能会导致 Mautic 崩溃，并要求用户执行一些命令行操作才能恢复到正常状态。

在您创建插件时，有一些要求需要验证，以便将其列在 Mautic Marketplace 中。

第一步：检查您的 `composer.json` 文件

第一个重要的步骤是验证您的 composer.json 文件是否包含所有必需的信息。

这是一个示例 composer.json 文件：

{
    "name": "example-vendor/plugin-example",
    "description": "Example Plugin",
    "type": "mautic-plugin",
    "license": "GPL-3.0-or-later",
    "keywords": ["mautic","plugin","integration"],
    "extra": {
        "install-directory-name": "ExampleBundle"
    },
    "require": {
        "php": ">=8.0 <8.1",
        "ext-zip": "^1.15",
        "mautic/core-lib": "^5.0"
    }
}

除了您在插件的 composer.json 文件中已经拥有的信息之外，请添加以下内容：

type 必须具有值 mautic-plugin。 Marketplace 会根据此标签过滤 PHP 包。必须将其显示在 Marketplace 中。
extra.install-directory-name 指定 bundle 的目录名称。正确的目录名称对于 PSR4 自动加载非常重要。它必须与您 PHP 类中的命名空间相同。
require.php 请务必指定您针对其进行插件测试的 PHP 版本范围。理想情况下，它应该与 Mautic 的 Mautic supported PHP versions 相同。不要允许用户在不受支持的版本上安装该插件。
require.ext-* 如果您的插件需要某些 PHP 扩展，请将其列在 require 部分中。由于服务器可以启用各种扩展，这可确保可用正确的扩展。
require.mautic/core-lib 重要的是要指定您的插件支持哪些 Mautic 版本。仅包含您或您的社区已测试并确认该插件与之兼容的版本。

第二步：验证最佳实践

在为 Mautic 创建插件时，有一些事情是强烈推荐的。请参阅最佳实践页面以获取更多详细信息。

第三步：发布您的包

当 composer.json 文件准备就绪后，请按照 Packagist 中的 Packagist 部分进行操作。

第四步：申请加入白名单

虽然 Mautic 市场仍在测试阶段，但您需要申请加入白名单才能在市场上展示您的应用。请参考 Allow list: what is it and why is it needed? 页面以获取更多详细信息。

更新现有插件以用于市场

如果您过去在插件的依赖项中使用了 mautic/composer-plugin，请将其移除。对 Mautic 插件的支持现在已内置于 Composer 中，因此您只需将类型设置为 mautic-plugin，Composer 将自动将您的插件安装到 plugins 文件夹中。

此外，如果您最初为 Mautic 4 构建了您的插件，请阅读 UPGRADE-5.0.md guide 以了解 Mautic 5 中的重大更改。

完成后，您可以返回本文档中的 Preparing your Plugin for the Marketplace 部分，并从那里继续操作。