Options

Each imgproxy processing option is a class in the SomehowDigital\ImgProxy\Option namespace. Every class has its own page with a usage example, its parameters and notes.

Options marked Pro need imgproxy Pro. See imgproxy Pro for what that means in practice.

Contract

Every option implements OptionInterface:

interface OptionInterface
{
    public function getName(): string;

    public function getAlias(): ?string;

    public function getValues(): array;

    public function getParameters(): array;
}

getParameters() returns the URL parameters as strings: booleans become 1 or 0, enums their value, and nested options their parameters. The URL uses getAlias() when there is one, and getName() otherwise. To add your own option, see Extending.

All options

Sizing

Class	imgproxy	Description
`AutoRotate`	`ar`	Applies the EXIF orientation of the source and removes the tag.
`Dpr`	`dpr`	Multiplies the resulting dimensions by a device pixel ratio, for HiDPI screens.
`Enlarge`	`el`	Allows enlarging images that are smaller than the requested size.
`Extend`	`ex`	Extends the image to the requested size when it is smaller, filling the new area with the background color.
`ExtendAspectRatio`	`exar`	Extends the image to the requested aspect ratio, filling the new area with the background color.
`Flip`	`fl`	Flips the image horizontally, vertically or both.
`Height`	`h`	Sets the height of the resulting image.
`MaxResultDimension`	`mrd`	Limits the larger dimension of the resulting image.
`MinHeight`	`mh`	Sets the minimum height of the resulting image.
`MinWidth`	`mw`	Sets the minimum width of the resulting image.
`Padding`	`pd`	Adds padding around the image, after all other transformations.
`Resize`	`rs`	Sets the resizing type, size, enlarge and extend behavior in a single option.
`ResizingAlgorithm` Pro	`ra`	Sets the algorithm used to resample the image.
`ResizingType`	`rt`	Defines how the image is fitted to the requested size.
`Rotate`	`rot`	Rotates the image clockwise by a multiple of 90 degrees.
`Size`	`s`	Sets width, height, enlarge and extend in a single option.
`Trim`	`t`	Removes the surrounding background from the image.
`Width`	`w`	Sets the width of the resulting image.
`Zoom`	`z`	Multiplies the resulting dimensions.

Cropping

Class	imgproxy	Description
`Crop`	`c`	Crops the image to a size before it is resized.
`CropAspectRatio` Pro	`car`	Adjusts the crop area to an aspect ratio.
`CropObjects` Pro	`c_obj`	Crops the image to the objects detected by imgproxy’s object detection.
`Gravity` Partly Pro	`g`	Sets the anchor for cropping and extending.
`GravityFocusPoint`	`g`	Gravity on a focus point given in relative coordinates.
`GravityObject` Pro	`g`	Gravity on the objects of the given classes, as detected by imgproxy’s object detection.
`GravityObjectWeight` Pro	`g`	Gravity on detected objects, with a weight for each class.
`GravitySmart`	`g`	Gravity on the most interesting part of the image, as detected by imgproxy.
`ObjectsPosition` Pro	`op`	Positions the detected objects within the resulting image.

Effects

Class	imgproxy	Description
`Adjust` Pro	`a`	Sets brightness, contrast and saturation in one option.
`Background`	`bg`	Fills transparent areas and padding with a color.
`BackgroundAlpha` Pro	`bga`	Adds an alpha channel to the background color.
`Blur`	`bl`	Applies a gaussian blur.
`BlurAreas` Pro	`ba`	Blurs rectangular areas of the image.
`BlurDetections` Pro	`bd`	Blurs the objects found by imgproxy’s object detection.
`Brightness` Pro	`br`	Adjusts the brightness of the image.
`Colorize` Pro	`col`	Overlays a color on the image.
`Contrast` Pro	`co`	Adjusts the contrast of the image.
`DrawDetections` Pro	`dd`	Draws boxes, classes and confidences of detected objects onto the image.
`Duotone` Pro	`dt`	Converts the image to two tones, mapping dark and light areas to two colors.
`Gradient` Pro	`gr`	Overlays a gradient that fades from transparent to a color.
`Monochrome` Pro	`mc`	Converts the image to monochrome.
`Pixelate`	`pix`	Applies a pixelation filter.
`Saturation` Pro	`sa`	Adjusts the saturation of the image.
`Sharpen`	`sh`	Applies a sharpening filter.
`UnsharpMasking` Pro	`ush`	Applies unsharp masking.

Output

Class	imgproxy	Description
`AutoQuality` Pro	`aq`	Picks the quality automatically by encoding the image several times.
`AvifOptions` Pro	`avifo`	Sets AVIF encoder options.
`ColorProfile` Pro	`cp`	Converts the image to a color profile and embeds it.
`DisableAnimation` Pro	`da`	Treats animated images as static, using the first frame.
`Dpi` Pro	`dpi`	Replaces the DPI metadata of the image.
`EnforceThumbnail`	`eth`	Uses the thumbnail embedded in the source, when there is one.
`Filename`	`fn`	Sets the file name used in the Content-Disposition header.
`Format` Partly Pro	`f`	Sets the output format as a processing option.
`FormatQuality`	`fq`	Sets the quality for individual output formats.
`JpegOptions` Pro	`jpgo`	Sets JPEG encoder options.
`KeepCopyright`	`kcr`	Keeps the copyright information when metadata is stripped.
`MaxBytes`	`mb`	Lowers the quality until the result fits in a number of bytes.
`PngOptions` Pro	`pngo`	Sets PNG encoder options.
`PreserveHdr`	`ph`	Keeps the high bit depth of HDR images instead of reducing them to 8 bits.
`Quality`	`q`	Sets the quality of the resulting image.
`Raw`	`raw`	Streams the source as it is, without processing or checks.
`ReturnAttachment`	`att`	Makes imgproxy answer with a Content-Disposition: attachment header, so browsers download the file.
`SkipProcessing`	`skp`	Skips processing for sources of the given formats, when the result would keep the source format.
`StripColorProfile`	`scp`	Converts the image to sRGB and removes its color profile.
`StripMetadata`	`sm`	Removes metadata, such as EXIF and IPTC, from the result.
`WebpOptions` Pro	`webpo`	Sets WebP encoder options.

Source

Class	imgproxy	Description
`FallbackImageUrl` Pro	`fiu`	Sets an image that is served when the source cannot be loaded.
`Hashsum` Pro	`hs`	Verifies the checksum of the source.
`MaxAnimationFrameResolution`	`mafr`	Limits the resolution of a single frame of animated sources.
`MaxAnimationFrames`	`maf`	Limits the number of frames of animated sources.
`MaxSourceFileSize`	`msfs`	Limits the file size of the source.
`MaxSourceResolution`	`msr`	Limits the resolution of the source.
`Page` Pro	`pg`	Selects the page or frame of a multi-page or animated source.
`Pages` Pro	`pgs`	Sets the number of pages that are stacked vertically in the result.
`Style` Pro	`st`	Injects CSS into SVG sources.
`VideoThumbnailAnimation` Pro	`vta`	Generates an animation from video frames.
`VideoThumbnailKeyframes` Pro	`vtk`	Restricts video thumbnails to keyframes.
`VideoThumbnailSecond` Pro	`vts`	Sets the second of a video that is used for the thumbnail.
`VideoThumbnailTile` Pro	`vtt`	Generates a sprite of video thumbnails.

Watermark

Class	imgproxy	Description
`Watermark` Partly Pro	`wm`	Places the watermark that is configured in imgproxy on the image.
`WatermarkRotate` Pro	`wmr`	Rotates the watermark clockwise.
`WatermarkShadow` Pro	`wmsh`	Adds a shadow to the watermark.
`WatermarkSize` Pro	`wms`	Sets the size of the watermark.
`WatermarkText` Pro	`wmt`	Renders a text as the watermark.
`WatermarkUrl` Pro	`wmu`	Sets the image that is used as the watermark.

Delivery

Class	imgproxy	Description
`CacheBuster`	`cb`	Adds a value to the URL that has no effect on processing, so caches treat the result as a new resource.
`Expires`	`exp`	Makes the URL expire.
`Preset`	`pr`	Applies presets that are configured in imgproxy.