File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content type:	`text/markdown`
Description:	Documentation
Class:	wp-plugin-rating Show ratings of WordPress plugins
Author:	By Josantonius
Last change:
Date:	6 years ago
Size:	`5,199 bytes`

WP Plugin Rating � Eliasis component

Show plugin rating in WordPress administration pages for plugins developed with Eliasis Framework.

This component requires that the page where the action hook will be inserted has been created with WP_Menu.

<img src="resources/screenshot-1.png" alt="">
<img src="resources/screenshot-2.png" alt="">

</p>

This component 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 component is through Composer.

To install WP Plugin Rating, simply:

$ composer require eliasis-framework/wp-plugin-rating

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-rating --prefer-source

You can also clone the complete repository with Git:

$ git clone https://github.com/eliasis-framework/wp-plugin-rating.git

Available methods in this component:

Hook::doAction('get_plugin_rating', $slug);

| Atttribute | Description | Type | Required | --- | --- | --- | --- | | $slug | WordPress plugin slug. | string | Yes |

@return HTML output.

To use this component with Composer:

use Josantonius\Hook\Hook;

Hook::doAction('get_plugin_rating', 'search-inside');

To run tests you just need composer and to execute the following:

$ git clone https://github.com/eliasis-framework/wp-plugin-rating.git

$ cd wp-plugin-rating

$ 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

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

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.