wppaste
WordPress

apply_filters( 'debug_information', array $args )

Since
5.2.0
Filters the debug information shown on the Tools -> Site Health -> Info screen.

Description

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.

All strings are expected to be plain text except $description that can contain inline HTML tags (see below).

Compatibility

WordPress
since 5.2.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$argsarray
{ 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.
@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.
@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. 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.
@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 be excluded from the copied data, allowing you to show, for example, API keys here. Default false.
} } } }

  • ...$0array

    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.

    • $labelstring

      Required. The title for this section of the debug output.

    • $descriptionstring

      Optional. A description for your information section which may contain basic HTML markup, inline tags only as it is outputted in a paragraph.

    • $show_countbool

      Optional. If set to true, the amount of fields will be included in the title for this section. Default false.

    • $privatebool

      Optional. If set to true, the section and all associated fields will be excluded from the copied data. Default false.

    • $fieldsarray

      Required. An associative array containing the fields to be displayed in the section, keyed by field ID.

      • ...$0array

        An associative array containing the data to be displayed for the field.

        • $labelstring

          Required. The label for this piece of information.

        • $valuemixed

          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)[].

        • $debugstring

          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.

        • $privatebool

          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. } }

Where this hook fires · 1

  • wp-admin/includes/class-wp-debug-data.php:135WP_Debug_Data::debug_data()

Source code

View on Trac View on GitHub 

		 *                                        API keys here. Default false.		 *             }		 *         }		 *     }		 * }		 */		$info = apply_filters( 'debug_information', $info ); 		return $info;	} 	/**	 * Gets the WordPress core section of the debug data.

Changelog

Introduced in 5.2.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.