PHP Classes
elePHPant
Icontem

File: README-ES.md

Recommend this page to a friend!
  Classes of Josantonius  >  wp-plugin-rating  >  README-ES.md  >  Download  
File: README-ES.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: wp-plugin-rating
Show ratings of WordPress plugins
Author: By
Last change:
Date: 9 months ago
Size: 5,533 bytes
 

Contents

Class file image Download

WP Plugin Rating · Eliasis component

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

Versión en español

Mostrar la calificación del plugin en las páginas de administración de WordPress para plugins desarrollados con Eliasis Framework.

Este componente requiere que la página donde se insertará el gancho de acción haya sido creada con WP_Menu.

<p align="center">

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

</p>

Requisitos

Este componente es soportado por versiones de PHP 5.6 o superiores y es compatible con versiones de HHVM 3.0 o superiores.

Instalación

La mejor forma de instalar este componente es a través de Composer.

Para instalar WP Plugin Rating, simplemente escribe:

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

El comando anterior sólo instalará los archivos necesarios, si prefieres descargar todo el código fuente puedes utilizar:

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

También puedes clonar el repositorio completo con Git:

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

Métodos disponibles

Métodos disponibles en este componente:

- Mostrar calificación del plugin de WordPress:

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

| Atributo | Descripción | Tipo de dato | Requerido | Por defecto | --- | --- | --- | --- | | $slug | Slug del plugin de WordPress. | string | Sí |

@return Salida HTML.

Cómo empezar

Para utilizar este componente con Composer:

use Josantonius\Hook\Hook;

Uso

- Mostrar calificación del plugin Search Inside:

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

Tests

Para ejecutar las pruebas necesitarás Composer y seguir los siguientes pasos:

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

$ cd wp-plugin-rating

$ composer install

Ejecutar pruebas unitarias con PHPUnit:

$ composer phpunit

Ejecutar pruebas de estándares de código para WordPress con PHPCS:

$ composer phpcs

Ejecutar pruebas con PHP Mess Detector para detectar inconsistencias en el estilo de codificación:

$ composer phpmd

Ejecutar todas las pruebas anteriores:

$ composer tests

? Tareas pendientes

  • [ ] Añadir nueva funcionalidad.
  • [ ] Mejorar pruebas.
  • [ ] Mejorar documentación.
  • [ ] Refactorizar código para las reglas de estilo de código deshabilitadas. Ver phpmd.xml y .php_cs.dist.

Contribuir

Si deseas colaborar, puedes echar un vistazo a la lista de issues o tareas pendientes.

Pull requests

Licencia

Este proyecto está licenciado bajo licencia MIT. Consulta el archivo LICENSE para más información.

Copyright

2017 -2018 Josantonius, josantonius.com

Si te ha resultado útil, házmelo saber :wink:

Puedes contactarme en Twitter o a través de mi correo electrónico.