-
Notifications
You must be signed in to change notification settings - Fork 10
/
Copy pathreadme.txt
executable file
·339 lines (207 loc) · 19.1 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
=== Image Optimization by Optimole – Lazy Load, CDN, Convert WebP & AVIF, Optimize Images ===
Contributors: optimole
Tags: image optimization, convert webp, image optimizer, lazy load, image, optimisation, convert AVIF, resize, free cdn, compress images, optimize images
Requires at least: 5.5
Tested up to: 6.8
Requires PHP: 7.4
Stable tag: 4.0.2
License: GPLv3
License URI: https://www.gnu.org/licenses/gpl-3.0.en.html
Automatically compress, optimize, and serve scaled images as well as convert WebP & AVIF, all from CloudFront CDN. Lazy load included ⚡
== Description ==
Optimole is the complete image optimization powerhouse that helps you compress images automatically, resize them, and deliver your images via lightning-fast CDN from 450+ locations. With WebP and AVIF conversion, intelligent lazy loading, and ML-powered optimization, Optimole dramatically improves page speed, Core Web Vitals, and SEO rankings—all with zero configuration required. Say goodbye to slow-loading images and hello to a faster website that visitors and search engines will love.
### ⚡ Quick Links
- [Test Your Site](https://optimole.com/test-drive/?utm_source=wpadmin&utm_medium=readme&utm_campaign=optimole) - See how much faster we can make your site
- [Documentation](https://docs.optimole.com/) - Learn how to use all features
- [Support Forum](https://wordpress.org/support/plugin/optimole-wp/) - Get help from our team
- [How to Speed Up WordPress](https://optimole.com/how-to-speed-up-wordpress/?utm_source=wpadmin&utm_medium=readme&utm_campaign=optimole) - Essential optimization tips
- [Go Pro](https://optimole.com/pricing/?utm_source=wpadmin&utm_medium=readme&utm_campaign=optimole) - Upgrade for more monthly visits
### 🚀 Summary of What Optimole Does
- **Compress images without quality loss** - ML-powered technology preserves details
- **Global AWS CloudFront CDN** - 450+ locations for instant loading
- **WebP & AVIF conversion** - Up to 80% smaller file sizes
- **Complete image offloading** - Store images in the cloud and free up server space with one-click restoration
- **jQuery-free lazy loading** - Improves Core Web Vitals
- **Adaptive image sizing** - Perfect fit for every device
- **Cloud media library** - Manage assets across multiple sites
- **Support for all file types** - Images, video, audio, documents
- **Automatic watermarking** - Protect your visual content
- **Zero configuration needed** - Install and forget
- **Free plan with all features** - For sites with up to 1K [visits](https://docs.optimole.com/article/1134-how-optimole-counts-the-number-of-visitors)/month
### Why Choose Optimole Over Other Image Optimization Plugins?
- **Truly Automated Optimization** – Install once and let our cloud-based system handle everything
- **Compress images in bulk** - Process your entire media library with one click
- **Smaller Images, Same Visual Quality** – Advanced ML-powered compression preserves image details
- **Perfect Size for Every Device** – Images dynamically resized for each visitor's exact screen dimensions
- **Lightning-Fast Global CDN** – Free delivery from 450+ locations worldwide for instant loading
- **Automatic Next-Gen Formats** – WebP and AVIF conversion reduces file size by up to 80%
- **Zero Server Resource Usage** – All processing happens in our cloud, keeping your hosting resources free
- **WooCommerce Performance Boost** – Optimized product galleries load faster, increasing conversions
- **Eliminate Content Shifting** – Perfect placeholder dimensions prevent Cumulative Layout Shift (CLS)
- **Significant Core Web Vitals** Improvement – Lower Largest Contentful Paint (LCP) scores
- **Complete Media Management** – Cloud library with Digital Asset Management features
https://youtu.be/siCm0fhNes0
### What’s the Magic Behind Optimole’s Image Optimization?
Optimole handles image optimization seamlessly in the cloud—tailored to each visitor in real time. Once installed, it automatically replaces your image URLs with cloud-based ones, without altering the original files on your server.
When someone visits your site, Optimole instantly **detects their device type, screen size, browser, and connection speed**. Based on this data, it delivers the **ideal version** of each image—perfectly resized, compressed, and converted into the most efficient format their browser supports.
### How Many Images Can Be Optimized? (Unlimited)
We offer an unlimited number of image optimizations in both Free and Pro plans, you will be able to optimize an unlimited number of images for up to 1K [monthly visits](https://docs.optimole.com/article/1134-how-optimole-counts-the-number-of-visitors). All are delivered from more than **450+ locations** around the globe.
### Features That Make Optimole The Ultimate Image Solution:
#### 🔄 Seamless Bulk Optimization
Optimize your entire media library with a single click. Optimole processes your images in the background, so you don't need to keep your browser open during optimization. Perfect for existing websites with large image collections.
#### 🚀 One-Click Image Offloading
Free up valuable server space by offloading your entire media library to Optimole's secure cloud storage. All your images are safely stored and delivered from our optimized CDN, reducing your hosting costs and server load. Need your images back on your server? Our seamless one-click restoration process makes it easy to transfer everything back
whenever you want, giving you complete flexibility and control over your media assets.
#### 🌎 CDN
Optimole provides free access to an AWS CloudFront CDN with edge locations in more than 450+ cities around the globe.
#### 🖼️ ML-Powered Smart Compression
Our machine learning algorithms analyze each image to determine the optimal compression level that balances quality and file size. Unlike basic compression tools, Optimole's smart compression adapts to image content, preserving important details while aggressively compressing areas where quality loss won't be noticeable. Making it easy to compress images without sacrificing quality.
#### 🔄 Intelligent Format-Based Optimization
Our advanced cloud-based transformation process optimizes images based on format and serves them in next-gen formats automatically. If your visitor's browser supports WebP or AVIF, Optimole instantly converts and delivers these formats, reducing file size by up to 80% compared to traditional JPEG and PNG, while maintaining visual quality.
#### 💾 Advanced Digital Asset Management (DAM)
Take complete control of your media with our built-in DAM system. Store images in the Optimole Cloud to save server space and easily share assets between multiple websites. Our seamless integration with Elementor Builder and WordPress core editor means you can access your optimized cloud images directly from your familiar editing interfaces.
#### 📏 Exact Responsive Sizing
Optimole delivers just one image perfectly sized for each visitor's exact device dimensions - no more generating multiple image sizes or guessing at breakpoints. This means mobile users don't download desktop-sized images, and desktop users get appropriately high-resolution versions.
#### 📱 Retina & High-DPR Display Support
Automatically detect high-resolution displays like Retina screens and deliver images with the perfect Device Pixel Ratio (DPR). Your images will look crisp and sharp on the latest devices without unnecessarily large file sizes on standard displays.
#### ⚡ No Content Shifting with Advanced Lazy Loading
Our lightweight lazy loading defers offscreen images for faster initial page loads without any content shifting. Optimole's implementation doesn't rely on heavy jQuery dependencies, making it faster than other lazy loading solutions while being more compatible with modern themes.
#### 🔍 AI-Powered Smart Cropping
Maintain focus on the important elements in your images with our intelligent cropping system. Whether it's faces in portraits, products in e-commerce shots, or key elements in landscapes, smart cropping ensures proper sizing without losing the subject's focus. This is especially valuable for responsive designs where image dimensions change dramatically.
#### 💧 Customizable Watermarking
Protect your images with automatic watermarking. Configure your watermark once, select positioning and opacity, and Optimole will apply it to all future uploads automatically. Perfect for photographers, artists, and content creators who need to protect their work.
#### 🖼️ Multiple File Type Support
Optimole goes beyond just images. Our cloud dashboard supports uploading and managing a wide variety of file types, including videos, audio files, PDFs, documents, and more. This makes Optimole a comprehensive media management solution, not just an image optimizer. Store all your media assets in one place, organize them efficiently, and access them across all your websites with our cloud library system.
#### 🌈 Enhanced User Experience Features
- **Custom Lazy Load Placeholders** - Add brand-matching colors to your lazy-loading placeholders
- **Adaptive Quality** - Automatically adjust image quality for visitors on slower connections
- **Background Optimization** - Process images without keeping browser tabs open
- **Zero Content Shifting** - Prevent layout shifts with perfectly sized placeholders
### Real-World Use Cases Where Optimole Shines
#### 🛍️ E-commerce Success Story
**Challenge**
An online store owner with thousands of product images was experiencing slow loading times—especially on mobile—leading to high bounce rates and abandoned carts.
**Solution**
After installing **Optimole**, product images were automatically compressed and served in **WebP** format from the global **CDN**. Mobile shoppers now see perfectly sized images for their devices.
**Results**
- Significantly reduced page load times
- Improved mobile conversions
- Better Google Core Web Vitals scores
- Faster checkout completion and fewer abandoned carts
---
#### 📸 Photography Portfolio Transformation
**Challenge**
A professional photographer needed to showcase a high-resolution portfolio online without sacrificing image quality or website performance.
**Solution**
**Optimole’s** lossless compression preserved the fine details in their work while substantially reducing file sizes. The built-in watermarking protected the images, and adaptive sizing ensured visitors on all devices could appreciate the work.
**Results**
- Noticeably faster portfolio page loading
- Maintained premium image quality
- Prevented unauthorized use with watermarking
- Freed up server space via cloud storage
---
#### 🌍 Travel Blog Acceleration
**Challenge**
A travel blog featured beautiful destination photography, but large images were causing slow loading and high bounce rates—especially for readers in remote locations.
**🛠Solution**
**Optimole’s** smart compression, **WebP** conversion, and global **CDN** drastically reduced image loading times. The AI-powered smart cropping kept the focus on key elements, regardless of screen size.
**Results**
- Faster loading for readers, even in low-bandwidth areas
- Increased reader engagement
- More pages viewed per session
- Boost in advertising revenue through longer time-on-site
---
#### 📰 Multi-Author News Site Optimization
**Challenge**
A news website with dozens of authors struggled with inconsistent image sizes and formats, causing layout shifts and performance issues.
**Solution**
**Optimole** automatically standardized all uploaded images—fixing dimensions, optimizing compression, and ensuring consistent quality sitewide, regardless of who uploaded the content.
**Results**
- Layout shifts from images were virtually eliminated
- Bandwidth usage significantly reduced
- Core Web Vitals scores improved
- Editors saved time with no need to manually resize or compress images
### Comprehensive Compatibility & Security
Optimole works seamlessly with:
- Supports all major page builders: Elementor, Divi, Beaver Builder, WPBakery, Otter Blocks, Gutenberg, and more
- Compatible with popular WordPress themes: Neve, Hestia, Astra, GeneratePress, Kadence, and others
- Built for e-commerce: Seamless integration with WooCommerce and other major e-commerce plugins
- Works flawlessly with caching plugins: Super Page Cache, WP Rocket, W3 Total Cache, LiteSpeed Cache, and more
Your security is our top priority - we don't store stripped EXIF data on our service. Optimole works behind the scenes and won't interact with your site's visitors or collect their data. Our privacy-first approach means we only process what's needed for optimization. [Terms of Service](https://optimole.com/terms/)
### Clean Installation & Complete Reversibility
Optimole installs in seconds with a user-friendly onboarding flow and one-click preset configurations tailored for optimal results. Once set up, it quietly runs in the background—continuously optimizing your images without any extra work from your side.
Changed your mind? No problem. Optimole offers a clean uninstall process that restores your site to its original state—no leftover code, no clutter in your database.
### Ready to Scale? Go Pro
Premium plans start from support for 40,000 monthly visits and scale up to 3 million visits. Need even more? We’re happy to help with custom plans tailored to your needs.
All images are delivered via AWS CloudFront, using a global network of 450+ edge locations for lightning-fast load times, anywhere in the world.
As a Pro user, you’ll get priority support and the option to use a custom CNAME—so your image URLs reflect your brand while being served at top speed. [Get Optimole Pro](https://optimole.com/pricing/?utm_source=wpadmin&utm_medium=readme&utm_campaign=optimole).
### What Our Users Say About Optimole
**Made a 50% speed difference**
This is a brilliant plugin that I used to replace Nitro, which unaccountably lowered my loading speed massively after a site restore. It does the job and plays nicely with other plugins so far as I can tell.
🧑💻 JS Wilkins, Website Owner
**Better Than Any Other Image Plugin**
Increased my site speed as any other image plugin did not in the past! Performance for mobile reached 94 in (Lighthouse) without tuning anything else in my site.
🧑💻 Domingosanna, Website Owner
**Great Performance, Support & Savings**
Beautiful product. Works great. Nice design. Excellent customer support. Saving a ton on hosting costs by going this route. happy happy joy joy.
🧑💻 Alex Williams, Business Owner
### Support
We're here to help. Feel free to open a new thread on the [Support Forum](https://wordpress.org/support/plugin/optimole-wp/).
### Documentation
Discover how to make the most of Optimole with our detailed and user-friendly [documentation](https://docs.optimole.com/).
== Screenshots ==
1. Connect API
2. General Settings
3. Advance Settings
4. Cloud Library
5. Cloud Storage
== Changelog ==
##### [Version 4.0.2](https://github.com/Codeinwp/optimole-wp/compare/v4.0.1...v4.0.2) (2025-04-22)
- fatal error thrown because get_current_screen function is not loading in certain contexts
- enhance image dimension handling when the width-height attributes are not provided.
[See changelog for all versions](https://github.com/Codeinwp/optimole-wp/blob/master/CHANGELOG.md).
== Installation ==
The following are the steps to install the OptiMole plugin
1. In your WordPress Administration Panels, click on Add New option under Plugins from the menu.
Click on upload at the top.
2. Browse the location and select the OptiMole Plugin and click install now.
3. Go to Media -> OptiMole and follow in the instructions on how to enable the service.
== Frequently Asked Questions ==
= How many images I can optimize with each plan? =
The number of images that you can optimize or store is unlimited, we care only about the number of visits you have per month.
= What happens if I exceed plan limits? =
Once you exceed these, we will contact you and kindly ask to upgrade to the plan that fits you best.
= What Content Delivery Network (CDN) do you use? =
For both FREE and Paid plans we use AWS CloudFront CDN with more than 450 locations around the globe.
= I'm already using a CDN, can I use that instead of yours ? =
Short answer, YES. You will only need to whitelist the domain of your existing CDN for Optimole to pick images stored there.
= I'm already using an image optimization plugin, why should I switch to Optimole? =
You don’t need to change your existing optimization plugin, image optimization is just a small part of what we do, if you are happy with ShortPixel for e.g, feel free to continue to use it, Optimole would then take care only of serving your image at the RIGHT size, advanced cropping and smart lazy-loading.
= Does Optimole handle images from Ajax content ? =
Yes, we do. By default, Optimole handle images delivered from your ajax content from admin-ajax.php ( not logged in users ) as well as WordPress REST API routes.
= Can I remove the blurry placeholder from the lazyload effect ? =
Yes, you can. You only need to toggle this feature in the plugin as explained per this doc - https://docs.optimole.com/article/1020-can-i-remove-the-blurry-placeholder-from-the-lazyload-effct
= Will the original images be deleted? =
We use your original images as sources when deliver the optimized images. Unless you want to remove images from your server to save some space with Cloud Library by offloading images to the cloud as explained here - https://docs.optimole.com/article/1323-cloud-library-browsing
= What is the difference between the Auto, High, Medium, Low compression levels? =
A higher compression might result in a small loss of image quality. Selecting the auto level will let Optimole choose the minimum size with no loss in the quality of your picture.
= I used Kraken, Shortpixel, Optimus, EWWW or WP Smush, Imagify will Optimole further optimize my images? =
Yes, Optimole will also take care of serving your image at the RIGHT size for your visitors and optimize them to the best possible format for their browser.
= Which formats can be optimized ? =
For now we support jpg, png and svg format.
= Does Optimole automatically serve WebP for Chrome users ? =
Yes. We automatically detect user browser and serve WebP if is supported, otherwise we optimize the image in the original format.
= Can I disable lazyload for PNG images ? =
Yes. You need to add `define("OPTML_DISABLE_PNG_LAZYLOAD",true);` to `your wp-config.php` file.
You can also use plugin's UI and exclude images by their type as explained here - https://docs.optimole.com/article/1191-exclude-from-optimizing-or-lazy-loading
= Can I disable optimization for a certain image ? =
Yes, you can exclude certain image by its name as explained here - https://docs.optimole.com/article/1191-exclude-from-optimizing-or-lazy-loading
In case you're tech-savvy and want programatically exclude images by some conditions you can follow this code snippet and replace the sample image with the one you need or have other conditions:
<code>
add_filter('optml_dont_replace_url', function( $old, $url ) {
if ( $url === 'https://example.com/wp-content/uploads/2018/09/1.jpg' ) {
return true;
}
return $old;
}, 10, 2);
</code>