Health Check & Troubleshooting

Description

This plugin will perform a number of checks on your WordPress installation to detect common configuration errors and known issues, and also allows plugins and themes to add their own checks.

The debug section, which allows you to gather information about your WordPress and server configuration that you may easily share with support representatives for themes, plugins or on the official WordPress.org support forums.

Troubleshooting allows you to have a clean WordPress session, where all plugins are disabled, and a default theme is used, but only for your user until you disable it or log out.

The Tools section allows you to check that WordPress files have not been tampered with, that emails can be sent, and if your plugins are compatible with any PHP version updates in the future.

For a more extensive example of how to efficiently use the Health Check plugin, check out the WordPress.org support team handbook page about this plugin.

Feedback is welcome both through the WordPress.org forums, the GitHub project page, or on Slack in either #forums or #core-site-health.

Screenshots

  • The health check screen after the automated tests have gone over the system.
  • The debug information, with the copy and paste field expanded.
  • A selection of tools that can be ran on your site.
  • Troubleshooting mode enabled, showing your website Dashboard

FAQ

I am unable to access my site after enabling troubleshooting

If you should find your self stuck in Troubleshooting Mode for any reason, you can easily disable it by clearing your cookies.

Are you unfamiliar with how to clear your cookies? No worries, you may also close all your browser windows, or perform a computer restart and it will clear this specific cookie automatically.

The PHP compatibility says this plugin only work with PHP version X?

The plugin is made to be a support tool for as many users as possible, this means it needs code that is written for older sites as well.

Tools that check for PHP compatibility do not know how to separate this code from the real code, so it will give a false positive response.

At this time, the plugin has been tested with every version of PHP from 5.2 through 7.3, and works with all of these.

Where can I report security bugs?

The Site Health team and WordPress community take security bugs seriously. We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions.

To report a security issue, please visit the WordPress HackerOne program.

Reviews

Me 23, 2024
The Site Kit plugin wasn’t working as it should so I Googled for an answer. Found Health Check & Troubleshooting, followed instructions. Result: happiness. Simple to use and efficient for me. Thank you.
Me 8, 2024
Bei mir hat dieses Plugin perfekt funktioniert, danke!!!Zur Funktionsweise: Sobald dieses Plugin installiert und aktiviert ist, werden alle anderen Plugins deaktiviert. Nun kann man nacheinander jedes der schon zuvor vorhandenen Plugins aktivieren und jeweils prüfen, ob das Problem soeben behoben wurde.Bei meiner Webseite hatte < MainWP Child > das Problem verursacht.
Hwevrer 18, 2024
Too bad I didn’t read the warnings here before I installed. Installed, activated, and selected Troubleshooting. Boom! Site is gone. Error 500 with nothing in the logs. Deleting the plugin via ftp didn’t help so now I have to get it restored from backup. Pathetic.
Hwevrer 11, 2024
As others have said, troubleshooting mode breaks your website. You will abruptly lose access to the dashboard, can’t login, and the website itself won’t load for users. The fix? Go into your web directory through FTP and delete the plugin from your wp-content folder. When I did this I was able to reload the dashboard. Oddly, even without the plugin, I was prompted to disable troubleshooting mode, which I did, and then everything was restored. Update: After deleting the plugin through FTP, the ability to “troubleshoot” from the plugins page was still there — and causes a “critical error”. Thankfully, the back button took me back. There’s also a weird “must use” plugin artifact. By re-installing Health Check (but NOT activating it) and then deleting it again, these artifacts disappear. What a disaster of a plugin.
Read all 164 reviews

Contributors & Developers

“Health Check & Troubleshooting” is open source software. The following people have contributed to this plugin.

Contributors

“Health Check & Troubleshooting” has been translated into 30 locales. Thank you to the translators for their contributions.

Translate “Health Check & Troubleshooting” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.7.0 (2023-08-06)

  • General: Improved styling inconsistency between the plugin and WordPress core.
  • General: Fixed an issue with plugin translations where language strings would get mixed when using third party language plugins, or a separate profile language.
  • Troubleshooting Mode: Fixed the URL used when disabling elements and having a subdirectory installation.
  • Troubleshooting Mode: Fixed a deprecation warning when disabling troubleshooting mode on PHP version 8.3 or higher.
  • Troubleshooting Mode: Added reference on how to troubleshoot as different users when testing scenarios.
  • Tools: Fixed integration with WPTide for the PHP Compatibility checker.
  • Tools: Added a viewer that will display debug log output when enabled.
  • Tools: Added a warning to the File Integrity tester if unexpected files are mixed in with WordPress core files.
  • Tools: Added a warning if sending emails is taking longer than expected.
  • Tools: Added beta feature toggle for those who wish to test new functionality that may not be fully ready yet.
  • CLI: Fixed the CLI commands, you can now wp health-check status to your hearts content!
  • Beta feature: Added a new beta feature, making it easier for non-technical users to grab screenshots of issues on their site, and share them.

v1.6.0 (2023-03-31)

  • Improved the visual aspects of the Troubleshooting Mode Widget.
  • Improved security by hardening Troubleshooting Mode actions with security tokens (nonces).
  • Added a new tool to check .htaccess rules (where applicable).
  • Added TwentyTwenty Three to the list of default themes.
  • Added option to install the latest classic (non Site Editor-focused) default theme if no default theme exists.
  • Added a new security confirmation prompt in Troubleshooting Mode, if a security token (nonce) value is either expired, or missing.
  • Added better documentation around reporting security concerns.
  • Fixed a bug where notices from previous Troubleshooting sessions would show up in a new session, which is just confusing.