PHPackages                             alttextlab/alt-text-craftcms - 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. [Utility & Helpers](/categories/utility)
4. /
5. alttextlab/alt-text-craftcms

ActiveCraft-plugin[Utility & Helpers](/categories/utility)

alttextlab/alt-text-craftcms
============================

AI Alt Text generator for CraftCMS

1.5.1(3w ago)225proprietaryPHPPHP ^8.2

Since Aug 10Pushed 3w agoCompare

[ Source](https://github.com/alttextlab/alt-text-craftcms)[ Packagist](https://packagist.org/packages/alttextlab/alt-text-craftcms)[ RSS](/packages/alttextlab-alt-text-craftcms/feed)WikiDiscussions main Synced today

READMEChangelog (10)Dependencies (4)Versions (22)Used By (0)

AI Alt Text Generator for CraftCMS
==================================

[](#ai-alt-text-generator-for-craftcms)

The **[AI Alt Text Generator](https://alttextlab.com?utm_medium=integration&utm_source=craftcms&utm_campaign=github) for CraftCMS** is a plugin that automatically creates high-quality, descriptive alt text for images in your CraftCMS media library. Powered by the [AltTextLab](https://alttextlab.com) API, it uses advanced AI to generate accessible and SEO-friendly image descriptions, saving you time and improving your website’s accessibility compliance.

**[GitHub Repository](https://github.com/alttextlab/alt-text-craftcms)** - **[Plugin Store](https://plugins.craftcms.com/alt-text-lab)**

Features
--------

[](#features)

- **Automatic alt text generation** – Instantly generate alt text for newly uploaded images without any manual work.
- **Bulk alt text generation for your media library** – Quickly create alt text for all existing images in your CraftCMS media library in one go.
- **Multi-language support** – Generate alt text in over 130 languages.
- **Multi-site support** – Automatically generate alt text in each site's language. One API call per unique language, with results shared across sites that use the same language.
- **Easy setup & Free trial** – Simple installation process with a free trial so you can start improving accessibility right away.

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

[](#requirements)

This plugin requires:

- Craft CMS 5.0.0 or later
- PHP 8.2 or later
- AltTextLab API key (You can create one [here](https://app.alttextlab.com/settings/api-keys?utm_medium=integration&utm_source=craftcms&utm_campaign=github))

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

[](#installation)

You can install this plugin from the [Plugin Store](https://plugins.craftcms.com/alt-text-lab) or with Composer.

Setup Alt Text Generator
------------------------

[](#setup-alt-text-generator)

1. Make sure the plugin is installed in your CraftCMS.
2. If you don’t have an AltTextLab account yet, create one [here](https://www.alttextlab.com/?utm_medium=integration&utm_source=craftcms&utm_campaign=github).
3. Go to the [API Keys page](https://app.alttextlab.com/settings/api-keys?utm_medium=integration&utm_source=craftcms&utm_campaign=github) and create a new API key by clicking **Create API Key**. Copy the generated key.
4. In CraftCMS, open the plugin settings (**AltTextLab → Settings**) and paste the API key into the **AltTextLab API Key** field. Save the changes.
5. The plugin is ready to use!

How to use Alt Text Generator
-----------------------------

[](#how-to-use-alt-text-generator)

- **Automatic Alt Text Generation**
    Enable the **Auto-generate alt text for new assets** switch in the plugin settings. Once enabled, the plugin will automatically generate alt text for all newly uploaded images.
- **Bulk Generation for the Entire Media Library**
    To generate alt text for all images in your CraftCMS media library, go to **AltTextLab → Bulk Generation** and click **Run generation**.
    This will create a new Job, which you can track in **Queue Manager** or under **AltTextLab → Bulk Generation History**.
- **Bulk Generation for Selected Media**
    If you only want to generate alt text for specific images, select them in the **Assets** tab, open the menu, and choose **Bulk generation**.

Settings
--------

[](#settings)

All settings are available under **AltTextLab → Settings**.

### Auto-generate alt text for new assets

[](#auto-generate-alt-text-for-new-assets)

When enabled, the plugin automatically generates alt text for every newly uploaded image. Generation takes a few seconds, so the alt text may not appear immediately — simply check again after a short delay.

### Automatically use each site's language (multi-site)

[](#automatically-use-each-sites-language-multi-site)

Enable this switch to generate alt text in the language configured for each Craft site (under **Settings → Sites**) instead of using a single language.

When this mode is active:

1. The plugin reads the language from each site's locale (e.g. `en-US`, `de`, `fr`).
2. Sites that share the same language are grouped together — only one API call is made per unique language, keeping usage efficient.
3. Alt text is saved separately for every site, so each localized version of an asset gets its own description.

**Important:** The alt text field (native `alt` or your custom field) must have its **Translation Method** set to *Translate for each site* or *Translate for each language*. You can configure this in **Settings → Assets** (for the native `alt` field) or **Settings → Fields** (for custom fields). The plugin will show a warning if the field is not translatable.

### Language

[](#language)

Choose a language for generated alt text from the **Language** dropdown (130+ languages available). When the multi-site switch above is off, every asset receives alt text in this language regardless of which site it belongs to. When the multi-site switch is on, this dropdown is ignored.

### Model type

[](#model-type)

Select the style of generated descriptions:

- **Use account default** — uses the style configured in your AltTextLab account.
- **Descriptive** — rich, detailed descriptions.
- **Neutral** — balanced tone without subjective language.
- **Matter-of-fact** — concise, objective descriptions.
- **Minimal** — shortest possible descriptions.

### Field for Alt Text

[](#field-for-alt-text)

Choose which field the plugin writes alt text to. By default, the native **Alt** field is used. You can also select any **Plain Text** custom field attached to your Asset volume's field layout.

If you change this setting after assets have already been processed, use **Bulk Generation** to re-generate alt text into the new field.

### This site is reachable over the public internet

[](#this-site-is-reachable-over-the-public-internet)

Once your site is publicly accessible and each image can be reached over the internet, we highly recommend enabling this setting. It makes the generation process faster and ensures that images are not transferred or processed on our servers.

If you are developing locally or your site is not publicly accessible, keep this setting disabled.

### Disable volumes (Exclude Specific Images)

[](#disable-volumes-exclude-specific-images)

Select one or more Asset Volumes to exclude from alt text generation. Assets stored in disabled volumes will be skipped during both automatic and bulk generation.

### Exclude Images by regex

[](#exclude-images-by-regex)

For finer control, you can exclude files by matching their full file system path with a regular expression. Define the following environment variable in your `.env` file:

```
# Examples (pick one and adjust to your needs)
ALT_TEXT_LAB_EXCLUDE_REGEX=~/(thumbnails|icons)/~i
# Or exclude anything in /uploads/tmp/
# ALT_TEXT_LAB_EXCLUDE_REGEX=~/uploads/tmp/~
# Or exclude all SVGs inside "branding" folder
# ALT_TEXT_LAB_EXCLUDE_REGEX=~branding/.+\.svg$~i
```

Notes:

- The pattern is applied against the asset's full local path, which includes the volume file system path, optional `subpath`, and the asset path.
- You may provide a PCRE pattern with delimiters (e.g., `~/pattern/~i`). If you omit delimiters, the plugin will attempt to wrap your pattern automatically.
- Regex-based exclusions apply to both automatic generation and bulk operations.

Craft Commerce Integration
--------------------------

[](#craft-commerce-integration)

If you have [Craft Commerce](https://craftcms.com/commerce) installed, the plugin can automatically enrich alt text generation with product context. When an image is linked to a Commerce product or variant, the plugin reads product data (name, brand, color, material) and sends it to the AltTextLab API alongside the image. This allows the AI to generate more accurate, product-specific descriptions — for example, *"Blue cotton t-shirt with a round neck"* instead of a generic *"A t-shirt on a white background"*.

The Commerce section appears in plugin settings only when the Commerce plugin is installed and enabled.

### How it works

[](#how-it-works)

1. At generation time, the plugin checks whether the asset is related to any Commerce **variant** or **product**.
2. If a linked variant is found, its parent product is resolved automatically.
3. The configured product fields (name, brand, color, material) are read and passed to the API as additional context.
4. If no linked product or variant is found, generation proceeds as usual without any extra context.

### Commerce Settings

[](#commerce-settings)

All Commerce settings are available under **AltTextLab → Settings → Commerce**.

#### Product name for alt text

[](#product-name-for-alt-text)

Controls which title is sent to the API as the product name:

- **Use product name** *(default)* — uses the title of the linked product.
- **Use variant title** — uses the title of the linked variant (useful when variant titles carry colour/size information, e.g. *"Blue / XL"*). Falls back to the product title if no variant is linked.

#### Brand field handle

[](#brand-field-handle)

The handle of a Plain Text (or similar) field on the **product** that stores the brand name (e.g. `brand`). Leave empty to skip brand context entirely.

> **Example:** if your products have a field with handle `brand` containing *"Acme Co."*, enter `brand` here and the AI will receive that value as additional context.

#### Color source

[](#color-source)

Determines which element the color field is read from:

- **Use product color field** *(default)* — reads the color field from the product.
- **Use variant color field** — reads the color field from the variant (useful for products where color is a variant-level attribute).

#### Color field handle

[](#color-field-handle)

The handle of the field that stores the color value (e.g. `color`). Can point to the product or variant depending on **Color source**. Leave empty to skip color context.

#### Material source

[](#material-source)

Determines which element the material field is read from:

- **Use product material field** *(default)* — reads the material field from the product.
- **Use variant material field** — reads the material field from the variant.

#### Material field handle

[](#material-field-handle)

The handle of the field that stores the material value (e.g. `material`). Can point to the product or variant depending on **Material source**. Leave empty to skip material context.

---

> **Tip:** You can mix sources. For example, set **Product name** to *Use variant title*, **Color source** to *Use variant color field*, and **Material source** to *Use product material field* — the plugin will read each attribute from the appropriate element independently.

Supported File Types
--------------------

[](#supported-file-types)

The Alt Text Generator for CraftCMS supports the following image formats:

- **JPEG / JPG**
- **PNG**
- **WebP**
- **AVIF**
- **SVG**

Troubleshooting
---------------

[](#troubleshooting)

- The plugin includes a **AltTextLab → Logs** page where you can view any errors related to alt text generation.
- Alt text generation for bulk operations is processed through Craft's queue system, so if generation seems to be taking a long time, check the **Queue Manager**.
- All errors should also be logged, review your `queue.log` files for more details.

Support & Feedback
----------------------

[](#support--feedback)

If you enjoy the plugin, please [leave a review on the Plugin Store](https://plugins.craftcms.com/alt-text-lab/reviews) — it helps other Craft developers discover it.

Found a bug or have an idea for improvement? [Open an issue on GitHub](https://github.com/alttextlab/alt-text-craftcms/issues).

For general questions or help getting started:

- **Website:** [https://www.alttextlab.com](https://www.alttextlab.com?utm_medium=integration&utm_source=craftcms&utm_campaign=github)
- **Support Email:**
- [Contact us](https://www.alttextlab.com/contact?utm_medium=integration&utm_source=craftcms&utm_campaign=github)

###  Health Score

45

—

FairBetter than 91% of packages

Maintenance94

Actively maintained with recent releases

Popularity8

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity58

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 68.5% 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 ~30 days

Recently: every ~61 days

Total

11

Last Release

24d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/208139019?v=4)[AltTextLab - AI alt text generator](/maintainers/alttextlab)[@alttextlab](https://github.com/alttextlab)

---

Top Contributors

[![andreizanik](https://avatars.githubusercontent.com/u/3517891?v=4)](https://github.com/andreizanik "andreizanik (37 commits)")[![HrabarDzmitry](https://avatars.githubusercontent.com/u/208184102?v=4)](https://github.com/HrabarDzmitry "HrabarDzmitry (17 commits)")

---

Tags

accessibilityalt-textalt-text-generatorcraftcmscraftcms-pluginaiaccessibilitycraftcmscraft-pluginseoalt text

### Embed Badge

![Health badge](/badges/alttextlab-alt-text-craftcms/health.svg)

```
[![Health](https://phpackages.com/badges/alttextlab-alt-text-craftcms/health.svg)](https://phpackages.com/packages/alttextlab-alt-text-craftcms)
```

###  Alternatives

[nystudio107/craft-seomatic

SEOmatic facilitates modern SEO best practices & implementation for Craft CMS 5. It is a turnkey SEO system that is comprehensive, powerful, and flexible.

1741.5M58](/packages/nystudio107-craft-seomatic)[verbb/formie

The most user-friendly forms plugin for Craft.

102393.6k69](/packages/verbb-formie)[verbb/comments

Add comments to your site.

13753.9k](/packages/verbb-comments)[verbb/vizy

A flexible visual editor field for Craft.

4250.4k](/packages/verbb-vizy)[verbb/hyper

A user-friendly links field for Craft.

24147.8k12](/packages/verbb-hyper)[verbb/workflow

Enforce multi-step review processes for creating entries.

138124.1k1](/packages/verbb-workflow)

PHPackages © 2026

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