Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-10-01 16:48:26 +02:00
Code Issues Projects Releases Wiki Activity

Site Health: Correct and improve the documentation for the debug_information hook.

Browse Source 
This corrects the structure of the documentation so it accurately reflects the array elements contained within.

See #53399.

Built from https://develop.svn.wordpress.org/trunk@51949


git-svn-id: http://core.svn.wordpress.org/trunk@51538 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2021-10-29 15:35:00 +00:00
parent 2f3b779563
commit a0d8a60547
2 changed files with 31 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
wp-admin/includes/class-wp-debug-data.php
View File

@ -1408,7 +1408,7 @@ class WP_Debug_Data {
} }
/** /**
* Add or modify the debug information. * 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 * 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. * they can utilize this filter to introduce their own sections or add more data to existing sections.
@ -1417,35 +1417,43 @@ class WP_Debug_Data {
* a prefix, both for consistency as well as avoiding key collisions. Note that the array keys are used as labels * a prefix, both for consistency as well as avoiding key collisions. Note that the array keys are used as labels
* for the copied data. * 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 * @since 5.2.0
* *
* @param array $args { * @param array $args {
* The debug information to be added to the core information page. * 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. * This is an associative multi-dimensional array, up to three levels deep. The topmost array holds the sections, keyed by section ID.
* 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 The title for this section of the debug output. * @type array ...$0 {
* @type string $description Optional. A description for your information section which may contain basic HTML * Each section has a `$fields` associative array (see below), and each `$value` in `$fields` can be
* markup, inline tags only as it is outputted in a paragraph. * another associative array of name/value pairs when there is more structured data to display.
* @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.
* *
* @type string $label The label for this piece of information. * @type string $label Required. The title for this section of the debug output.
* @type string $value The output that is displayed for this field. Text should be translated. Can be * @type string $description Optional. A description for your information section which may contain basic HTML
* an associative array that is displayed as name/value pairs. * markup, inline tags only as it is outputted in a paragraph.
* @type string $debug Optional. The output that is used for this field when the user copies the data. * @type bool $show_count Optional. If set to `true` the amount of fields will be included in the title for
* It should be more concise and not translated. If not set, the content of `$value` is used. * this section.
* Note that the array keys are used as labels for the copied data. * @type bool $private Optional. If set to `true` the section and all associated fields will be excluded
* @type boolean $private Optional. If set to `true` the field will not be included in the copied data * from the copied data. Default false.
* allowing you to show, for example, API keys here. * @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.
* }
* }
* } * }
* } * }
*/ */

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '5.9-alpha-51947'; $wp_version = '5.9-alpha-51949';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.