site_status_test_result WordPress Filter Hook

The site_status_test_result hook is used to return the results of a site status test in WordPress. This hook is used by the Site Status Test Result plugin.

apply_filters( 'site_status_test_result', array $test_result ) #

Filters the output of a finished Site Health test.


Parameters

$test_result

(array)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.


Top ↑

Source

File: wp-admin/includes/class-wp-site-health.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
5.3.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.