#48090 closed enhancement (fixed)
Provide simple debug data in WSOD emails
Reported by: | Clorith | Owned by: | SergeyBiryukov |
---|---|---|---|
Milestone: | 5.3 | Priority: | normal |
Severity: | normal | Version: | 5.2 |
Component: | Site Health | Keywords: | has-patch commit |
Focuses: | Cc: |
Description
Errors are terrible, if you're not familiar with troubleshooting, they're even worse.
What happens if you get the dreaded email from WordPress, your site has crashed, you know something broke, but are lost beyond that, so you go to seek help in fixing it. Unfortunately you can't help others, help you. They asked you something simple; what version of the Plugin X are you using? You have no idea, you feel lost, those helping you feel frustration, it's bad times all around.
But wait, there, in the distance, a shimmering light!
When an error email is sent, let's include a new section, prefix it with When seeking help with this issue, you may be asked for some of the following information
, and then add the current WP version, the plugin version of that which broke, what theme is in use would also be handy, this is all information we can readily grab and provide after all!
Attachments (2)
Change History (9)
#2
@
5 years ago
This would be awesome. I think adding the PHP version would be highly valuable here as well.
#3
@
5 years ago
Sounds reasonable as a likely cause of a failure, 48090.2.patch includes this.
#4
@
5 years ago
- Milestone changed from 5.3 to 5.4
With version 5.3 Beta 1 landing today, this is being moved into 5.4 based on recent momentum.
#5
@
5 years ago
- Owner set to SergeyBiryukov
- Resolution set to fixed
- Status changed from new to closed
In 46273:
48090.patch expands the email sent with the most commonly asked questions when something crashes, namely the WordPress version, what theme is being used, and the version of the plugin that caused an issue (if caused by a plugin).
These are all created as an associated array, which is filterable through
recovery_email_debug_info
, making it possible to add more details in some scenarios.The information sent is intentionally constricted on our end, to avoid information overload and confusion for the end user.
The patch also moves the code for fetching plugin details out of the
get_cause()
function to a separateget_plugin()
call so that it can be reused more easily when building the error email.