README

Versión en español

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.

Requirements
Installation
Available Methods
Quick Start
Usage
Tests
Sponsor
License

Requirements

This component 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 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

Available methods in this component:

- Show WordPress plugin rating

Hook::doAction('wp-plugin-rating\display', $slug);

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

@return HTML output.

Quick Start

To use this component with Composer:

use Josantonius\Hook\Hook;

Usage

- Show rating of the Search Inside plugin

Hook::doAction('wp-plugin-rating\display', 'search-inside');

Tests

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

Sponsor

If this project helps you to reduce your development time, you can sponsor me to support my open source work 😊

License

This repository is licensed under the MIT License.

eliasis-framework / wp-plugin-rating

Maintainers

Details