PHPackages                             spacecatninja/imager-x-imagekit-transformer - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Image & Media](/categories/media)
4. /
5. spacecatninja/imager-x-imagekit-transformer

ActiveCraft-plugin[Image & Media](/categories/media)

spacecatninja/imager-x-imagekit-transformer
===========================================

ImageKit transformer for Imager X

2.0.1(2y ago)044↑650%1MITPHPPHP ^8.2

Since Apr 8Pushed 2y ago1 watchersCompare

[ Source](https://github.com/spacecatninja/craft-imager-x-imagekit-transformer)[ Packagist](https://packagist.org/packages/spacecatninja/imager-x-imagekit-transformer)[ RSS](/packages/spacecatninja-imager-x-imagekit-transformer/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (2)Versions (9)Used By (0)

ImageKit transformer for Imager X
=================================

[](#imagekit-transformer-for-imager-x)

A plugin for using [ImageKit](https://imagekit.io/) as a transformer in Imager X.
Also, an example of [how to make a custom transformer for Imager X](https://imager-x.spacecat.ninja/extending.html#transformers).

Requirements
------------

[](#requirements)

This plugin requires Craft CMS 5.0.0-beta.1 or later, [Imager X 5.0.0-beta.1](https://github.com/spacecatninja/craft-imager-x/) or later, and an account at [ImageKit](https://imagekit.io/).

Usage
-----

[](#usage)

Install and configure this transformer as described below. Then, in your [Imager X config](https://imager-x.spacecat.ninja/configuration.html), set the transformer to `imagekit`, ie:

```
'transformer' => 'imagekit',

```

Transforms are now by default transformed with ImageKit, test your configuration with a simple transform like this:

```
{% set transform = craft.imagerx.transformImage(asset, { width: 600 }) %}

URL is: {{ transform.url }}

```

If this doesn't work, make sure you've configured a `defaultProfile`, have a profile with the correct name, and that ImageKit is configured correctly.

### Cave-ats, shortcomings, and tips

[](#cave-ats-shortcomings-and-tips)

This transformer only supports a subset of what Imager X can do when using the default `craft` transformer. All the basic transform parameters are supported, with the following exceptions:

- Focal points are translated to focus anchor points (ie `top`, `left`, `center`, etc).
    – Watermarks are not translated automatically from Imager syntax to ImageKit's, but you can still add watermarks by manually passing them through the `transformerParams` object (see below).
- No effects are currently converted automatically.

To pass additional options directly to ImageKit, you can use the `transformerParams` transform parameter and pass them in using an `options` object. Example:

```
{% set transforms = craft.imagerx.transformImage(asset,
    [{width: 400}, {width: 600}, {width: 800}],
    { ratio: 2/1, transformerParams: { rotation: 45 } }
) %}

```

Refer to the [ImageKit PHP SDK](https://github.com/imagekit-developer/imagekit-php) for parameters to use, and the [ImageKit documentation](https://docs.imagekit.io/) for more information.

Installation
------------

[](#installation)

To install the plugin, follow these instructions:

1. Install with composer via `composer require spacecatninja/imager-x-imagekit-transformer` from your project directory.
2. Install the plugin in the Craft Control Panel under Settings > Plugins, or from the command line via `./craft plugin/install imager-x-imagekit-transformer`.

Configuration
-------------

[](#configuration)

You can configure the transformer by creating a file in your config folder called `imager-x-imagekit-transformer.php`, and override settings as needed.

### publicKey \[string\]

[](#publickey-string)

Default: `''`
Public key for your ImageKit account (Developer Options > API Keys, in ImageKit).

### privateKey \[string\]

[](#privatekey-string)

Default: `''`
Private key for your ImageKit account (Developer Options > API Keys, in ImageKit).

### signUrls \[bool\]

[](#signurls-bool)

Default: `false`
Toggle this on to generate signed URLs. This is required if "Restrict unsigned image URLs" in Settings > Images > Security is turned on.

### signedUrlsExpireSeconds \[int\]

[](#signedurlsexpireseconds-int)

Default: `31536000` (one year)
Duration for signed URLs.

### stripUrlQueryString \[bool\]

[](#stripurlquerystring-bool)

Default: `true`
By default all query strings are stripped from full URLs passed to ImageKit, to improve caching. If you use full URLs that rely on query strings, you can toggle this off to make them work.

### profiles \[array\]

[](#profiles-array)

Default: `[]`
Profiles are usually a one-to-one mapping to the URL endpoints you've created in ImageKit. But due to the nature of ImageKit URL endpoints, where you can mix different storages per endpoint, it could also make sense to create several profiles for one endpoint for different use-cases (ie, one to use as a web proxy and the other for relative paths). You set the default profile to use using the `defaultProfile` config setting, and can override it at the template level by setting `profile` in your `transformerConfig`.

Example profile:

```
'profiles' => [
    'default' => [
        'urlEndpoint' => 'https://ik.imagekit.io/myurlendpoint',
        'isWebProxy' => false,
        'useCloudSourcePath' => true,
    ],
    'proxy' => [
        'urlEndpoint' => 'https://ik.imagekit.io/myotherurlendpoint',
        'isWebProxy' => true
    ]
],

```

Each profile has the following settings:

#### urlEndpoint \[string\]

[](#urlendpoint-string)

Default: `''`
This is the URL endpoint you created in ImageKit.

#### isWebProxy \[bool\]

[](#iswebproxy-bool)

Default: `false`
Indicates if the URL endpoint uses a web proxy or not. If enabled, full URLs will be passed to ImageKit, instead of the relative path to the asset.

#### defaultParams \[array\]

[](#defaultparams-array)

Default: `[]`
Default params to be passed to every transform.

#### useCloudSourcePath \[bool\]

[](#usecloudsourcepath-bool)

Default: `false`
If enabled, Imager will prepend the Craft file system path to the asset path, before adding it to the ImageKit URL. This makes it possible to have one ImageKit source pulling images from many Craft file systems when they are for instance on the same S3 bucket, but in different subfolder. This only works on file systems that implements a path setting (AWS S3 and GCS does, local volumes does not).

#### addPath \[string|array\]

[](#addpath-stringarray)

Default: `[]`
Prepends a path to the asset's path. Can be useful if you have several volumes that you want to serve with one ImageKit source. If this setting is an array, the key should be the volume handle, and the value the path to add.

### defaultProfile \[string\]

[](#defaultprofile-string)

Default: `''`
Sets the default profile to use (see `profiles`). You can override profile at the transform level by setting it through the `transformParams` transform parameter. Example:

```
{% set transforms = craft.imagerx.transformImage(asset,
    [{width: 800}, {width: 2000}],
    { transformerParams: { profile: 'myotherprofile' } }
) %}

```

### defaultParams \[array\]

[](#defaultparams-array-1)

Default: `[]`
Default params to pass to all transforms.

### purgeEnabled \[bool\]

[](#purgeenabled-bool)

Default: `true`
Toggles automatic purging on/off.

Price, license and support
--------------------------

[](#price-license-and-support)

The plugin is released under the MIT license. It requires Imager X, which is a commercial plugin [available in the Craft plugin store](https://plugins.craftcms.com/imager-x). If you need help, or found a bug, please post an issue in this repo, or in Imager X' repo (preferably).

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity10

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~51 days

Recently: every ~62 days

Total

8

Last Release

767d ago

Major Versions

1.1.1 → 2.0.02024-02-11

1.1.2 → 2.0.12024-04-05

PHP version history (2 changes)1.0.0PHP ^8.0

2.0.0PHP ^8.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/806fbb515be53ddbca1d658f1abe7f8ddd41d77b72eec8aa85800db3a03e7e35?d=identicon)[spacecatninja](/maintainers/spacecatninja)

---

Top Contributors

[![aelvan](https://avatars.githubusercontent.com/u/2675644?v=4)](https://github.com/aelvan "aelvan (11 commits)")

---

Tags

imagecmstransformresponsiveCraftcraftcmscraft-pluginpicturesrcset

### Embed Badge

![Health badge](/badges/spacecatninja-imager-x-imagekit-transformer/health.svg)

```
[![Health](https://phpackages.com/badges/spacecatninja-imager-x-imagekit-transformer/health.svg)](https://phpackages.com/packages/spacecatninja-imager-x-imagekit-transformer)
```

###  Alternatives

[spacecatninja/imager-x

Ninja powered image transforms.

29390.0k23](/packages/spacecatninja-imager-x)[nystudio107/craft-imageoptimize

Automatically create & optimize responsive image transforms, using either native Craft transforms or a service like imgix, with zero template changes.

232337.2k16](/packages/nystudio107-craft-imageoptimize)[nystudio107/craft-youtubeliveembed

This plugin allows you to embed a YouTube live stream and/or live chat on your webpage

163.7k](/packages/nystudio107-craft-youtubeliveembed)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)