eliasis-framework/wp-plugin-info

Get and save plugin information from WordPress API to be consumed by other modules.

1.0.4 2018-03-01 15:37 UTC

This package is auto-updated.

Last update: 2020-07-22 12:48:40 UTC


README

Latest Stable Version Latest Unstable Version License Codacy Badge Total Downloads Travis WP CodeCov

Versión en español

Get and save plugin information from WordPress API to be consumed by other modules.

Requirements

This plugin is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.

Installation

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

Available methods in this plugin:

- Get plugin information:

get($option, $slug);
Atttribute Description Type Required
$option Option to get. string Yes
$slug WordPress plugin slug. string Yes

@return (mixed) → Value or false.

Quick Start

To use this plugin with Composer:

use Eliasis\Complement\Type\Plugin;

$wp_plugin_info = Plugin::WP_Plugin_Info()->getControllerInstance('Main');

Usage

- Get plugin name:

# [string]

$wp_plugin_info->get('name', 'plugin-slug'); 

- Get plugin version:

# [string]

$wp_plugin_info->get('version', 'plugin-slug');

- Get plugin author:

# [string]

$author = $wp_plugin_info->get('author', 'plugin-slug');

- Get plugin author profile:

# [string]

$wp_plugin_info->get('author_profile', 'plugin-slug');

- Get plugin contributors:

# [array]

$wp_plugin_info->get('contributors', 'plugin-slug');

- Get plugin requires:

# [string]

$wp_plugin_info->get('requires', 'plugin-slug');

- Get plugin tested:

# [string]

$wp_plugin_info->get('tested', 'plugin-slug');

- Get plugin compatibility:

# [array]

$wp_plugin_info->get('compatibility', 'plugin-slug');

- Get plugin rating:

# [int]

$wp_plugin_info->get('rating', 'plugin-slug');

- Get plugin ratings:

# [array]

$wp_plugin_info->get('ratings', 'plugin-slug');

- Get plugin num ratings:

# [int]

$wp_plugin_info->get('num_ratings', 'plugin-slug');

- Get plugin support threads:

# [int]

$wp_plugin_info->get('support_threads', 'plugin-slug');

- Get plugin support threads resolved:

# [int]

$wp_plugin_info->get('support_threads_resolved', 'plugin-slug');

- Get plugin downloaded:

# [int]

$wp_plugin_info->get('downloaded', 'plugin-slug');

- Get plugin last updated:

# [string]

$wp_plugin_info->get('last_updated', 'plugin-slug');

- Get plugin added:

# [string]

$wp_plugin_info->get('added', 'plugin-slug');

- Get plugin homepage:

# [string]

$wp_plugin_info->get('homepage', 'plugin-slug');

- Get plugin download link:

# [string]

$wp_plugin_info->get('download_link', 'plugin-slug');

- Get plugin tags:

# [array]

$wp_plugin_info->get('tags', 'plugin-slug');

- Get plugin donate link:

# [string]

$wp_plugin_info->get('donate_link', 'plugin-slug');

Tests

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

☑ TODO

  • Add new feature.
  • Improve tests.
  • Improve documentation.
  • Refactor code for disabled code style rules. See phpmd.xml and .php_cs.dist.

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

  • Fork and clone.
  • Run the command composer install to install the dependencies. This will also install the dev dependencies.
  • Run the command composer fix to excute code standard fixers.
  • Run the tests.
  • Create a branch, commit, push and send me a pull request.

License

This project is licensed under MIT license. See the LICENSE file for more info.

Copyright

2017 - 2018 Josantonius, josantonius.com

If you find it useful, let me know 😉

You can contact me on Twitter or through my email.