Third Party Compatibility¶
Known Compatible Plugins/Themes¶
This is a list of known popular plugins and themes that we have checked for compatibility. All of the products listed here have passed the test and are compatible with LSCache. If this list looks small, it is because we only test those plugins that have the potential to conflict with a cache solution.
Many of these plugins/themes now work with LSCWP right out of the box, but others require some action before they will work. Please note the Action Required column.
|WooCommerce||If using Recently Viewed Products widget, Set Enable ESI to ||The plugin caches the pages that WooCommerce deems cacheable.|
|WPML||Separate cache copies are stored for each page for each language.|
|bbPress||New forums/topics/replies will purge the relevant parent pages.|
|Contact Form 7||Purge cache after creating/editing a form. Set TTL to 24 hours (86400 seconds) or less.|
|Caldera Forms||Set Enable ESI to ||Forms are exempt from other cache rules on the site. v188.8.131.52+|
|Google XML Sitemaps|
|Yoast SEO||Purge cache on activation/deactivation|
|NextGen Gallery||Albums and galleries are purged accordingly when related images are updated.|
|Aelia CurrencySwitcher||Has a vary for the four required cookies.|
|Fast Velocity Minify|
|Autoptimize||Will purge cache when its cache is purged.|
|Better WP Minify|
|WP Touch||Set Cache Mobile to |
|Theme My Login|
|Login With Ajax|
|Post Types Order||v184.108.40.206+|
|iThemes Security Pro||Add |
|Elegant Themes Divi||v3.0.67+|
|BoomBox||Viral Magazine WordPress Theme|
It's impossible to list every plugin that is compatible with LiteSpeed Cache, so here is a rule of thumb:
If the plugin doesn’t generate site content, or do anything out of the ordinary with existing front-end content, then chances are it is 100% compatible with LiteSpeed Cache for WordPress. (The vast majority of plugins fall into this category.)
Still note sure? Consider these points:
- LSCWP purges pages from the cache when certain events are triggered. If the plugin generates content that triggers those same events, then it's compatible in that area.
- LSCWP follows a set of rules to determine whether a page is cacheable. If the plugin generates content that also abides by those same rules, then it's compatible in that area.
- If the plugin uses a nonce, customization may be required. Please see our API
If you still are unsure, you ask the plugin author if they have tested for LiteSpeed compatibility, or you can test it yourself.
Testing For Compatibility¶
we've tried to make these instruction as easy to understand as possible. You don't need to be a developer in order to test for compatibility between two plugins.
While you could perform these tests on a production site, we recommend using a test WordPress installation if you have one. This allows you to really take your time, and follow the steps carefully. Testing compatibility is not hard, per se, but it is helpful if you can do it without the added pressure of having your production environment effectively offline for the duration of the test.
In whichever environment you are using (test or production) verify that LSCache for WordPress is working as desired before activating the other plugin. Once you have it the way you want it, you may proceed with testing as outlined below.
Since it's cumbersome to keep saying "the plugin you want to test," let's call it "ThatPlugin" for this example.
Deactivate all plugins except for LSCache and ThatPlugin from the WordPress Plugins screen, like so:
From the WordPress Dashboard, navigate to Plugins, and click the checkbox next to the Plugins column as shown. All of the plugins will be checked. Un-check the boxes next to LiteSpeed Cache and ThatPlugin. Select
Deactivate from the dropdown Bulk Actions box, and click the Apply button. All plugins, aside from LSCache and ThatPlugin will be disabled.
Also, be sure that you are using a theme that is compatible with LSCache. If you are not sure about your theme, temporarily switch to the default WordPress theme: Navigate to Appearance > Themes, hover over the appropriate card, and press the Activate button.
Purge the cache: Navigate to LiteSpeed Cache > Toolbox > Purge and press the Purge All button.
This step varies, depending on how you use ThatPlugin, and what it needs to be able to do. Run through your most common scenarios, and after each step, verify that ThatPlugin is working as expected. Additionally, check to see if the relevant pages are properly cached.
If ThatPlugin deals with any private information, run the through the steps twice: once logged-in, and once in incognito mode. When you visit the site incognito, be sure that you are not seeing any private information from your previous logged-in session.
Some Testing Examples¶
- If ThatPlugin is a forum plugin, run through the steps of creating an account, updating your profile, publishing a post, and submitting a comment. Check the cache at every step.
- If ThatPlugin is a social sharing plugin that counts shares, use it to share a post or a page to social media and then verify that the share count has increased.
- If ThatPlugin is a contact form plugin, use it to send yourself some feedback. Visit the form page again while not logged in, and verify that you are not seeing any of your previous logged-in information.
Document + Report¶
If you encounter an issue that indicates the plugins are not working well together, document it. Take a screenshot, or copy the text of any error messages you may get. Visit the LiteSpeed Cache for WordPress support forum and share as many details as possible, including the above screenshots.
It might also be helpful to include a copy of your Environment Report so that the support team can see your system settings. To do so, navigate to LiteSpeed Cache > Toolbox > Report and click the Send to LiteSpeed button. Then make note of the Report Number and include it with your forum post.
If you have the skills, you can take a look at our API and make the plugin compatible yourself!
Once you are satisfied that everything works well, or you have documented and reported anything that doesn't, you may re-activate all of the plugins, and restore your preferred theme.
A Note About Themes¶
Sometimes the plugins all get along well, but there is something unexpected happening in the theme. To test theme compatibility, follow the same steps as above, with the following differences:
- LiteSpeed Cache should be the only active plugin
- The theme you want to test should be activated