PHP WordPress Image

English version

Añadir, actualizar y borrar imágenes de posts en WordPress.

• Requisitos
• Instalación
• Métodos disponibles
• Cómo empezar
• Uso
• Tests
• Tareas pendientes
• Contribuir
• Repositorio
• 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 PHP WP_Image library, simplemente escribe:

$ composer require Josantonius/WP_Image

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

$ composer require Josantonius/WP_Image --prefer-source

También puedes clonar el repositorio completo con Git:

$ git clone https://github.com/Josantonius/WP_Image.git

O instalarlo manualmente:

Download WP_Image.php:

$ wget https://raw.githubusercontent.com/Josantonius/WP_Image/master/src/class-wp-image.php

Métodos disponibles

Métodos disponibles en esta biblioteca:

- Guardar imagen y asociarla a un post específico:

WP_Image::save($url, $post_ID, $featured);

| Atributo | Descripción | Tipo de dato | Requerido | Por defecto | --- | --- | --- | --- | --- | | $url | Url de la imagen. | string | Yes | | | $post_ID | Post ID. | int | Yes | | | $featured | Definir imagen como destacada. | boolean | No | false |

@return (string|false) ? URI del archivo adjunto o falso en caso de fallo.

- Cargar imagen al directorio de subidas de WordPress:

WP_Image::upload($url, $filename);

| Atributo | Descripción | Tipo de dato | Requerido | --- | --- | --- | --- | | $url | Url de la imagen. | string | Yes | | $filename| Nombre del archivo. | string | Yes |

@return (string|false) ? Ruta de la imagen subida o falso en caso de fallo.

Borra imágenes adjuntas y todos sus derivados:

WP_Image::delete_all_attachment($post_ID, $force);

| Atributo | Descripción | Tipo de dato | Requerido | --- | --- | --- | --- | | $post_ID | Post ID. | int | Yes | | $force| Forzar borrado. | boolean | Yes |

@return (int|false) ? Número de imágenes adjuntas borradas.

Cómo empezar

Para utilizar esta clase con Composer:

require __DIR__ . '/vendor/autoload.php';

use Josantonius\WP_Image;

Si la instalaste manualmente, utiliza:

require_once __DIR__ . '/class-wp-image.php';

use Josantonius\WP_Image\WP_Image;

Uso

Ejemplo de uso para esta biblioteca:

- Cargar imagen:

WP_Image::upload('https://site.com/image.png', 'image.png');

- Guardar imagen:

WP_Image::upload('https://site.com/image.png', '18');

- Guardar imagen destacada:

WP_Image::upload('https://site.com/image.png', '18', true);

- Borrar imágenes adjuntas:

WP_Image::delete_all_attachment(18);

- Forzar borrado de imágenes adjuntas:

WP_Image::delete_all_attachment('18', true);

Tests

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

$ git clone https://github.com/Josantonius/WP_Image.git

$ cd WP_Image

$ 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

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.

Repositorio

La estructura de archivos de este repositorio se creó con PHP-Skeleton.

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.