From 1f1f1d64d8bea6fe718ca9a83de5e3dcf8f1547e Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sat, 30 Oct 2021 13:39:24 +0000 Subject: [PATCH] Docs: Further update the `debug_information` filter description per the documentation standards. Specifically, this ensures that the DocBlock follows the line wrapping recommendations. Follow-up to [44986], [45156], [45259], [51949]. See #53399. git-svn-id: https://develop.svn.wordpress.org/trunk@51956 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-admin/includes/class-wp-debug-data.php | 56 +++++++++++-------- 1 file changed, 33 insertions(+), 23 deletions(-) diff --git a/src/wp-admin/includes/class-wp-debug-data.php b/src/wp-admin/includes/class-wp-debug-data.php index 4746546b96..91c6b837c1 100644 --- a/src/wp-admin/includes/class-wp-debug-data.php +++ b/src/wp-admin/includes/class-wp-debug-data.php @@ -1410,48 +1410,58 @@ class WP_Debug_Data { /** * Add to or modify the debug information shown on the Tools -> Site Health -> Info screen. * - * Plugin or themes may wish to introduce their own debug information without creating additional admin pages - * they can utilize this filter to introduce their own sections or add more data to existing sections. + * Plugin or themes may wish to introduce their own debug information without creating + * additional admin pages. They can utilize this filter to introduce their own sections + * or add more data to existing sections. * - * Array keys for sections added by core are all prefixed with `wp-`, plugins and themes should use their own slug as - * a prefix, both for consistency as well as avoiding key collisions. Note that the array keys are used as labels - * for the copied data. + * Array keys for sections added by core are all prefixed with `wp-`. Plugins and themes + * should use their own slug as a prefix, both for consistency as well as avoiding + * key collisions. Note that the array keys are used as labels for the copied data. * - * All strings are expected to be plain text except `$description` that can contain inline HTML tags (see below). + * All strings are expected to be plain text except `$description` that can contain + * inline HTML tags (see below). * * @since 5.2.0 * * @param array $args { * The debug information to be added to the core information page. * - * This is an associative multi-dimensional array, up to three levels deep. The topmost array holds the sections, keyed by section ID. + * This is an associative multi-dimensional array, up to three levels deep. + * The topmost array holds the sections, keyed by section ID. * * @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. + * 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. * * @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 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. Default false. + * @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. + * 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. + * @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. + * @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 be excluded + * from the copied data, allowing you to show, for example, + * API keys here. Default false. * } * } * }