Skip to content

Commit 2fcb74a

Browse files
committed
Update readme file
1 parent 2b51396 commit 2fcb74a

File tree

1 file changed

+79
-18
lines changed

1 file changed

+79
-18
lines changed

readme.txt

Lines changed: 79 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Stable tag: 1.8.5
77
License: GPLv3
88
License URI: http://www.gnu.org/licenses/gpl-3.0.html
99

10-
Use a3 Lazy Load for images, videos, iframes. Instantly improve your sites load time and dramatically improve site user’s experience.
10+
Use a3 Lazy Load for images, videos, iframes. Instantly improve your sites load time and dramatically improve site users experience.
1111

1212
== DESCRIPTION ==
1313

@@ -21,7 +21,7 @@ a3 Lazy Load is the most fully featured, incredibly easy to set up lazy load plu
2121

2222
Images are the number one element that slows page load and increases bandwidth use. From the a3 Lazy Load admin panel turn load images by a3 Lazy Load ON | OFF. For more flexibility when ON you can choose to ON | OFF lazy load for images in
2323

24-
* Post and Pages (All Content areas)
24+
* Post, Pages and Custom Post Types (All Content areas)
2525
* Widgets (Sidebar, header and footer)
2626
* Apply to post thumbnails
2727
* Apply to gravatars
@@ -30,19 +30,21 @@ Images are the number one element that slows page load and increases bandwidth u
3030

3131
= VIDEO LAZY LOAD =
3232

33-
a3 Lazy Load supports all WordPress video Embeds including Youtube, Vimeo and HTML5 video - for a full list see the [WordPress Codex Embeds](http://codex.wordpress.org/Embeds) list. The WordPress embed method of copying and pasting the video url into posts and pages content area is fully supported. Note - embed video by WordPress shortcode is not supported.
33+
a3 Lazy Load supports all WordPress video Embeds including Youtube, Vimeo and HTML5 video - for a full list see the [WordPress Codex Embeds](http://codex.wordpress.org/Embeds) list. The WordPress embed method of copying and pasting the video url into posts and pages content area is fully supported.
34+
35+
<strong>Note</strong> - Works with Videos added by Text and HTML Widgets but not the new WordPress Video widget. That widget does not pull iframe at first load, it use JavaScript to replace html to iframe and hence a3 lazy Load can't see it to apply.
3436

3537
From the a3 lazy Load admin panel turn Video Support ON | OFF. When ON you can choose to ON | OFF lazy load for videos in
3638

37-
* Post and Pages (All Content areas)
38-
* Widgets (Sidebar, header and footer)
39+
* Video embeded by URL in Post and Pages (All Content areas)
40+
* Video in Widget types, Text Widget and HTML Wigets.
3941
* Youtube [see demo](http://ressio.github.io/lazy-load-xt/demo/youtube-iframe.htm)
4042
* Video [see demo](http://ressio.github.io/lazy-load-xt/demo/video-html5.htm)
4143
* Fully Compatible with the popular [Youtube Embed Plugin](https://wordpress.org/plugins/youtube-embed/)
4244

4345
= iFRAME LAZY LOAD =
4446

45-
a3 Lazy Load has built in support for content that is added by iframe from any source in content and widgets – examples
47+
a3 Lazy Load has built in support for content that is added by iframe from any source in content and widgets. Examples
4648

4749
* WordPress embedded media
4850
* Facebook Like boxes with profiles, Like buttons, Recommend
@@ -59,7 +61,11 @@ a3 Lazy Load has built in support for content that is added by iframe from any s
5961
* Built in auto support for WordPress AMP plugin
6062
* Built in support for Better AMP plugin
6163
* There are no setting options for exclude /amp - Lazy Load is just never applied to the /amp endpoint
62-
* When the url is loaded in browser without /amp Lazy Load is applied
64+
* When the url is loaded in browser without /amp Lazy Load is applied
65+
66+
= ADVANCED CUSTOM FIELDS =
67+
68+
Fully compatible with the very popular Advanced Custom Fields plugin, Free and Premium versions.
6369

6470
= LAZY LOAD EFFECTS =
6571

@@ -82,22 +88,32 @@ a3 Lazy Load gives you the option to load its script from your sites HEAD or fro
8288

8389
= EXCLUDE IMAGES & VIDEO =
8490

85-
a3 Lazy Load allows you to easily exclude any images and video by class name from having the Lazy Load effect applied.
91+
a3 Lazy Load allows you to easily exclude any image or video by class name from having the Lazy Load effect applied. [See FAQ's](https://wordpress.org/plugins/a3-lazy-load/#faqs)
8692

8793
= JAVASCIPT DISABLED FALLBACK =
8894

8995
a3 Lazy Load has built in Noscript fallback if user has JavaScript turned off in their browser. Developers who use underscore.js in their applications can use the Noscript parameter to exclude their plugins content from Lazy Load.
9096

91-
= PLUGIN COMPATIBILITY =
97+
= THEME & PLUGIN COMPATIBILITY =
98+
99+
a3 Lazy Load works with any WordPress theme that follows the WordPress Theme Codex. However, many Theme & Plugin developers will use a custom written function to add objects, example the theme has a home page with layout created by a custom function they have written. a3 Lazy Load cannot know what these functions are and so cannot apply to the objects loaded by that custom function.
100+
101+
If your images or objects not being Lazy Loaded in a certain section of your site, but are Lazy Loaded everywhere else you will know this is the cause. Please if this happens raise a support ticket with the developer, explaining that they just need to add a simple tag to their custom functions so that a3 Lazy Load apply to their custom function and be fully compatible. [Here is a list](https://wordpress.org/plugins/a3-lazy-load/#faqs) of a3 lazy Load filter tags to include in your ticket to make it easy for the developer.
102+
103+
Don't forget when a developer does add full compatibility with a3 Lazy Load please let us know via a support ticket on this forum and we will add them to the list below.
92104

93-
* Work with any WordPress theme that follows the WordPress Theme Codex
94-
* Fully compatible with WPTouch plugin - Set to not apply on Mobiles if WPTouch is installed
95-
* Fully compatible with MobilePress plugin - Set to not apply on Mobiles if MobilePress is installed
96-
* Will not conflict with any plugin that has lazy load built in
97-
* Plugin Developers a3 lazy load filter allows them to let lazy load apply to their plugin
98-
* Tested 100% compatible with WP Super Cache and W3 Total Cache plugins
99-
* Tested 100% compatible with Amazon Cloudfront
100-
* Fully compatible with CDN architecture.
105+
These are just some of the more popular plugins that are either tested 100% compatible with a3 Lazy Load or tags has been added for 100% compatibility.
106+
107+
* Plugin - Advanced Custom Fields
108+
* Plugin - WooCommerce
109+
* Plugin - WP Offload
110+
* Plugin - WP Super Cache and W3 Total Cache plugins
111+
* Plugin - Youtube Embed
112+
* Plugin - WordPress AMP
113+
* Plugin - WPTouch. Note - Set to not apply on Mobiles if WPTouch is installed
114+
* Plugin - MobilePress - Set to not apply on Mobiles if MobilePress is installed
115+
* Plugins - Will not conflict with any plugin that has lazy load built in
116+
* CDN's - Cloudfront, Cloudflare and all other known CDN architecture.
101117

102118
= MORE FEATURES =
103119

@@ -108,9 +124,54 @@ a3 Lazy Load has built in Noscript fallback if user has JavaScript turned off in
108124

109125
= JOIN THE a3 LAZY LOAD COMMUNITY =
110126

111-
When you download a3 lazy Load, you join our community. Regardless of if you are a WordPress newbie or experienced developer if you’re interested in contributing to a3 Lazy Load development head over to the [a3 Lazy Load GitHub Repository](https://github.com/a3rev/a3-lazy-load) to find out how you can contribute.
127+
When you download a3 lazy Load, you join our community. Regardless of if you are a WordPress newbie or experienced developer if you are interested in contributing to a3 Lazy Load development head over to the [a3 Lazy Load GitHub Repository](https://github.com/a3rev/a3-lazy-load) to find out how you can contribute.
112128
Want to add a new language to a3 Lazy Load? Great! You can contribute via [translate.wordpress.org](https://translate.wordpress.org/projects/wp-plugins/a3-lazy-load)
113129

130+
== FAQs ==
131+
132+
= Question =
133+
How do I exclude individual objects from Lazy Load?
134+
135+
= Answer =
136+
137+
= Filter Tag to exclude from lazy load =
138+
Use this class name to use to exclude lazy load on individual images, videos and iframes.
139+
<code>a3-notlazy</code>
140+
141+
= Question =
142+
Why are some images, videos, objects not Lazy Loaded?
143+
144+
= Answer =
145+
146+
a3 Lazy Load can only be applied to objects that are added using core WordPress functions. If your theme or a plugin developer adds objects such as images or videos via a custom written function, a3 lazy Load cannot know what that custom function is and hence cannot Lazy Load the object.
147+
148+
So if you see object not being lazy loaded please check first if those objects are loaded by the theme or a plugin. If they are, you can be confident that they are loaded by a custom function.
149+
150+
If this is the case, please help yourself and other a3 lazy Load users by raising a support ticket with the developer and ask them to add an a3 Lazy Load filter tag to their function to allow a3 Lazy Load to find it and apply to the object.
151+
152+
Below is a list of available a3 Lazy Load filters to use and pass onto the developer.
153+
154+
= Filter tags to apply lazy load =
155+
156+
Apply lazy load for images in content.
157+
<code>a3_lazy_load_images</code>
158+
Example: <code>apply_filters( ‘a3_lazy_load_images’, $your_content, null );</code>
159+
160+
Apply lazy load for videos and iframe from content.
161+
<code>a3_lazy_load_videos</code>
162+
Example <code>apply_filters( ‘a3_lazy_load_videos’, $your_content, null );</code>
163+
164+
Apply lazy load for all images, videos and iframe from content
165+
<code>a3_lazy_load_html</code>
166+
Example: apply_filters( ‘a3_lazy_load_html’, $your_content, null );
167+
168+
= Filter Tags to Exclude by Theme Class name =
169+
170+
Filter tags to add to class name of theme to exclude lazy load on images or videos.
171+
<code>a3_lazy_load_skip_images_classes</code>
172+
<code>a3_lazy_load_skip_videos_classes</code>
173+
174+
114175
== Installation ==
115176

116177
= Minimum Requirements =

0 commit comments

Comments
 (0)