Omni Image Optimizer Documentation

Version: 1.1.0

Introduction

omni Image Optimizer is a powerful WordPress plugin designed to enhance your website's image management and SEO. It automatically renames uploaded images using your site name, converts images to WebP format, optimizes image dimensions, and generates SEO-friendly ALT text and metadata using OpenAI Vision API.

Installation

1. Download the omni Image Optimizer plugin ZIP file.
2. Log in to your WordPress admin panel.
3. Navigate to Plugins → Add New → Upload Plugin.
4. Click "Choose File" and select the downloaded ZIP file.
5. Click "Install Now" and wait for the installation to complete.
6. Click "Activate Plugin" to activate omni Image Optimizer.

After activation, you'll find the omni Image Optimizer settings under Settings → Image Optimizer in your WordPress admin menu.

General Settings

The General Settings section allows you to enable or disable the plugin functionality.

Enable Image Optimizer

Toggle this option to enable or disable the plugin. When disabled, images will be uploaded normally without any modifications.

File Naming Settings

Control how your uploaded images are renamed.

File Naming Pattern

Choose a pattern for renaming uploaded images. Available options:

• Site Name - Original Filename: Prepends your site name to the original filename.
• Site Name - Random String: Uses your site name followed by a random string.
• Site Name - Date - Original Filename: Includes the site name, current date, and original filename.
• Original Filename (No Change): Keeps the original filename without modifications.

Image Optimization Settings

Configure how images are optimized during upload.

Convert to WebP

Toggle this option to automatically convert uploaded images to WebP format. WebP provides superior compression and quality characteristics compared to JPEG and PNG formats, resulting in smaller file sizes and faster loading times.

Maximum Width (px)

Set the maximum width for uploaded images. Images wider than this value will be resized while maintaining the aspect ratio. Leave empty or set to 0 to keep the original width.

Maximum Height (px)

Set the maximum height for uploaded images. Images taller than this value will be resized while maintaining the aspect ratio. Leave empty or set to 0 to keep the original height.

JPEG Quality

Set the quality level for JPEG images (1-100). Higher values result in better image quality but larger file sizes. The recommended value is 80-90 for a good balance between quality and file size.

WebP Quality

Set the quality level for WebP images (1-100). Higher values result in better image quality but larger file sizes. The recommended value is 80-90 for a good balance between quality and file size.

Watermark Settings

Configure text watermarks for your images.

Enable Watermark

Toggle this option to add a text watermark to uploaded images.

Watermark Text

Enter the text to use as a watermark. This could be your website name, copyright information, or any other text you want to display on your images.

Watermark Position

Choose where to place the watermark on the image:

• Top Left
• Top Center
• Top Right
• Middle Left
• Middle Center
• Middle Right
• Bottom Left
• Bottom Center
• Bottom Right

Watermark Opacity

Set the opacity level for the watermark (0-100). Lower values make the watermark more transparent.

AI Settings

Configure the OpenAI integration for automatic ALT text and metadata generation.

OpenAI API Key

Enter your OpenAI API key to enable AI features. You can obtain an API key from the OpenAI website.

Enable AI Features

Toggle this option to enable or disable AI-powered features. When enabled, the plugin will use OpenAI's Vision API to analyze images and generate appropriate ALT text and metadata.

ALT Text Pattern

Choose how ALT text should be generated:

• Description Only: Uses only the AI-generated description.
• Keywords + Description: Combines keywords and description.
• Custom Pattern: Uses a custom pattern defined below.

Custom ALT Text Pattern

If you selected "Custom Pattern" above, enter your pattern here. You can use the following placeholders:

• {description}: AI-generated description of the image
• {keywords}: AI-generated keywords for the image
• {site_name}: Your website name

Auto-fill Image Title

Toggle this option to automatically fill the image title using AI-generated content.

Auto-fill Image Caption

Toggle this option to automatically fill the image caption using AI-generated content.

Auto-fill Image Description

Toggle this option to automatically fill the image description using AI-generated content.

Keywords

Enter optional keywords to guide the AI in generating more relevant descriptions. Separate multiple keywords with commas.

Bulk Processing

The Bulk Processing feature allows you to apply image optimization and AI metadata generation to existing images in your media library.

Process Images

Choose which images to process:

• Only images without ALT text: Process only images that don't have ALT text.
• All images (overwrite existing): Process all images, overwriting any existing ALT text and metadata.
• Recent images: Process images uploaded within a selected time period.

Time Period Selection

When "Recent images" is selected, you can choose from various time periods:

• Last 7 days
• Last 14 days
• Last 30 days
• Last 60 days
• Last 90 days
• Last 6 months
• Last year

Batch Size

Choose how many images to process in each batch:

• 1 image per batch (safest): Slowest but most reliable option.
• 3 images per batch (recommended): Good balance between speed and reliability.
• 5 images per batch (faster): Faster but may hit API rate limits.

Bulk Processing Steps

1. Select your desired filter (images without ALT text, all images, or recent images).
2. The plugin will automatically check how many images match your criteria.
3. Click "Start Processing" to begin the bulk operation.
4. Monitor the progress in the log section.
5. You can stop the processing at any time by clicking "Stop Processing".

Frequently Asked Questions

Does this plugin modify my original images?

Yes, the plugin modifies uploaded images according to your settings. It's recommended to keep backups of your original images if needed.

Will converting to WebP affect browser compatibility?

WebP is supported by all modern browsers. For older browsers that don't support WebP, WordPress will automatically serve the original format.

How much does the OpenAI integration cost?

The cost depends on your usage and OpenAI's current pricing. The plugin uses the Vision API, which is charged based on the number of API calls and tokens used.

Can I use this plugin without the OpenAI features?

Yes, you can use the image optimization, renaming, and watermarking features without enabling the AI features.

Will the plugin affect my existing images?

No, the plugin only affects newly uploaded images unless you specifically use the Bulk Processing feature to modify existing images.

Troubleshooting

Images are not being optimized

• Make sure the "Enable Image Optimizer" option is turned on.
• Check if your server has the GD library installed and enabled.
• Verify that WordPress has write permissions to the uploads directory.

Watermark is not appearing

• Ensure the "Enable Watermark" option is turned on.
• Try increasing the opacity if the watermark is too transparent.
• Check if your server has TTF font support or try a different position.

AI features are not working

• Verify that you've entered a valid OpenAI API key.
• Make sure the "Enable AI Features" option is turned on.
• Check if your OpenAI account has sufficient credits.
• Ensure your server can make outbound HTTP requests to the OpenAI API.

Bulk processing stops or shows errors

• Try reducing the batch size to 1 image per batch.
• Check your browser console for JavaScript errors.
• Verify that your server's PHP timeout settings are sufficient for processing large images.
• Check if you're hitting OpenAI API rate limits.