<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[46273] trunk/src/wp-includes/class-wp-recovery-mode-email-service.php: Site Health: Include simple debug data in fatal error protection email.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/46273">46273</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/46273","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2019-09-23 20:26:10 +0000 (Mon, 23 Sep 2019)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Site Health: Include simple debug data in fatal error protection email.
Introduce `recovery_email_debug_info` filter for the debug information included in the email.
Props Clorith, TimothyBlynJacobs.
Fixes <a href="https://core.trac.wordpress.org/ticket/48090">#48090</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswprecoverymodeemailservicephp">trunk/src/wp-includes/class-wp-recovery-mode-email-service.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswprecoverymodeemailservicephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/class-wp-recovery-mode-email-service.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-recovery-mode-email-service.php 2019-09-23 20:24:59 UTC (rev 46272)
+++ trunk/src/wp-includes/class-wp-recovery-mode-email-service.php 2019-09-23 20:26:10 UTC (rev 46273)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -138,7 +138,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $support = apply_filters( 'recovery_email_support_info', __( 'Please contact your host for assistance with investigating this issue further.' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /* translators: Do not translate LINK, EXPIRES, CAUSE, DETAILS, SITEURL, PAGEURL, SUPPORT: those are placeholders. */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Filters the debug information included in the fatal error protection email.
+ *
+ * @since 5.3.0
+ *
+ * @param $message array An associated array of debug information.
+ */
+ $debug = apply_filters( 'recovery_email_debug_info', $this->get_debug( $extension ) );
+
+ /* translators: Do not translate LINK, EXPIRES, CAUSE, DETAILS, SITEURL, PAGEURL, SUPPORT. DEBUG: those are placeholders. */
</ins><span class="cx" style="display: block; padding: 0 10px"> $message = __(
</span><span class="cx" style="display: block; padding: 0 10px"> 'Howdy!
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -154,6 +163,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> To keep your site safe, this link will expire in ###EXPIRES###. Don\'t worry about that, though: a new link will be emailed to you if the error occurs again after it expires.
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+When seeking help with this issue, you may be asked for some of the following information:
+###DEBUG###
+
</ins><span class="cx" style="display: block; padding: 0 10px"> ###DETAILS###'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> $message = str_replace(
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -165,6 +177,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> '###SITEURL###',
</span><span class="cx" style="display: block; padding: 0 10px"> '###PAGEURL###',
</span><span class="cx" style="display: block; padding: 0 10px"> '###SUPPORT###',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ '###DEBUG###',
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> $url,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -174,6 +187,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> home_url( '/' ),
</span><span class="cx" style="display: block; padding: 0 10px"> home_url( $_SERVER['REQUEST_URI'] ),
</span><span class="cx" style="display: block; padding: 0 10px"> $support,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ implode( "\r\n", $debug ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> $message
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -236,30 +250,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> private function get_cause( $extension ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'plugin' === $extension['type'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! function_exists( 'get_plugins' ) ) {
- require_once ABSPATH . 'wp-admin/includes/plugin.php';
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $plugin = $this->get_plugin( $extension );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $plugins = get_plugins();
-
- $name = '';
-
- // Assume plugin main file name first since it is a common convention.
- if ( isset( $plugins[ "{$extension['slug']}/{$extension['slug']}.php" ] ) ) {
- $name = $plugins[ "{$extension['slug']}/{$extension['slug']}.php" ]['Name'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( false === $plugin ) {
+ $name = $extension['slug'];
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $plugins as $file => $plugin_data ) {
- if ( 0 === strpos( $file, "{$extension['slug']}/" ) || $file === $extension['slug'] ) {
- $name = $plugin_data['Name'];
- break;
- }
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $name = $plugin['Name'];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( empty( $name ) ) {
- $name = $extension['slug'];
- }
-
</del><span class="cx" style="display: block; padding: 0 10px"> /* translators: %s: Plugin name. */
</span><span class="cx" style="display: block; padding: 0 10px"> $cause = sprintf( __( 'In this case, WordPress caught an error with one of your plugins, %s.' ), $name );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -272,4 +270,83 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> return $cause;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ /**
+ * Return the details for a single plugin based on the extension data from an error.
+ *
+ * @since 5.3.0
+ *
+ * @param array $extension The extension that caused the error.
+ * @return bool|array A plugin array {@see get_plugins()} or `false` if no plugin was found.
+ */
+ private function get_plugin( $extension ) {
+ if ( ! function_exists( 'get_plugins' ) ) {
+ require_once ABSPATH . 'wp-admin/includes/plugin.php';
+ }
+
+ $plugins = get_plugins();
+
+ // Assume plugin main file name first since it is a common convention.
+ if ( isset( $plugins[ "{$extension['slug']}/{$extension['slug']}.php" ] ) ) {
+ return $plugins[ "{$extension['slug']}/{$extension['slug']}.php" ];
+ } else {
+ foreach ( $plugins as $file => $plugin_data ) {
+ if ( 0 === strpos( $file, "{$extension['slug']}/" ) || $file === $extension['slug'] ) {
+ return $plugin_data;
+ }
+ }
+ }
+
+ return false;
+ }
+
+ /**
+ * Return debug information in an easy to manipulate format.
+ *
+ * @since 5.3.0
+ *
+ * @param array $extension The extension that caused the error.
+ * @return array An associated array of debug information.
+ */
+ private function get_debug( $extension ) {
+ $theme = wp_get_theme();
+ $wp_version = get_bloginfo( 'version' );
+
+ if ( $extension ) {
+ $plugin = $this->get_plugin( $extension );
+ } else {
+ $plugin = null;
+ }
+
+ $debug = array(
+ /* translators: %s: Current WordPress version number. */
+ 'wp' => sprintf(
+ __( 'WordPress version %s' ),
+ $wp_version
+ ),
+ 'theme' => sprintf(
+ /* translators: 1: Current active theme name. 2: Current active theme version. */
+ __( 'Current theme: %1$s (version %2$s)' ),
+ $theme->get( 'Name' ),
+ $theme->get( 'Version' )
+ ),
+ );
+
+ if ( null !== $plugin ) {
+ $debug['plugin'] = sprintf(
+ /* translators: 1: The failing plugins name. 2: The failing plugins version. */
+ __( 'Current plugin: %1$s (version %2$s)' ),
+ $plugin['Name'],
+ $plugin['Version']
+ );
+ }
+
+ $debug['php'] = sprintf(
+ /* translators: %s: The currently used PHP version. */
+ __( 'PHP version %s' ),
+ PHP_VERSION
+ );
+
+ return $debug;
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>