2017 © Pedro Peláez
 

library wp_image

Adding, updating and deleting images from WordPress posts.

image

josantonius/wp_image

Adding, updating and deleting images from WordPress posts.

  • PHP
  • 3 Dependents
  • 0 Suggesters
  • 2 Forks
  • 0 Open issues
  • 5 Versions
  • 0 % Grown

The README.md

PHP WordPress Image

Latest Stable Version License, (*1)

Versión en español, (*2)

Adding, updating and deleting images from WordPress posts., (*3)

Requirements

This library is supported by PHP versions 5.6 or higher and is compatible with HHVM versions 3.0 or higher., (*4)

Installation

The preferred way to install this extension is through Composer., (*5)

To install WP_Image library, simply:, (*6)

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:, (*7)

composer require josantonius/wp-image-handler --prefer-source

You can also clone the complete repository with Git:, (*8)

git clone https://github.com/josantonius/wp-image-handler.git

Or install it manually:, (*9)

Download WP_Image.php:, (*10)

wget https://raw.githubusercontent.com/josantonius/wp-image-handler/master/src/class-wp-image.php

Available Methods

Available methods in this library:, (*11)

- 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., (*12)

- 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., (*13)

- 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., (*14)

Quick Start

To use this library with Composer:, (*15)

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

use Josantonius\WP_Image;

Or If you installed it manually, use it:, (*16)

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

use Josantonius\WP_Image\WP_Image;

Usage

Example of use for this library:, (*17)

- 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:, (*18)

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:, (*19)

composer phpunit

Run WordPress code standard tests with PHPCS:, (*20)

composer phpcs

Run PHP Mess Detector tests to detect inconsistencies in code style:, (*21)

composer phpmd

Run all previous tests:, (*22)

composer tests

If this project helps you to reduce your development time, you can sponsor me to support my open source work :blush:, (*23)

License

This repository is licensed under the MIT License., (*24)

Copyright © 2017-2022, Josantonius, (*25)

The Versions

25/02 2018

dev-master

9999999-dev

Adding, updating and deleting images from WordPress posts.

  Sources   Download

MIT

The Requires

  • php ^5.6 || ^7.0

 

The Development Requires

by Avatar Josantonius

wordpress php image hhvm attachment

16/01 2018

1.0.3

1.0.3.0

Adding, updating and deleting images from WordPress posts.

  Sources   Download

MIT

The Requires

  • php ^5.6 || ^7.0

 

The Development Requires

by Avatar Josantonius

wordpress php image hhvm attachment

15/10 2017

1.0.2

1.0.2.0

Save images to WordPress.

  Sources   Download

MIT

The Requires

  • php ^5.6 || ^7.0

 

by Avatar Josantonius

wordpress php image hhvm attachment

11/08 2017

1.0.1

1.0.1.0

Save images to WordPress.

  Sources   Download

MIT

The Requires

  • php ^5.6 || ^7.0

 

by Avatar Josantonius

wordpress php image hhvm attachment

18/07 2017

1.0.0

1.0.0.0

Save images to WordPress.

  Sources   Download

MIT

The Requires

  • php ^5.6 || ^7.0

 

by Avatar Josantonius

wordpress php image hhvm attachment