<!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>[51949] trunk/src/wp-admin/includes/class-wp-debug-data.php: Site Health: Correct and improve the documentation for the `debug_information` hook.</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/51949">51949</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/51949","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-10-29 15:33:18 +0000 (Fri, 29 Oct 2021)</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: Correct and improve the documentation for the `debug_information` hook.
This corrects the structure of the documentation so it accurately reflects the array elements contained within.
See <a href="https://core.trac.wordpress.org/ticket/53399">#53399</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesclasswpdebugdataphp">trunk/src/wp-admin/includes/class-wp-debug-data.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesclasswpdebugdataphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/class-wp-debug-data.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/class-wp-debug-data.php 2021-10-28 19:20:19 UTC (rev 51948)
+++ trunk/src/wp-admin/includes/class-wp-debug-data.php 2021-10-29 15:33:18 UTC (rev 51949)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1408,7 +1408,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><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">- * Add or modify the debug information.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Add to or modify the debug information shown on the Tools -> Site Health -> Info screen.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Plugin or themes may wish to introduce their own debug information without creating additional admin pages
</span><span class="cx" style="display: block; padding: 0 10px"> * they can utilize this filter to introduce their own sections or add more data to existing sections.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1417,7 +1417,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * a prefix, both for consistency as well as avoiding key collisions. Note that the array keys are used as labels
</span><span class="cx" style="display: block; padding: 0 10px"> * for the copied data.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * All strings are expected to be plain text except $description that can contain inline HTML tags (see below).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * All strings are expected to be plain text except `$description` that can contain inline HTML tags (see below).
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.2.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1424,28 +1424,36 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $args {
</span><span class="cx" style="display: block; padding: 0 10px"> * The debug information to be added to the core information page.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * This is an associative multi-dimensional array, up to three levels deep. The topmost array holds the sections.
- * Each section has a `$fields` associative array (see below), and each `$value` in `$fields` can be
- * another associative array of name/value pairs when there is more structured data to display.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * This is an associative multi-dimensional array, up to three levels deep. The topmost array holds the sections, keyed by section ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $label The title for this section of the debug output.
- * @type string $description Optional. A description for your information section which may contain basic HTML
- * markup, inline tags only as it is outputted in a paragraph.
- * @type boolean $show_count Optional. If set to `true` the amount of fields will be included in the title for
- * this section.
- * @type boolean $private Optional. If set to `true` the section and all associated fields will be excluded
- * from the copied data.
- * @type array $fields {
- * An associative array containing the data to be displayed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array ...$0 {
+ * Each section has a `$fields` associative array (see below), and each `$value` in `$fields` can be
+ * another associative array of name/value pairs when there is more structured data to display.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type string $label The label for this piece of information.
- * @type string $value The output that is displayed for this field. Text should be translated. Can be
- * an associative array that is displayed as name/value pairs.
- * @type string $debug Optional. The output that is used for this field when the user copies the data.
- * It should be more concise and not translated. If not set, the content of `$value` is used.
- * Note that the array keys are used as labels for the copied data.
- * @type boolean $private Optional. If set to `true` the field will not be included in the copied data
- * allowing you to show, for example, API keys here.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type string $label Required. The title for this section of the debug output.
+ * @type string $description Optional. A description for your information section which may contain basic HTML
+ * markup, inline tags only as it is outputted in a paragraph.
+ * @type bool $show_count Optional. If set to `true` the amount of fields will be included in the title for
+ * this section.
+ * @type bool $private Optional. If set to `true` the section and all associated fields will be excluded
+ * from the copied data. Default false.
+ * @type array $fields {
+ * Required. An associative array containing the fields to be displayed in the section, keyed by field ID.
+ *
+ * @type array ...$0 {
+ * An associative array containing the data to be displayed for the field.
+ *
+ * @type string $label Required. The label for this piece of information.
+ * @type mixed $value Required. The output that is displayed for this field. Text should be translated. Can be
+ * an associative array that is displayed as name/value pairs.
+ * Accepted types: `string|int|float|(string|int|float)[]`.
+ * @type string $debug Optional. The output that is used for this field when the user copies the data.
+ * It should be more concise and not translated. If not set, the content of `$value` is used.
+ * Note that the array keys are used as labels for the copied data.
+ * @type bool $private Optional. If set to `true` the field will not be included in the copied data
+ * allowing you to show, for example, API keys here. Default false.
+ * }
+ * }
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre>
</div>
</div>
</body>
</html>