optimole-wp / readme.txt

readme.txt in Optimole – Optimize Images | Convert WebP & AVIF | CDN & Lazy Load | Image Optimization 4.2.5, at readme.txt

340 lines 19.4 KB

Raw Download Zip

1	=== Optimole – Optimize Images \| Convert WebP & AVIF \| CDN & Lazy Load \| Image Optimization ===
2	Contributors: optimole
3	Tags: image optimization, optimize images, compress images, webp, avif
4	Requires at least: 5.5
5	Tested up to: 6.9
6	Requires PHP: 7.4
7	Stable tag: 4.2.5
8	License: GPLv3
9	License URI: https://www.gnu.org/licenses/gpl-3.0.en.html
10
11	Automatically optimize images with bulk compression, lazy loading, WebP/AVIF conversion & CloudFront image CDN. Boost Core Web Vitals & conversions.
12
13	== Description ==
14
15	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. From product images to portfolio photos, Optimole handles it all. 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.
16
17	### ⚡ Quick Links
18
19	- [Test Your Site](https://optimole.com/test-drive/?utm_source=wordpressorg&utm_medium=readme&utm_campaign=optimole) - See how much faster we can make your site
20	- [Documentation](https://docs.optimole.com/) - Learn how to use all features
21	- [Support Forum](https://wordpress.org/support/plugin/optimole-wp/) - Get help from our team
22	- [How to Speed Up WordPress](https://optimole.com/how-to-speed-up-wordpress/?utm_source=wordpressorg&utm_medium=readme&utm_campaign=optimole) - Essential optimization tips
23	- [Go Pro](https://optimole.com/pricing/?utm_source=wordpressorg&utm_medium=readme&utm_campaign=optimole) - Upgrade for more monthly visits
24
25	### 🚀 Summary of What Optimole Does
26
27	- Compress images without quality loss - ML-powered technology preserves details
28	- Global AWS CloudFront CDN - 450+ locations for instant loading
29	- WebP & AVIF conversion - Up to 80% smaller file sizes
30	- [PRO] Complete image offloading - Store images in the cloud and free up server space with one-click restoration
31	- jQuery-free lazy loading - Improves Core Web Vitals
32	- Adaptive image sizing - Perfect fit for every device
33	- Cloud media library - Manage assets across multiple sites
34	- Support for all file types - Images, video, audio, documents
35	- Automatic watermarking - Protect your visual content
36	- Zero configuration needed - Install and forget
37	- Free plan with all features - For sites with up to 2000 [visits](https://docs.optimole.com/article/1134-how-optimole-counts-the-number-of-visitors)/month
38
39	### Why Choose Optimole Over Other Image Optimization Plugins?
40
41	- Truly Automated Optimization – Install once and let our cloud-based system handle everything
42	- Compress images in bulk - Process your entire media library with one click
43	- Smaller Images, Same Visual Quality – Advanced ML-powered compression preserves image details
44	- Perfect Size for Every Device – Images dynamically resized for each visitor's exact screen dimensions
45	- Lightning-Fast Global CDN – Free delivery from 450+ locations worldwide for instant loading
46	- Automatic Next-Gen Formats – WebP and AVIF conversion reduces file size by up to 80%
47	- Zero Server Resource Usage – All processing happens in our cloud, keeping your hosting resources free
48	- WooCommerce Performance Boost – Optimized product galleries load faster, increasing conversions
49	- Eliminate Content Shifting – Perfect placeholder dimensions prevent Cumulative Layout Shift (CLS)
50	- Significant Core Web Vitals Improvement – Lower Largest Contentful Paint (LCP) scores
51	- Complete Media Management – Cloud library with Digital Asset Management features
52
53	https://youtu.be/siCm0fhNes0
54
55	### What’s the Magic Behind Optimole’s Image Optimization?
56
57	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.
58
59	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.
60
61	### How Many Images Can Be Optimized? (Unlimited)
62
63	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 2000 [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.
64
65	### Features That Make Optimole The Ultimate Image Solution:
66
67	#### 🔄 Seamless Bulk Optimization
68
69	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.
70
71	#### 🚀 One-Click Image Offloading [PRO]
72
73	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.
74
75	#### 🌎 CDN
76
77	Optimole provides free access to an AWS CloudFront CDN with edge locations in more than 450+ cities around the globe.
78
79	#### 🖼️ ML-Powered Smart Compression
80
81	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.
82
83	#### 🔄 Intelligent Format-Based Optimization
84
85	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.
86
87	#### 💾 Advanced Digital Asset Management (DAM)
88
89	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.
90
91	#### 📏 Exact Responsive Sizing
92
93	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.
94
95	#### 📱 Retina & High-DPR Display Support
96
97	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.
98
99	#### ⚡ No Content Shifting with Advanced Lazy Loading
100
101	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.
102
103	#### 🔍 AI-Powered Smart Cropping
104
105	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.
106
107	#### 💧 Customizable Watermarking
108
109	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.
110
111	#### 🖼️ Multiple File Type Support
112
113	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.
114
115	#### 🌈 Enhanced User Experience Features
116
117	- Custom Lazy Load Placeholders - Add brand-matching colors to your lazy-loading placeholders
118	- Adaptive Quality - Automatically adjust image quality for visitors on slower connections
119	- Background Optimization - Process images without keeping browser tabs open
120	- Zero Content Shifting - Prevent layout shifts with perfectly sized placeholders
121
122	### Real-World Use Cases Where Optimole Shines
123
124	#### 🛍️ E-commerce Success Story
125
126	Challenge
127	An online store owner with thousands of product photos was experiencing slow loading times—especially on mobile—leading to high bounce rates and abandoned carts.
128
129	Solution
130	After installing Optimole, product photos were automatically compressed and served in WebP format from the global CDN. Mobile shoppers now see perfectly sized images for their devices.
131
132	Results
133	- Significantly reduced page load times
134	- Improved mobile conversions
135	- Better Google Core Web Vitals scores
136	- Faster checkout completion and fewer abandoned carts
137
138	---
139
140	#### 📸 Photography Portfolio Transformation
141
142	Challenge
143	A professional photographer needed to showcase a high-resolution portfolio online without sacrificing photos quality or website performance.
144
145	Solution
146	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.
147
148	Results
149	- Noticeably faster portfolio page loading
150	- Maintained premium photo quality
151	- Prevented unauthorized use with watermarking
152	- Freed up server space via cloud storage
153
154	---
155
156	#### 🌍 Travel Blog Acceleration
157
158	Challenge
159	A travel blog featured beautiful destination photography, but large images were causing slow loading and high bounce rates—especially for readers in remote locations.
160
161	🛠Solution
162	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.
163
164	Results
165	- Faster loading for readers, even in low-bandwidth areas
166	- Increased reader engagement
167	- More pages viewed per session
168	- Boost in advertising revenue through longer time-on-site
169
170	---
171
172	#### 📰 Multi-Author News Site Optimization
173
174	Challenge
175	A news website with dozens of authors struggled with inconsistent image sizes and formats, causing layout shifts and performance issues.
176
177	Solution
178	Optimole automatically standardized all uploaded images—fixing dimensions, optimizing compression, and ensuring consistent quality sitewide, regardless of who uploaded the content.
179
180	Results
181	- Layout shifts from images were virtually eliminated
182	- Bandwidth usage significantly reduced
183	- Core Web Vitals scores improved
184	- Editors saved time with no need to manually resize or compress images
185
186	### Comprehensive Compatibility & Security
187
188	Optimole works seamlessly with:
189
190	- Supports all major page builders: Elementor, Divi, Beaver Builder, WPBakery, Otter Blocks, Gutenberg, and more
191	- Compatible with popular WordPress themes: Neve, Hestia, Astra, GeneratePress, Kadence, and others
192	- Built for e-commerce: Seamless integration with WooCommerce to optimize product photos and galleries
193	- Works flawlessly with caching plugins: Super Page Cache, WP Rocket, W3 Total Cache, LiteSpeed Cache, and more
194
195	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/)
196
197	### Clean Installation & Complete Reversibility
198
199	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.
200
201	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.
202
203	### Ready to Scale? Go Pro
204
205	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.
206
207	All images are delivered via AWS CloudFront, using a global network of 450+ edge locations for lightning-fast load times, anywhere in the world.
208
209	Pro is ideal for photographers, agencies, and businesses managing large volumes of photos online. 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=wordpressorg&utm_medium=readme&utm_campaign=optimole).
210
211	### What Our Users Say About Optimole
212
213	Made a 50% speed difference
214
215	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.
216
217	🧑‍💻 JS Wilkins, Website Owner
218
219	Better Than Any Other Image Plugin
220
221	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.
222
223	🧑‍💻 Domingosanna, Website Owner
224
225	Great Performance, Support & Savings
226
227	Beautiful product. Works great. Nice design. Excellent customer support. Saving a ton on hosting costs by going this route. happy happy joy joy.
228
229	🧑‍💻 Alex Williams, Business Owner
230
231	### Support
232
233	We're here to help. Feel free to open a new thread on the [Support Forum](https://wordpress.org/support/plugin/optimole-wp/).
234
235	### Documentation
236
237	Discover how to make the most of Optimole with our detailed and user-friendly [documentation](https://docs.optimole.com/).
238
239	== Screenshots ==
240
241	1. Dashboard Overview
242	2. Get 20K extra free visits by enabling the Optimole badge
243	3. Compression Mode: Adjust for speed, quality, or custom settings
244	4. Resize Settings: Limit image size and enable smart cropping
245	5. Image Exclusions: Filters to skip optimization & lazy loading
246	6. Image Protection: Add branded watermarks to your images
247	7. Lazy Loading: Load images only when visible
248
249	== Changelog ==
250
251	##### [Version 4.2.5](https://github.com/Codeinwp/optimole-wp/compare/v4.2.4...v4.2.5) (2026-05-07)
252
253	- Fixes mixed content errors and broken images in some AJAX contexts.
254
255
256
257
258	[See changelog for all versions](https://github.com/Codeinwp/optimole-wp/blob/master/CHANGELOG.md).
259
260
261	== Installation ==
262	The following are the steps to install the Optimole plugin
263
264	1. In your WordPress Dashboard, click on Add New option under Plugins from the menu.
265	Click on upload at the top.
266	2. Browse the location, select the Optimole plugin and click "Install now".
267	3. Go to Media -> Optimole and follow in the instructions on how to enable the service.
268
269	== Frequently Asked Questions ==
270
271	= How many images I can optimize with each plan? =
272
273	The number of images that you can optimize or store is unlimited, we care only about the number of visits you have per month.
274
275	= What happens if I exceed plan limits? =
276
277	Once you exceed these, we will contact you and kindly ask to upgrade to the plan that fits you best.
278
279	= What Content Delivery Network (CDN) do you use? =
280
281	For both FREE and Paid plans we use AWS CloudFront CDN with more than 450 locations around the globe.
282
283	= I'm already using a CDN, can I use that instead of yours ? =
284
285	Short answer, YES. You will only need to whitelist the domain of your existing CDN for Optimole to pick images stored there.
286
287	= I'm already using an image optimization plugin, why should I switch to Optimole? =
288
289	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.
290
291	= Does Optimole handle images from Ajax content ? =
292
293	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.
294
295	= Can I remove the blurry placeholder from the lazyload effect ? =
296
297	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
298
299	= Will the original images be deleted? =
300
301	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
302
303	= What is the difference between the Auto, High, Medium, Low compression levels? =
304
305	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.
306
307	= I used Kraken, Shortpixel, Optimus, EWWW or WP Smush, Imagify. Will Optimole further optimize my images? =
308
309	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.
310
311	= Which formats can be optimized ? =
312
313	For now we support jpg, png and svg format.
314
315	= Does Optimole automatically serve WebP for Chrome users ? =
316
317	Yes. We automatically detect user browser and serve WebP if is supported, otherwise we optimize the image in the original format.
318
319	= Can I disable lazyload for PNG images ? =
320
321	Yes. You need to add `define("OPTML_DISABLE_PNG_LAZYLOAD",true);` to `your wp-config.php` file.
322
323	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
324
325	= Can I disable optimization for a certain image ? =
326
327	Yes, you can exclude certain image by its name as explained here - https://docs.optimole.com/article/1191-exclude-from-optimizing-or-lazy-loading
328
329	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:
330
331	<code>
332	add_filter('optml_dont_replace_url', function( $old, $url ) {
333	if ( $url === 'https://example.com/wp-content/uploads/2018/09/1.jpg' ) {
334	return true;
335	}
336	return $old;
337
338	}, 10, 2);
339	</code>
340