README

根据插件文件获取插件信息。

简介

根据插件文件获取插件信息。

入门

要开始使用，请按照以下安装部分中的说明安装包。

要使用该工具，请参阅使用部分。

安装

使用composer安装

composer require morningtrain/wp-plugin-info

使用

初始化

要开始，请注册插件文件；

// plugin.php
require __DIR__ . "/vendor/autoload.php";

$plugin_info = Morningtrain\WP\PluginUpdater\PluginInfo::register(__FILE__);

设置路径别名

您可以通过在插件头部设置“Plugin Slug”头来设置别名。或者，您也可以通过在“PluginInfo”实例上调用“setSlug”方法来设置别名。这有助于以后获取您插件的信息。

设置命名路径

您可以设置一个命名路径，稍后可以使用它来获取路径。它必须是绝对路径。您可以在插件文件夹或其他任何地方设置路径。

$plugin_info->setNamedPath('app', __DIR__ . '/app');
$plugin_info->setNamedPath('logs', WP_CONTENT_DIR . '/logs');

设置命名URL

您可以设置一个命名URL，稍后可以使用它来获取URL。它必须是绝对URL。您可以在插件文件夹或其他任何地方设置URL。

$plugin_info->setNamedUrl('images', $plugin_info->getRootUrl() . 'public/iamges');
$plugin_info->setNamedUrl('invoices', content_url('private/invoices'));

设置命名参数

您可以设置一个命名参数，稍后可以使用它来获取参数。您可以为与您的插件相关的任何内容设置。

$plugin_info->setNamedParameter('license', $license);

检索PluginInfo实例

您可以通过在“PluginInfo”类上使用“get”方法来检索PluginInfo实例。

$plugin_info = Morningtrain\WP\PluginUpdater\PluginInfo::get('pluginSlug');

检索信息

贡献

感谢您对参与项目的兴趣。

错误报告

如果您发现了一个错误，我们鼓励您提交一个pull request。

要添加错误报告，创建一个新的问题。请记住添加一个描述性的标题、详细的描述以及如何重现问题的说明。

支持问题

我们不为此包提供支持。

拉取请求

fork该项目
创建您的功能分支（git checkout -b feature/AmazingFeature）
提交您的更改（git commit -m '添加一些AmazingFeature'）
推送到分支（git push origin feature/AmazingFeature）
打开pull request

贡献者

许可证

MIT许可证（MIT）。有关更多信息，请参阅许可证文件。

开发者

morningtrain / wp-plugin-info

维护者

详细信息