File: README.md

Recommend this page to a friend!
  Classes of Josantonius  >  WP_Image  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: WP_Image
Store given images in a WordPress installation
Author: By
Last change: Updated to 1.0.3 version
Date: 3 years ago
Size: 6,290 bytes
 

 

Contents

Class file image Download

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.


For more information send a message to info at phpclasses dot org.