Get and save plugin information from WordPress API to be consumed by other modules.
This plugin is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.
The preferred way to install this plugin is through Composer.
To install WP Plugin Info, simply:
composer require eliasis-framework/wp-plugin-info
The previous command will only install the necessary files, if you prefer to download the entire source code you can use:
composer require eliasis-framework/wp-plugin-info --prefer-source
You can also clone the complete repository with Git:
git clone https://github.com/eliasis-framework/wp-plugin-info.git
Available methods in this plugin:
get($option, $slug);| Atttribute | Description | Type | Required |
|---|---|---|---|
| $option | Option to get. | string | Yes |
| $slug | WordPress plugin slug. | string | Yes |
@return (mixed) → Value or false.
To use this plugin with 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');To run tests you just need composer and to execute the following:
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
Run unit tests with PHPUnit:
composer phpunit
Run WordPress code standard tests with PHPCS:
composer phpcs
Run PHP Mess Detector tests to detect inconsistencies in code style:
composer phpmd
Run all previous tests:
composer tests
If this project helps you to reduce your development time, you can sponsor me to support my open source work 😊
This repository is licensed under the MIT License.
Copyright © 2017-2022, Josantonius