PHP Classes

WP_Image: Store given images in a WordPress installation

Recommend this page to a friend!
  Info   View files Documentation   View files View files (20)   DownloadInstall with Composer Download .zip   Reputation   Support forum   Blog    
Ratings Unique User Downloads Download Rankings
Not yet rated by the usersTotal: 101 This week: 1All time: 9,774 This week: 560Up
Version License PHP version Categories
wp_image 1.0.2Custom (specified...5PHP 5, Graphics, Blogs
Description 

Author

This class can store given images in a WordPress installation.

It can perform several types of operations with images to be stored for use in WordPress posts.

Currently it can retrieve an image from a remote URL and save it to associate with a post, process an uploaded image, delete images of a given post.

Innovation Award
PHP Programming Innovation award nominee
December 2017
Number 12
WordPress is the most popular content publication platform. Great part of the posts of WordPress based sites include images.

This class provide a simple solution for adding, updating and deleting images from WordPress posts.

Manuel Lemos
Picture of Josantonius
  Performance   Level  
Name: Josantonius is available for providing paid consulting. Contact Josantonius .
Classes: 31 packages by
Country: Spain Spain
Age: ???
All time rank: 132526 in Spain Spain
Week rank: 27 Up3 in Spain Spain Up
Innovation award
Innovation award
Nominee: 11x

Documentation

PHP WordPress Image

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

Versión en español

Adding, updating and deleting images from WordPress posts.

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

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

You can also clone the complete repository with Git:

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

Or install it manually:

Download WP_Image.php:

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

Available Methods

Available methods in this library:

- Save image and associate it with a specific post:

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

| 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:

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

| 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:

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

| 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:

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

use Josantonius\WP_Image;

Or If you installed it manually, use it:

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

use Josantonius\WP_Image\WP_Image;

Usage

Example of use for this library:

- Upload image:

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

- Save image:

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

- Save featured image:

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

- Delete attachments:

WP_Image::delete_all_attachment(18);

- Force delete attachments:

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

Tests

To run tests you just need composer and to execute the following:

$ git clone https://github.com/Josantonius/WP_Image.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

? TODO

  • [ ] Add new feature
  • [ ] Improve tests
  • [ ] Improve documentation
  • [ ] Refactor code

Contribute

If you would like to help, please take a look at the list of issues or the To Do checklist.

Pull requests

  • Fork and clone.
  • Run the command `composer install` to install the dependencies. This will also install the dev dependencies.
  • Run the command `composer fix` to excute code standard fixers.
  • Run the tests.
  • Create a branch, commit, push and send me a pull request.

Repository

The file structure from this repository was created with PHP-Skeleton.

License

This project is licensed under MIT license. See the LICENSE file for more info.

Copyright

2017 - 2018 Josantonius, josantonius.com

If you find it useful, let me know :wink:

You can contact me on Twitter or through my email.


  Files folder image Files  
File Role Description
Files folder imagebin (1 file)
Files folder imagesrc (1 file)
Files folder imagetests (2 files, 1 directory)
Accessible without login Plain text file .editorconfig Data Auxiliary data
Accessible without login Plain text file .php_cs.dist Example Example script
Accessible without login Plain text file .travis.yml Data Auxiliary data
Accessible without login Plain text file CHANGELOG.md Data Auxiliary data
Accessible without login Plain text file composer.json Data Auxiliary data
Accessible without login Plain text file CONDUCT.md Data Auxiliary data
Accessible without login Plain text file LICENSE Lic. License text
Accessible without login Plain text file phpcs.xml Data Auxiliary data
Accessible without login Plain text file phpmd.xml Data Auxiliary data
Accessible without login Plain text file phpunit.xml Data Auxiliary data
Accessible without login Plain text file README-ES.md Doc. Documentation
Accessible without login Plain text file README.md Doc. Documentation
Accessible without login Plain text file _config.yml Data Auxiliary data

  Files folder image Files  /  bin  
File Role Description
  Accessible without login Plain text file install-wp-tests.sh Data Auxiliary data

  Files folder image Files  /  src  
File Role Description
  Plain text file class-wp-image.php Class Class source

  Files folder image Files  /  tests  
File Role Description
Files folder imagetest-images (3 files)
  Accessible without login Plain text file bootstrap.php Example Example script
  Plain text file class-image-test.php Class Class source

  Files folder image Files  /  tests  /  test-images  
File Role Description
  Accessible without login Image file cat.jpg Data Auxiliary data
  Accessible without login Image file funny.gif Data Auxiliary data
  Accessible without login Image file sponge.png Data Auxiliary data

 Version Control Unique User Downloads Download Rankings  
 100%
Total:101
This week:1
All time:9,774
This week:560Up