image README

Intervention Image

PHP Image Processing

Intervention Image is a PHP image processing library that provides a simple and expressive way to create, edit, and compose images. It comes with a universal interface for the popular PHP image manipulation extensions. You can choose between the GD library, Imagick or libvips as the base layer for all operations.

Fluent interface for common image editing tasks
Interchangeable driver architecture with support for GD, Imagick and libvips
Support for animated images with all drivers
Framework-agnostic

Installation

Install this library using Composer. Add the package with the following command:

composer require intervention/image

Getting Started

Learn the basics on how to use Intervention Image and more with the official documentation.

Code Examples

use Intervention\Image\ImageManager;
use Intervention\Image\Drivers\Gd\Driver as GdDriver;
use Intervention\Image\Alignment;
use Intervention\Image\Color;
use Intervention\Image\Format;

// create image manager instance using the preferred driver
$manager = ImageManager::usingDriver(GdDriver::class);

// read image data from path
$image = $manager->decodePath('images/example.webp');

// scale image by height
$image->scale(height: 300);

// insert a watermark
$image->insert('images/watermark.png', alignment: Alignment::BOTTOM_RIGHT);

// encode edited image
$encoded = $image->encodeUsingFormat(Format::JPEG, quality: 65);

// save encoded image
$encoded->save('images/example.jpg');

Requirements

Ensure that your server environment meets the following requirements before installation:

PHP >= 8.3
Mbstring PHP Extension
Image Processing PHP Extension (GD, Imagick or libvips)

Supported Image Libraries

Depending on your environment Intervention Image lets you choose between different image processing extensions.

GD Library
Imagick PHP extension
libvips

Security

If you discover any security related issues, please email [email protected] directly.

Authors

This library is developed and maintained by Oliver Vogel

Thanks to the community of contributors who have helped to improve this project.

License

Intervention Image is licensed under the MIT License.

14.4K ·GitHub

Image

What is this?

Intervention Image is a PHP library for processing images: creating, editing, and composing them with a fluent, expressive API.

Is it a standalone app or a library I add to my project?

It's a PHP library you install via Composer and call from your own code; it's framework-agnostic so it works with any PHP project.

How do I add it to a project?

Install it with Composer by adding the package to your project.

What do I need installed before using it?

PHP 8.3 or higher, the Mbstring extension, and at least one image-processing extension: GD, Imagick, or libvips.

Which image backend should I pick — GD, Imagick, or libvips?

You can pick whichever is available in your environment; the library provides a universal interface so your code stays the same regardless of which driver (GD, Imagick, or libvips) you choose.

Does it support animated images like GIFs?

Yes, animated image support works across all three drivers (GD, Imagick, and libvips).

Can I switch image backends without rewriting my code?

Yes, the interchangeable driver architecture lets you swap between GD, Imagick, and libvips while keeping the same fluent API calls.

What are similar projects?

YYKit, dompdf, laravel-ide-helper, flysystem, pest, PHPMailer, PHP-Parser, EmailValidator

Which topics is it in?

php-library, image, document-processing, php, image-processing, api, library, developer-tools, mit, open-source

Creator: Intervention
Size: 6.9 MB
Stars: 14.4K
Updated: CommitOct 17 Release4.4.0Oct 17
Age: 13y
Commits · 90 Days