Make WordPress Core


Ignore:
Timestamp:
10/30/2021 01:39:24 PM (3 years ago)
Author:
SergeyBiryukov
Message:

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.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-debug-data.php

    r51949 r51956  
    14111411         * Add to or modify the debug information shown on the Tools -> Site Health -> Info screen.
    14121412         *
    1413          * Plugin or themes may wish to introduce their own debug information without creating additional admin pages
    1414          * they can utilize this filter to introduce their own sections or add more data to existing sections.
     1413         * Plugin or themes may wish to introduce their own debug information without creating
     1414         * additional admin pages. They can utilize this filter to introduce their own sections
     1415         * or add more data to existing sections.
    14151416         *
    1416          * Array keys for sections added by core are all prefixed with `wp-`, plugins and themes should use their own slug as
    1417          * a prefix, both for consistency as well as avoiding key collisions. Note that the array keys are used as labels
    1418          * for the copied data.
     1417         * Array keys for sections added by core are all prefixed with `wp-`. Plugins and themes
     1418         * should use their own slug as a prefix, both for consistency as well as avoiding
     1419         * key collisions. Note that the array keys are used as labels for the copied data.
    14191420         *
    1420          * All strings are expected to be plain text except `$description` that can contain inline HTML tags (see below).
     1421         * All strings are expected to be plain text except `$description` that can contain
     1422         * inline HTML tags (see below).
    14211423         *
    14221424         * @since 5.2.0
     
    14251427         *     The debug information to be added to the core information page.
    14261428         *
    1427          *     This is an associative multi-dimensional array, up to three levels deep. The topmost array holds the sections, keyed by section ID.
     1429         *     This is an associative multi-dimensional array, up to three levels deep.
     1430         *     The topmost array holds the sections, keyed by section ID.
    14281431         *
    14291432         *     @type array ...$0 {
    1430          *         Each section has a `$fields` associative array (see below), and each `$value` in `$fields` can be
    1431          *         another associative array of name/value pairs when there is more structured data to display.
     1433         *         Each section has a `$fields` associative array (see below), and each `$value` in `$fields`
     1434         *         can be another associative array of name/value pairs when there is more structured data
     1435         *         to display.
    14321436         *
    14331437         *         @type string $label       Required. The title for this section of the debug output.
    1434          *         @type string $description Optional. A description for your information section which may contain basic HTML
    1435          *                                   markup, inline tags only as it is outputted in a paragraph.
    1436          *         @type bool   $show_count  Optional. If set to `true` the amount of fields will be included in the title for
    1437          *                                   this section.
    1438          *         @type bool   $private     Optional. If set to `true` the section and all associated fields will be excluded
    1439          *                                   from the copied data. Default false.
     1438         *         @type string $description Optional. A description for your information section which
     1439         *                                   may contain basic HTML markup, inline tags only as it is
     1440         *                                   outputted in a paragraph.
     1441         *         @type bool   $show_count  Optional. If set to `true`, the amount of fields will be included
     1442         *                                   in the title for this section. Default false.
     1443         *         @type bool   $private     Optional. If set to `true`, the section and all associated fields
     1444         *                                   will be excluded from the copied data. Default false.
    14401445         *         @type array  $fields {
    1441          *             Required. An associative array containing the fields to be displayed in the section, keyed by field ID.
     1446         *             Required. An associative array containing the fields to be displayed in the section,
     1447         *             keyed by field ID.
    14421448         *
    14431449         *             @type array ...$0 {
     
    14451451         *
    14461452         *                 @type string $label    Required. The label for this piece of information.
    1447          *                 @type mixed  $value    Required. The output that is displayed for this field. Text should be translated. Can be
    1448          *                                        an associative array that is displayed as name/value pairs.
     1453         *                 @type mixed  $value    Required. The output that is displayed for this field.
     1454         *                                        Text should be translated. Can be an associative array
     1455         *                                        that is displayed as name/value pairs.
    14491456         *                                        Accepted types: `string|int|float|(string|int|float)[]`.
    1450          *                 @type string $debug    Optional. The output that is used for this field when the user copies the data.
    1451          *                                        It should be more concise and not translated. If not set, the content of `$value` is used.
    1452          *                                        Note that the array keys are used as labels for the copied data.
    1453          *                 @type bool   $private  Optional. If set to `true` the field will not be included in the copied data
    1454          *                                        allowing you to show, for example, API keys here. Default false.
     1457         *                 @type string $debug    Optional. The output that is used for this field when
     1458         *                                        the user copies the data. It should be more concise and
     1459         *                                        not translated. If not set, the content of `$value`
     1460         *                                        is used. Note that the array keys are used as labels
     1461         *                                        for the copied data.
     1462         *                 @type bool   $private  Optional. If set to `true`, the field will be excluded
     1463         *                                        from the copied data, allowing you to show, for example,
     1464         *                                        API keys here. Default false.
    14551465         *             }
    14561466         *         }
Note: See TracChangeset for help on using the changeset viewer.