Download the PHP package ksubileau/color-thief-php without Composer

Color Thief PHP

A PHP library for grabbing the dominant color or a representative color palette from an image.

It is a PHP port of the Color Thief Javascript library, using the MMCQ (modified median cut quantization) algorithm from the Leptonica library.

See examples

Why Color Thief?

Extracting meaningful colors from an image unlocks a surprising range of use cases: generating dynamic themes that match a user's uploaded avatar, building visually coherent product cards from cover art, creating adaptive UI backgrounds for music or video players, or simply analyzing the dominant hues of a dataset of images.

Color Thief PHP does this for you, without any manual color-picking, and returns results in the color format that suits you: hex, CSS rgb(), HSL, OKLCH, CMYK, or a plain integer. You can ask for a single dominant color, a ranked palette of up to 20 colors, or semantic swatches (Vibrant, Muted, DarkVibrant, etc.).

Requirements

• PHP 8.2 or higher
• Fileinfo extension
• One or more PHP extensions for image processing:
  • GD >= 2.0
  • Imagick >= 2.0 (but >= 3.0 for CMYK images)
  • Gmagick >= 1.0
• Supports JPEG, PNG, GIF and WEBP images.

Getting started

Install via Composer

The recommended way to install Color Thief is through Composer:

Get the dominant color

All functionality is exposed through the ColorThief\ColorThief class. Instantiate it once and reuse it across multiple images.

getColor() returns a RgbColor object (or null if no color could be extracted), with a set of utility methods to get the color representation that suits you.

Get a color palette

getPalette() returns a ColorPalette object, which is countable, iterable, and array-accessible. Colors are ordered from most to least dominant.

Get semantic swatches

getSwatches() classifies the palette colors into up to six named roles: vibrant, muted, darkVibrant, darkMuted, lightVibrant, and lightMuted. Each property holds an RgbColor or null if no palette color matched that role.

Accepted image sources

All three methods accept the same types for the $sourceImage parameter:

• A file path string: '/path/to/image.jpg' (You must ensure that the path is sanitized before calling ColorThief)
• A GD resource (\GdImage)
• An Imagick instance
• A Gmagick instance
• Raw image binary content as a string

Note: Loading images from URLs is no longer supported in v3. If you need to process a remote image, fetch it yourself before passing the content to Color Thief (see Migrating from v2 to v3).

Working with Color Objects

Every method returns RgbColor objects (or collections of them), with a rich set of chainable conversion and utility methods.

Converting a single color

Available conversion targets from any color object: toRgb(), toOklch(), toHsl(), toHsv(), toCmyk().

Converting a palette

ColorPalette mirrors the same conversion methods, applied to all colors at once:

Advanced Configuration

Constructor options

All configuration is passed to the ColorThief constructor. Every parameter is optional and falls back to a sensible default:

Overriding options per call with with()

ColorThief instances are immutable. If you need different settings for a specific call without affecting the base configuration, use with() by calling it with named arguments. It accepts the exact same parameters as the constructor and returns a new instance with only the specified options overridden. The original instance is left unchanged.

Adjusting pixel filters

Restricting extraction to a region

Use ImageRegion to analyze only a rectangular crop of the image:

API Reference

ColorThief

Methods

getColor(mixed $sourceImage, ?ImageRegion $region = null): ?RgbColor Returns the single most dominant color, or null if the image yields no usable pixels.

getPalette(mixed $sourceImage, int $colorCount = 10, ?ImageRegion $region = null): ColorPalette<RgbColor> Returns a palette of dominant colors (2–20). Colors are ordered most to least dominant.

getSwatches(mixed $sourceImage, ?ImageRegion $region = null): ColorSwatches Returns semantic swatches classified into six named roles: Vibrant, Muted, DarkVibrant, DarkMuted, LightVibrant, and LightMuted.

with(...): self Returns a new ColorThief instance with the specified options overridden. All arguments are optional and default to the current instance's setting.

ColorPalette<TColor>

An immutable, ordered, array-accessible collection of color objects.

ColorPalette implements ArrayAccess, Countable, and IteratorAggregate, so it supports foreach, count(), and $palette[0] access.

Color classes

All color classes (RgbColor, HslColor, HsvColor, OklchColor, CmykColor) share these members.

Population and weight

Conversions

Contrast and accessibility helpers

Channel accessors (specific per colorspace implementation)

RgbColor

HslColor

HsvColor

OklchColor

CmykColor

ColorSwatches

Returned by getSwatches(). All properties are public and readonly.

Any property may be null if no palette color qualified for that role.

ImageRegion

Defines a rectangular crop for color extraction.

All properties are public and readonly. width and height default to null, meaning the region extends to the image's right and bottom edges respectively.

Exceptions

All exceptions live under ColorThief\Exception\ and extend a common base:

Migrating from v2.x to v3.x

ColorThief PHP v3.x brings major changes to the library's API, which has been thoroughly redesigned and modernized. Here's everything you need to perform the update.

The class is now instantiated, not called statically

The most visible change: ColorThief is no longer a class with static methods. You instantiate it and call methods on the instance.

Configuration is passed to the constructor, not as method arguments

In v2, options like quality and output format were passed as positional arguments to each method call. In v3, all configuration lives on the ColorThief instance. Use with() to derive variants.

The $format parameter has been removed

v2's getColor() and getPalette() accepted a $format string ('rgb', 'hex', 'int', 'array', 'obj') to control the return type. In v3, methods always return typed color objects. Convert to any format you need using the conversion methods.

RGB channel getters have been renamed

v2 exposed getRed(), getGreen(), and getBlue() on the color object. In v3 these are red(), green(), and blue().

URL loading has been removed

Passing a URL string to getColor() or getPalette() will now throw a NotReadableException. URL fetching was removed to prevent Server-Side Request Forgery (SSRF) vulnerabilities.

Fetch the image yourself and pass the binary content:

OKLCH is now the default quantization color space

v3 uses OKLCH internally by default, which produces more perceptually uniform palettes. If your application depends on the exact palette output of v2, you can restore the old behavior:

Maximum palette size reduced to 20

getPalette() now accepts a colorCount between 2 and 20 (v2 allowed up to 256). Requests above 20 will throw an InvalidArgumentException.

Edge-case behavior for degenerate images

In v2, fully transparent, fully white, or single-color images could throw exceptions. In v3 they return a graceful result instead: a single-color palette containing black (transparent images), white (all-white images), or the single color itself.

Region parameter replaces positional $area array

The optional area/region parameter in v2 was an associative array. In v3 it is a typed ImageRegion object, passed as a named argument.

Credits

Author

by Kevin Subileau kevinsubileau.fr

Based on the fabulous work done by Lokesh Dhakar lokeshdhakar.com twitter.com/lokesh

Thanks

• Lokesh Dhakar - For creating the original project.
• Nick Rabinowitz - For creating quantize.js.

License

Licensed under the MIT License.