Download the PHP package danihidayatx/image-optimizer without Composer

This package is a fork of joshembling/image-optimizer, updated to support Filament v4 & v5 and Laravel 12 & 13.

Optimize your Filament images before they reach your database.

When you currently upload an image using the native Filament component FileUpload, the original file is saved without any compression or conversion.

Additionally, if you upload an image and use conversions with SpatieMediaLibraryFileUpload, the original file is saved with its corresponding versions provided on your model.

What if you'd rather convert and reduce the image(s) before reaching your database/S3 bucket? Especially in the case where you know you'll never need to save the original image sizes the user has uploaded.

🤳 This is where Filament Image Optimizer comes in.

You use the same components as you have been doing and have access to two additional methods for maximum optimization, saving you a lot of disk space in the process. 🎉

Contents

• Contents
• Installation
• Usage
  • Optimizing Images
  • Dynamic Values (Closures)
  • Resizing Images
  • Combining Methods
  • Multiple Images
  • Examples
  • Debugging
• Changelog
• Contributing
• Security Vulnerabilities
• Credits
• Licence

Installation

You can install the package via composer, which works with Filament v3.x, v4.x & v5.x, and Laravel 10, 11, 12 & 13:

Usage

Filament version

You must be using Filament v3.x, v4.x or v5.x to have access to this plugin.

Server

GD Library must be installed on your server to compress images.

To ensure WebP images are previewed correctly in the admin panel, you may need to add the correct mime types to your server configuration.

Apache Users (.htaccess):

Nginx Users:

Ensure your mime.types file includes:

Optimizing images

Before uploading your image, you may choose to optimize it by converting to your chosen format. The file saved to your disk will be the converted version only.

E.g. I want to convert my image to 'webp':

`

You can do exactly the same using SpatieMediaLibraryFileUpload:

`

This also works with SpatieMediaLibraryFileUpload:

`

Uploaded image size is 640px x 360px.

You can do the same using SpatieMediaLibraryFileUpload:

`

Combining methods

You can combine these two methods for maximum optimization.

[!TIP] Most methods like resize(), maxImageWidth(), and maxImageHeight() also support Closures, allowing you to dynamically adjust settings based on form state.

`

Multiple images

You can also do this with multiple images - all images will be converted to the same format and reduced with the same percentage passed in. Just chain on multiple() to your upload:

`

Examples

Debugging

• If you see a 'not found' exception, including "Method optimize" or "Method resize", ensure you run composer update so that your lock file is in sync with your composer.json.

• You might see a 'Waiting for size' message and an infinite loading state on the component and the likely cause of this is a CORS issue. This can be quickly be resolved by ensuring you are serving and upload images from the same domain. Check your Javascript console for more information.

PHPStan / Static Analysis

Since the methods (optimize(), resize(), etc.) are registered at runtime using Laravel macros, PHPStan / Larastan might flag them as undefined methods.

This package ships with a PHPStan extension to automatically declare these methods.

A. Automatic (Recommended)

If your project uses phpstan/extension-installer, the extension will be discovered and loaded automatically. No additional configuration is required.

B. Manual

If you do not use the extension installer, you must manually register the extension in your project's phpstan.neon (or phpstan.neon.dist) file:

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• Dani Hidayat
• Josh Embling
• All Contributors

License

The MIT License (MIT). Please see License File for more information.