eliasis-framework / wp-plugin-info
此包已被废弃,不再维护。未建议替代包。
从WordPress API获取并保存插件信息,以供其他模块使用。
1.0.4
2018-03-01 15:37 UTC
Requires
- php: ^5.6 || ^7.0
- composer/installers: ^1.4.0
- eliasis-framework/complement: ^1.1.1
- eliasis-framework/eliasis: ^1.1.3
Requires (Dev)
- dealerdirect/phpcodesniffer-composer-installer: ^0.4.3
- friendsofphp/php-cs-fixer: ^2.3 || ^2.8
- phpmd/phpmd: ^2.6
- phpunit/phpunit: ^5.7 || ^6.0
- squizlabs/php_codesniffer: ^3.2.2
- wp-coding-standards/wpcs: ^0.14
README
从WordPress API获取并保存插件信息,以供其他模块使用。
要求
此插件支持PHP版本5.6或更高版本,并兼容HHVM版本3.0或更高版本。
安装
安装此插件的首选方式是通过 Composer。
要安装 WP Plugin Info,请简单执行以下命令
composer require eliasis-framework/wp-plugin-info
前面的命令只会安装必要的文件,如果您想 下载整个源代码,可以使用
composer require eliasis-framework/wp-plugin-info --prefer-source
您还可以使用 Git 克隆整个仓库
git clone https://github.com/eliasis-framework/wp-plugin-info.git
可用方法
此插件中的可用方法
- 获取插件信息
get($option, $slug);
属性 | 描述 | 类型 | 必需 |
---|---|---|---|
$option | 获取选项。 | string | 是 |
$slug | WordPress插件slug。 | string | 是 |
返回值: (mixed) → 值或false。
快速入门
要使用此插件与 Composer
use Eliasis\Complement\Type\Plugin; $wp_plugin_info = Plugin::WP_Plugin_Info()->getControllerInstance('Main');
用法
- 获取插件名称
# [string] $wp_plugin_info->get('name', 'plugin-slug');
- 获取插件版本
# [string] $wp_plugin_info->get('version', 'plugin-slug');
- 获取插件作者
# [string] $author = $wp_plugin_info->get('author', 'plugin-slug');
- 获取插件作者资料
# [string] $wp_plugin_info->get('author_profile', 'plugin-slug');
- 获取插件贡献者
# [array] $wp_plugin_info->get('contributors', 'plugin-slug');
- 获取插件要求
# [string] $wp_plugin_info->get('requires', 'plugin-slug');
- 获取插件测试版本
# [string] $wp_plugin_info->get('tested', 'plugin-slug');
- 获取插件兼容性
# [array] $wp_plugin_info->get('compatibility', 'plugin-slug');
- 获取插件评分
# [int] $wp_plugin_info->get('rating', 'plugin-slug');
- 获取插件评分列表
# [array] $wp_plugin_info->get('ratings', 'plugin-slug');
- 获取插件评分数量
# [int] $wp_plugin_info->get('num_ratings', 'plugin-slug');
- 获取插件支持线程
# [int] $wp_plugin_info->get('support_threads', 'plugin-slug');
- 获取插件支持线程已解决
# [int] $wp_plugin_info->get('support_threads_resolved', 'plugin-slug');
- 获取插件已下载
# [int] $wp_plugin_info->get('downloaded', 'plugin-slug');
- 获取插件最后更新
# [string] $wp_plugin_info->get('last_updated', 'plugin-slug');
- 获取插件已添加
# [string] $wp_plugin_info->get('added', 'plugin-slug');
- 获取插件主页
# [string] $wp_plugin_info->get('homepage', 'plugin-slug');
- 获取插件下载链接
# [string] $wp_plugin_info->get('download_link', 'plugin-slug');
- 获取插件标签
# [array] $wp_plugin_info->get('tags', 'plugin-slug');
- 获取插件捐赠链接
# [string] $wp_plugin_info->get('donate_link', 'plugin-slug');
测试
要运行测试,您只需要composer以及执行以下操作
git clone https://github.com/eliasis-framework/wp-plugin-info.git
cd wp-plugin-info
bash bin/install-wp-tests.sh wordpress_test root '' localhost latest
composer install
使用PHPUnit运行单元测试
composer phpunit
composer phpcs
运行PHP Mess Detector测试以检测代码风格的不一致性
composer phpmd
运行所有之前的测试
composer tests
赞助
如果这个项目帮助您减少了开发时间,您可以赞助我以支持我的开源工作 😊
许可证
此存储库受MIT许可证许可。
版权所有 © 2017-2022,Josantonius