|Classes of Josantonius||WP_Image||README.md||Download|
PHP WordPress Image
Adding, updating and deleting images from WordPress posts.
This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher.
The preferred way to install this extension is through Composer.
To install WP_Image library, simply:
The previous command will only install the necessary files, if you prefer to download the entire source code you can use:
You can also clone the complete repository with Git:
Or install it manually:
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.
To use this library with Composer:
Or If you installed it manually, use it:
Example of use for this library:
- Upload image:
- Save image:
- Save featured image:
- Delete attachments:
- Force delete attachments:
To run tests you just need composer and to execute the following:
Run unit tests with PHPUnit:
Run WordPress code standard tests with PHPCS:
Run PHP Mess Detector tests to detect inconsistencies in code style:
Run all previous tests:
If you would like to help, please take a look at the list of issues or the To Do checklist.
The file structure from this repository was created with PHP-Skeleton.
This project is licensed under MIT license. See the LICENSE file for more info.
2017 - 2018 Josantonius, josantonius.com
If you find it useful, let me know :wink:
You can contact me on Twitter or through my email.