README

PHP library designed for easy image formatting for Instagram according to Instagram guidelines.

Setup

Via composer:

$ composer require antey/instagram-image

Or by cloning repository

Requirements

• PHP version: >= 7.4;
• PHP extensions: gd.

Dependencies

• php-image-resize
• php-image-slice

Usage

This package allow to resize image to any resolution, according to instagram requirements or get optimal resolution for post or gallery (description of features is below).

Instagram resolutions

• Profile photo - 360x360 px;
• Stories - 1080x1920 px;
• Reels - 1080x1920 px;
• IGTV cover - 420x654 px;
• Square post - 1080x1080 px;
• Landscape post - 1080x564 px;
• Portrait post - 1080x1350 px;

Resizing

Package allow to simple resize original image into one of instagram images, using one of methods: getProfile, getIgtvCover, getSinglePostSquare, getSinglePostLandscape and getSinglePostPortrait.

Slicing

Different to simple resizing, instagram also allow to publish some multiple images. It can be Stories, Reels, Post with several images. To create this types of images, package provide methods, that resize and slice original image into a pieces. List of this methods: getStories, getReels, getGallerySquare, getGalleryLandscape, getGalleryPortrait.

Optimal resizing

To simplify work with Post, package provide methods, that will automatically find most reliable type (single image or gallery) and resolution (Square, Landscape, Portrait) for given image and return path to resized image, or paths of sliced pieces. It's getSinglePostOptimal, getGalleryOptimal, getPostOptimal.

Available features

Resizing initialization

use Antey\InstagramImage\InstagramImageResize;

$imageResize = new InstagramImageResize();

Resizing simple images

For simple images (like a Profile, Stories, Reels, IGTVCover) resized image (or images gallery) will be created by single specified method.

getProfile

$imageResize->getProfile(string $filename, string $path = ''): string;

Convert given image into jpeg, resize to profile resolution and return path to result image. If destination empty - will replace original file.

getStories

$imageResize->getStories(string $filename, string $path = ''): array;

Convert given image into jpeg, resize to stories resolution and slice into several stories images, if it possible. Return array of paths to result images. If destination empty - will store result file near to original file.

getReels

$imageResize->getReels(string $filename, string $path = ''): array;

Convert given image into jpeg, resize to Reels resolution and slice into several reels images, if it possible. Return array of paths to result images. If destination empty - will store result file near to original file.

getIgtvCover

$imageResize->getIgtvCover(string $filename, string $path = ''): string;

Convert given image into jpeg, resize to IGTVCover resolution and return path to result image. If destination empty - will replace original file.

Resizing post images

Different to simple images, Post resizing is tricky. Instagram allow publishing post int three resolutions: 1080x1080, 1080x565, 1080x1350. Also, there is availability to publish gallery of post images. So, to manipulate post resizing, we need additional set of methods.

getSinglePostSquare

$imageResize->getSinglePostSquare(string $filename, string $path = ''): string;

Convert given image into jpeg, resize to square post resolution and return path to result image. If destination empty - will replace original file.

getSinglePostLandscape

$imageResize->getSinglePostLandscape(string $filename, string $path = ''): string;

Convert given image into jpeg, resize to landscape post resolution and return path to result image. If destination empty - will replace original file.

getSinglePostPortrait

$imageResize->getSinglePostPortrait(string $filename, string $path = ''): string;

Convert given image into jpeg, resize to portrait post resolution and return path to result image. If destination empty - will replace original file.

getSinglePostOptimal

$imageResize->getSinglePostOptimal(string $filename, string $path = ''): string;

Convert given image into jpeg, resize to most conformity post resolution and return path to result image. If destination empty - will replace original file.

getGallerySquare

$imageResize->getGallerySquare(string $filename, string $path = ''): array;

Convert given image into jpeg, slice to several images in square post resolution and return paths to result images. If destination empty - will be stored ner to original image.

getGalleryLandscape

$imageResize->getGalleryLandscape(string $filename, string $path = ''): array;

Convert given image into jpeg, slice to several images in landscape post resolution and return paths to result images. If destination empty - will be stored ner to original image.

getGalleryPortrait

$imageResize->getGalleryPortrait(string $filename, string $path = ''): array;

Convert given image into jpeg, slice to several images in portrait post resolution and return paths to result images. If destination empty - will be stored ner to original image.

getGalleryOptimal

$imageResize->getGalleryOptimal(string $filename, string $path = ''): array;

Convert given image into jpeg, and slice to several images in most conformity post resolution, then return path to result image. If destination empty - will be stored ner to original image.

getOptimalPost

$imageResize->getOptimalPost(string $filename, string $path = ''): array;

Convert given image into jpeg, and based on image resolution just resize into optimal post resolution, or slice to several images in most conformity post resolution, then return path to result image. If destination empty - will be stored ner to original image.