钩子文档

site_status_test_result

💡 云策文档标注

概述

本文档介绍 WordPress 中的 site_status_test_result 过滤器,用于修改已完成站点健康测试的输出结果。该过滤器允许开发者自定义测试结果的显示内容,如标签、状态、徽章等。

关键要点

  • site_status_test_result 过滤器用于过滤站点健康测试的输出,参数为 $test_result 数组。
  • 参数包括 label(测试标签)、status(状态值如 good、recommended、critical)、badge(徽章信息)、description(描述)、actions(解决操作)和 test(测试名称)。
  • 过滤器在 WP_Site_Health::perform_test() 中被调用,自 WordPress 5.3.0 版本引入。

代码示例

return apply_filters( 'site_status_test_result', call_user_func( $callback ) );

📄 原文内容

Filters the output of a finished Site Health test.

Parameters

$test_resultarray
An associative array of test result data.
  • label string
    A label describing the test, and is used as a header in the output.
  • status string
    The status of the test, which can be a value of good, recommended or critical.
  • badge array
    Tests are put into categories which have an associated badge shown, these can be modified and assigned here.
    • label string
      The test label, for example Performance.
    • color string
      Default blue. A string representing a color to use for the label.
  • description string
    A more descriptive explanation of what the test looks for, and why it is important for the end user.
  • actions string
    An action to direct the user to where they can resolve the issue, if one exists.
  • test string
    The name of the test being ran, used as a reference point.

Source

return apply_filters( 'site_status_test_result', call_user_func( $callback ) );

Changelog

VersionDescription
5.3.0Introduced.

User Contributed Notes

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