| 1 |
=== Plugin Detective - Troubleshooting Conflicts === |
| 2 |
Contributors: croixhaug, nataliemac, nsquaredteam |
| 3 |
Donate link: https://nsquared.io |
| 4 |
Tags: troubleshoot, conflicts, debug, performance, site health |
| 5 |
Requires at least: 6.1 |
| 6 |
Tested up to: 7.0 |
| 7 |
Requires PHP: 5.3 |
| 8 |
Stable tag: 1.2.32 |
| 9 |
License: GPLv2 |
| 10 |
License URI: http://www.gnu.org/licenses/gpl-2.0.html |
| 11 |
|
| 12 |
Quickly find and fix WordPress plugin conflicts, recover from fatal errors, and clear stuck maintenance mode without any coding. |
| 13 |
|
| 14 |
== Description == |
| 15 |
|
| 16 |
**Plugin Detective helps you troubleshoot issues on your site quickly and easily to find the cause of a problem.** Once the culprit is found, the problem plugin can be quickly deactivated. You can even fix your site when it has the white screen of death (fatal error). You'll want to have Plugin Detective installed, so if your site crashes from a conflict or bad plugin update, you can get it back up and running quickly! |
| 17 |
|
| 18 |
Plugin Detective is your best friend when you need to: |
| 19 |
- Troubleshoot WordPress plugin conflicts |
| 20 |
- Remove stuck .maintenance files |
| 21 |
- Recover your site from fatal errors caused by plugins |
| 22 |
|
| 23 |
--- |
| 24 |
|
| 25 |
We've all been there--something's broken on your site. You've looked around the web for advice about what to do and have stumbled across the typical wisdom: deactivate all your plugins and then reactivate them one by one, checking your site for the problem after each reactivation. |
| 26 |
|
| 27 |
Ugh. |
| 28 |
|
| 29 |
Sure, it works. But who has *time* for that? |
| 30 |
|
| 31 |
[vimeo https://vimeo.com/270010645] |
| 32 |
|
| 33 |
= Find Plugin Conflicts with Detective Otto Bot = |
| 34 |
|
| 35 |
Detective Otto Bot walks you through solving your case one step at a time, all from one single screen. |
| 36 |
|
| 37 |
1. Open a case and tell Detective Otto where you're seeing the problem. If your site requires any plugins to run correctly, tell Otto about those, too. |
| 38 |
2. Then, Otto will interrogate the suspects and track clues, checking in with you from time to time. |
| 39 |
3. All you need to do is answer "Yes, it's fixed" or "No, it's still broken" each time. Otto will do the rest and find the culprit in minutes. |
| 40 |
|
| 41 |
Best of all - Plugin Detective can work even if you're seeing the White Screen of Death on your site or if all you can see are PHP errors. Please have a look at the FAQ's for how to access Plugin Detective and log into WordPress even if you can't get to your login screen. |
| 42 |
|
| 43 |
Once Otto has identified the culprit, you can quickly deactivate the troublesome plugin and go about your day. |
| 44 |
|
| 45 |
= Remove Stuck .Maintenance File or Scheduled Maintenance = |
| 46 |
Have you gotten stuck in maintenance mode on WordPress? The dreaded "Briefly unavailable for scheduled maintenance. Check back in a minute" message haunts you; the minute never ends! |
| 47 |
|
| 48 |
With Plugin Detective installed you can quickly get out of these situations without the hassle of deleting files via your host or FTP. Just tack on this slug to the end of your website URL: |
| 49 |
|
| 50 |
`/wp-content/plugins/plugin-detective/troubleshoot/?restore=1` |
| 51 |
|
| 52 |
So that your URL looks like this: |
| 53 |
|
| 54 |
`https://yoursite.com/wp-content/plugins/plugin-detective/troubleshoot/?restore=1` |
| 55 |
|
| 56 |
This will prompt you to log in and automatically remove that stuck maintenance file for you. |
| 57 |
|
| 58 |
= Who Can Use This Troubleshooting Tool? = |
| 59 |
|
| 60 |
Plugin Detective is a tool that requires no coding experience or technical knowledge to use. For that reason, Plugin Detective is the ideal troubleshooting and conflict-checking tool for: |
| 61 |
|
| 62 |
- Any WordPress website owner |
| 63 |
- Developers and technical support engineers |
| 64 |
- Plugin and theme owners and their support teams |
| 65 |
|
| 66 |
= Debug Tool Features = |
| 67 |
|
| 68 |
- Strategically activate and deactivate plugins on your site to help you find the plugin causing trouble |
| 69 |
- Open Plugin Detective for troubleshooting on any page on your site - both in the backend and the frontend! |
| 70 |
- Choose any subset of your active plugins as the baseline for your testing |
| 71 |
|
| 72 |
= Loved by Plugin Support Teams = |
| 73 |
|
| 74 |
The [Simply Schedule Appointments](https://simplyscheduleappointments.com/guides/plugin-detective-for-plugin-conflicts/) and [Draw Attention](https://wpdrawattention.com/guides/plugin-detective-for-finding-conflicts/) support teams love to share this conflict-checking tool with their customers. |
| 75 |
Plugin Detective makes it easy for their clients to debug performance issues and figure out plugin conflicts in a jiffy! |
| 76 |
|
| 77 |
== Installation == |
| 78 |
|
| 79 |
= Manual Installation = |
| 80 |
|
| 81 |
1. Upload the entire `/plugin-detective` directory to the `/wp-content/plugins/` directory. |
| 82 |
2. Activate Plugin Detective through the 'Plugins' menu in WordPress. |
| 83 |
|
| 84 |
== Frequently Asked Questions == |
| 85 |
|
| 86 |
= How do I use Plugin Detective? = |
| 87 |
|
| 88 |
Install Plugin Detective. Then, from the WordPress admin, you'll find Plugin Detective under the Tools menu. |
| 89 |
|
| 90 |
Alternatively, you'll find a Troubleshoot link added to your admin bar. Click this link on any page, admin or front end, to troubleshoot an issue you're seeing on that page. |
| 91 |
|
| 92 |
= I see errors or a white screen. Can I still use Plugin Detective to troubleshoot what's gone wrong? = |
| 93 |
|
| 94 |
You can install Plugin Detective via FTP as long as you can still access your hosting account. On the Installation tab, we've included instructions for Manual Installation. |
| 95 |
|
| 96 |
Once Plugin Detective is installed, head to `yoursite.com/wp-content/plugins/plugin-detective/troubleshoot`. You'll be asked to log in with your WordPress username and password to make sure you have the right permissions, and then Detective Otto Bot will step you through troubleshooting just like always. |
| 97 |
|
| 98 |
= How does Detective Otto figure out which plugin is breaking my site? = |
| 99 |
|
| 100 |
Detective Otto learns from you. While interrogating the different suspects, Otto will check in with you to see if the issue is still happening on your site or not. You just need to answer "Fixed" or "Broken" after Otto makes a change. |
| 101 |
|
| 102 |
Each of your answers provides Otto with another clue that he can use to narrow down the list of plugins to find the one causing the problem. |
| 103 |
|
| 104 |
= What if it's not easy to see what's broken? = |
| 105 |
|
| 106 |
There's no time limit on the clues for Otto. Some issues are more complex than others. You can use the embedded screen Otto provides you to step through several steps to see if the issue appears, or you can even open your site in a new window and step through whatever steps it takes to replicate the problem you're having. Once you have the answer – minutes or even hours later – you can tell Otto either "Yes, it's fixed" or "No, it's still broken". |
| 107 |
|
| 108 |
= Is this faster than me troubleshooting my plugins manually? = |
| 109 |
|
| 110 |
Yes, it's *much* faster. Robots can be really fast at figuring out puzzles like these, and Detective Otto Bot is no exception. Rather than disabling your plugins one by one, Otto can disable groups of plugins and use your answers to quickly narrow the scope of his investigation using binary search (a fancy robot term for saving you time). |
| 111 |
|
| 112 |
= I told Detective Otto that the problem was fixed, so why is he still interrogating suspects? = |
| 113 |
|
| 114 |
Otto was likely interrogating a group of suspects at the time. The clue that the problem was fixed only narrows it down to one suspect in that group. Give Otto a couple more rounds of interrogation, and he'll find the exact plugin causing your problem. |
| 115 |
|
| 116 |
= Does Plugin Detective work on multisite installs? = |
| 117 |
|
| 118 |
No, we don't support multisite yet. We wanted to get Plugin Detective out there for people to use as soon as possible, but there’s a good amount of work to do before it will support multisite. As you may know, multisite can get a bit complicated. |
| 119 |
|
| 120 |
With a single install, it’s easy to determine which plugins are active and manipulate them. With a multisite, there are network-activated plugins and plugins at the site level. And theoretically, Plugin Detective could run the whole network or just look at a single site. And there are permission differences between a network admin and a site admin. So it will take some work for us to support all that. We want to see how much interest there is in supporting multisite, and get some feedback from multisite users to understand what would be most useful for them and how they’d use it. |
| 121 |
|
| 122 |
If you're reading this, you likely want to use Plugin Detective to troubleshoot multisite installs. Please send us an email (team@nsquared.io) to let us know you're interested and answer a few questions to help us build this the right way: |
| 123 |
|
| 124 |
Would this just be a tool for you (the network admin)? Or would you want your site admins to be able to run it (and I assume they could only test their site-activated plugins, not disable any that you’ve network-activated?) |
| 125 |
|
| 126 |
|
| 127 |
== Screenshots == |
| 128 |
|
| 129 |
1. Troubleshoot link on the admin bar |
| 130 |
1. Welcome screen |
| 131 |
1. Seeing the problem on Otto's screen |
| 132 |
1. Marking the key witnesses (required plugins) |
| 133 |
1. Testing Otto's screen to see if the problem is still there |
| 134 |
1. Culprit found! Option to disable the problem plugin |
| 135 |
|
| 136 |
=== Changelog === |
| 137 |
|
| 138 |
== 1.2.14 - 2023-06-10 == |
| 139 |
|
| 140 |
= Features and Improvements = |
| 141 |
|
| 142 |
- Fix PHP 8.2 compatibility |
| 143 |
|
| 144 |
== 1.2.13 - 2023-05-25 == |
| 145 |
|
| 146 |
= Features and Improvements = |
| 147 |
|
| 148 |
- Update required WP version to 6.1 |
| 149 |
|
| 150 |
== 1.2.12 - 2023-05-25 == |
| 151 |
|
| 152 |
= Features and Improvements = |
| 153 |
|
| 154 |
- Update required WP version to 6.1 |
| 155 |
|
| 156 |
== 1.2.11 - 2023-04-27 == |
| 157 |
|
| 158 |
= Features and Improvements = |
| 159 |
|
| 160 |
PR:#25 - Compatibility with WordPress 6.2 |
| 161 |
|
| 162 |
== 1.2.10 - 2023-04-11 == |
| 163 |
|
| 164 |
= Fixes = |
| 165 |
|
| 166 |
PR:#19 - Prevent fatal error on WP versions where WP_Textdomain_Registry doesn… |
| 167 |
|
| 168 |
= Features and Improvements = |
| 169 |
|
| 170 |
== 1.2.9 - 2023-03-28 == |
| 171 |
|
| 172 |
= Fixes = |
| 173 |
|
| 174 |
= Features and Improvements = |
| 175 |
|
| 176 |
== 1.2.8 - 2023-03-28 == |
| 177 |
|
| 178 |
= Fixes = |
| 179 |
|
| 180 |
= Features and Improvements = |
| 181 |
|
| 182 |
== 1.2.7 - 2023-03-28 == |
| 183 |
|
| 184 |
= Fixes = |
| 185 |
|
| 186 |
= Features and Improvements = |
| 187 |
|
| 188 |
== 1.2.6 - 2023-02-24 == |
| 189 |
|
| 190 |
- no changes |
| 191 |
|
| 192 |
== 1.2.3 == |
| 193 |
|
| 194 |
- Fixed for WP 6.1 compatibility |
| 195 |
|
| 196 |
== 1.2.1 == |
| 197 |
|
| 198 |
- Fixed for WP 5.9 compatibility |
| 199 |
|
| 200 |
== 1.1.8 == |
| 201 |
|
| 202 |
- Fixed for WP 5.8 compatibility |
| 203 |
|
| 204 |
== 1.1.8 == |
| 205 |
|
| 206 |
|
| 207 |
For older changelog entries, please see the [additional changelog.txt file](https://plugins.svn.wordpress.org/plugin-detective/trunk/CHANGELOG.md) delivered with the plugin. |
| 208 |
|
