Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
litespeed_wiki:cache:lscwp:compatibility [2020/05/04 13:47]
Shivam Saluja 		litespeed_wiki:cache:lscwp:compatibility [2020/11/14 15:23] (current)
Lisa Clarke Redirect to new Documentation Site
Line 1: Line 1:
-====== Testing Plugin+LSCWP Compatibility ====== +~~REDIRECT>​https://​docs.litespeedtech.com/​lscache/​lscwp/​thirdparty/~~
-**Please Note**: This wiki is valid for v2.9.x and below of the LiteSpeed Cache Plugin for WordPress. If you are using v3.0 or above, please see [[https://​docs.litespeedtech.com/​lscache/​lscwp/​overview/|the new documentation]]. +
- +
-If you are wondering if a particular plugin is compatible with LiteSpeed Cache for WordPress, this guide can help you figure it out. 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.  +
- +
-**NOTE**: 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. +
- +
-===== Before You Begin ===== +
- +
-You may not have to do a test at all! +
- +
-  - [[litespeed_wiki:​cache:​lscwp:​supported_plugins|Check our compatibility list]]. If the plugin appears there, then we've already tested it and we know it works. +
-  - Check with the plugin author. They may already have tested for LSCWP compatibility. +
- +
-If you didn't find any answers with the previous two ideas, not to worry. **The vast majority of plugins is compatible with LiteSpeed Cache for WordPress.** Here are a few rules-of-thumb. The plugin you want to test is //​probably//​ compatible if: +
- +
-  - it doesn'​t generate site content +
-  - it doesn'​t manipulate existing front-end content +
- +
-If the plugin generates or manipulates site content, it still //may be// compatible if: +
- +
-  - it generates or manipulates content that triggers [[litespeed_wiki:​cache:​lscwp:​api#​customized_smart_purging|the same purge events that are monitored by LSCWP]] +
-  - it generates or manipulates content that follows [[litespeed_wiki:​cache:​lscwp:​api#​customized_do-not-cache_rules|the same caching rules that are followed by LSCWP]] +
- +
-If you're still not sure, you'll need to test for compatibility. +
- +
-===== Testing for Compatibility ===== +
- +
-In whichever environment you are using (test or production) [[litespeed_wiki:​cache:​lscwp:​installation#​testing|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 ==== +
- +
-Deactivate all plugins except for LSCache and ThatPlugin. Here's how: +
- +
-{{:​litespeed_wiki:​cache:​lscwp:​deactivate-plugins.png?​direct&​800|}} +
- +
-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 WordPress Twenty Seventeen theme: Navigate to **Appearance > Themes**, hover over the Twenty Seventeen card, and press the **Activate** button. +
- +
-==== Purge ==== +
- +
-Purge the cache: Navigate to **LiteSpeed Cache > Manage > Purge** and press the **Purge All** button. +
- +
-==== TEST! ==== +
- +
-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. You might also want to [[litespeed_wiki:​cache:​lscwp:​installation#​testing|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 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 [[https://​wordpress.org/​support/​plugin/​litespeed-cache|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 > Report** and click the **Send to LiteSpeed** button. Then make note of the **Report Number** and include it with your forum post. +
- +
-==== Reactivate ==== +
- +
-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 +
  • Admin
  • Last modified: 2020/05/04 13:47
  • by Shivam Saluja