WP Plugin Info · Eliasis plugin

Versión en español

Obtener y guardar información de plugins a través de la API de WordPress para ser consumida por otros módulos.

• Requisitos
• Instalación
• Métodos disponibles
• Cómo empezar
• Uso
• Tests
• Tareas pendientes
• Contribuir
• Licencia
• Copyright ---

Requisitos

Esta biblioteca es soportada 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 esta extensión es a través de Composer.

Para instalar WP Plugin Info, simplemente escribe:

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

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

También puedes clonar el repositorio completo con Git:

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

Métodos disponibles

Métodos disponibles en esta biblioteca:

- Obtener información del plugin:

get($option, $slug);

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

@return (mixed) ? Valor o falso.

Cómo empezar

Para utilizar esta clase con Composer:

use Eliasis\Complement\Type\Plugin;

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

Uso

- Obtener nombre del plugin:

# [string]

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

- Obtener version del plugin:

# [string]

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

- Obtener autor del plugin:

# [string]

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

- Obtener perfil del autor del plugin:

# [string]

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

- Obtener contribuyentes del plugin:

# [array]

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

- Obtener requisitos del plugin:

# [string]

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

- Obtener última version comprobada del plugin:

# [string]

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

- Obtener compatibilidad del plugin:

# [array]

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

- Obtener calificación del plugin:

# [int]

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

- Obtener calificaciones del plugin:

# [array]

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

- Obtener calificaciones numéricas del plugin:

# [int]

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

- Obtener hilos de soporte abiertos del plugin:

# [int]

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

- Obtener hilos de soporte resueltos del plugin:

# [int]

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

- Obtener número de descargas del plugin:

# [int]

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

- Obtener fecha de última actualización del plugin:

# [string]

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

- Obtener fecha en la que fue agregado el plugin:

# [string]

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

- Obtener página principal del plugin:

# [string]

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

- Obtener enlace de descarga del plugin:

# [string]

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

- Obtener etiquetas del plugin:

# [array]

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

- Obtener enlace de donación del plugin:

# [string]

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

Tests

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

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

$ cd wp-plugin-info

$ 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

• Fork and clone.
• Ejecuta el comando `composer install` para instalar dependencias. Esto también instalará las dependencias de desarrollo.
• Ejecuta el comando `composer fix` para estandarizar el código.
• Ejecuta las pruebas.
• Crea una nueva rama (branch), commit, push y envíame un pull request.

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.