Download the PHP package josantonius/wp-image-handler without Composer
On this page you can find all versions of the php package josantonius/wp-image-handler. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download josantonius/wp-image-handler
More information about josantonius/wp-image-handler
Files in josantonius/wp-image-handler
Package wp-image-handler
Short Description Adding, updating and deleting images from WordPress posts.
License MIT
Informations about the package wp-image-handler
PHP WordPress Image
Versión en español
Adding, updating and deleting images from WordPress posts.
- Requirements
- Installation
- Available Methods
- Quick Start
- Usage
- Tests
- Sponsor
- License
Requirements
This library 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 extension is through Composer.
To install WP_Image library, simply:
composer require josantonius/wp-image-handler
The previous command will only install the necessary files, if you prefer to download the entire source code you can use:
composer require josantonius/wp-image-handler --prefer-source
You can also clone the complete repository with Git:
git clone https://github.com/josantonius/wp-image-handler.git
Or install it manually:
wget https://raw.githubusercontent.com/josantonius/wp-image-handler/master/src/class-wp-image.php
Available Methods
Available methods in this library:
- Save image and associate it with a specific post
Atttribute | Description | Type | Required | Default |
---|---|---|---|---|
$url | External url image. | string | Yes | |
$post_ID | Post ID. | int | Yes | |
$featured | Set image as featured. | boolean | No | false |
@return (string|false) → URI for an attachment file or false on failure.
- Upload image to WordPress upload directory
Atttribute | Description | Type | Required |
---|---|---|---|
$url | External url image. | string | Yes |
$filename | Filename. | string | Yes |
@return (string|false) → Path to upload image or false on failure.
- Deletes an attachment and all of its derivatives
Atttribute | Description | Type | Required |
---|---|---|---|
$post_ID | Post ID. | int | Yes |
$force | Force deletion. | boolean | Yes |
@return (int|false) → Atachments deleted.
Quick Start
To use this library with Composer:
Or If you installed it manually, use it:
Usage
Example of use for this library:
- Upload image
- Save image
- Save featured image
- Delete attachments
- Force delete attachments
Tests
To run composer and to execute the following:
git clone https://github.com/josantonius/wp-image-handler.git
cd WP_Image
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 :blush:
License
This repository is licensed under the MIT License.
Copyright © 2017-2022, Josantonius