Bulk Image Regeneration
This module prebuilds image style derivatives in bulk for remote embeds, headless frontends, and CDNs, and helps diagnose issues with image styles and files. It allows you to target specific image fields and offers batch processing with a dry run mode to preview changes safely.
Bulk Image Regeneration prebuilds image style derivatives in bulk so they’re ready for remote embeds, headless frontends, and CDNs, and helps diagnose issues after migrations or style changes.
Features
- Prebuild derivatives: Ensures images are available when Drupal’s on‑demand generation isn’t triggered (remote JS embeds, headless, CDN warmups).
- Targeted by field: Regenerate only images referenced by selected image fields (
entity.bundle.field_name); avoids scanning entire filesystems. - Batch processing with dry run: Adjustable batch size and a dry‑run mode to preview work safely.
- Smart diagnostics: Summaries for missing entities, missing file entities, temporary files, orphaned files, and total references vs usable images.
- Style awareness: Skips image styles without effects; uses Drupal’s ImageStyle derivative API.
- Admin‑only: Access via a restricted permission and admin route.
Post-Installation
After enabling the module and granting the administer bulk image regeneration permission, go to:
- Config → Media → Bulk Image Regeneration (
/admin/config/media/bulk-image-regeneration)
Then:
- Select one or more Image styles (only styles with effects are processed).
- Select Content fields to target (
entity.bundle.field_name). - Set Batch size and enable Dry run to preview.
- Review Handle Orphaned Files (documented; currently behaves as “Skip”).
- Run the batch and review messages/logs (channel:
bulk_image_regeneration).
Notes: Only permanent file entities are processed. Derivatives use your current image toolkit and style effects. For large datasets, run smaller field/style passes during low traffic.
Additional Requirements
- Core modules:
file,image - Access to site file schemes (typically
public://, optionallyprivate://) - No external libraries required
Recommended modules/libraries
- ImageAPI Optimize (and preferred optimizers like reSmush.it) to improve quality/size of regenerated derivatives.
- A CDN or edge cache if pre‑warming for performance.
Similar projects
Other tools can flush or rebuild image styles globally or per entity. This module is differentiated by:
- Field‑targeted selection (
entity.bundle.field_name) to limit scope. - Operator diagnostics (missing/temporary/orphaned) and progress feedback.
- Simple admin UI aligned with Drupal Batch and ImageStyle APIs.