云策 WordPress 开发者社区

钩子文档

debug_information

查看官方原文 ↗
💡 云策文档标注

概述

debug_information 过滤器用于在 WordPress 的“工具 -> 站点健康 -> 信息”屏幕中，允许插件或主题添加自定义调试信息，无需创建额外管理页面。它通过过滤数组参数来扩展或修改调试数据输出。

关键要点

  • 过滤器名称：debug_information，用于修改站点健康信息页面的调试数据。
  • 核心用途：插件和主题可添加自定义部分或字段，以显示特定调试信息，如版本、配置或API密钥。
  • 数组结构：参数为多维关联数组，顶层键为部分ID，包含标签、描述、字段等属性。
  • 命名约定：核心部分ID以“wp-”为前缀，插件和主题应使用自身slug作为前缀以避免键冲突。
  • 字段属性：字段包括标签、值、调试输出和私有标志，支持文本、数字、数组等类型。
  • 私有数据：通过设置private为true，可隐藏敏感信息（如API密钥）在复制数据中。

代码示例

$info = apply_filters( 'debug_information', $info );

注意事项

  • 字符串应翻译，但$description可包含内联HTML标签，$debug输出应简洁且不翻译。
  • 数组键在复制数据时用作标签，需确保唯一性和可读性。
  • 此过滤器自WordPress 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).

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.
  • ...$0 array
    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.
    • label string
      Required. The title for this section of the debug output.
    • description string
      Optional. A description for your information section which may contain basic HTML markup, inline tags only as it is outputted in a paragraph.
    • show_count bool
      Optional. If set to true, the amount of fields will be included in the title for this section. Default false.
    • private bool
      Optional. If set to true, the section and all associated fields will be excluded from the copied data. Default false.
    • fields array
      Required. An associative array containing the fields to be displayed in the section, keyed by field ID.
      • ...$0 array
        An associative array containing the data to be displayed for the field.
        • label string
          Required. The label for this piece of information.
        • value mixed
          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)[].
        • debug string
          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.
        • private bool
          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.
          } }

Source

$info = apply_filters( 'debug_information', $info );

View all references View on Trac View on GitHub

Used byDescription
WP_Debug_Data::debug_data()wp-admin/includes/class-wp-debug-data.php

Static function for generating site debug data when required.

Changelog

VersionDescription
5.2.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.