site_status_test_result

Advertisement

Summery Summery

Filter the output of a finished Site Health test.

Syntax Syntax

apply_filters( 'site_status_test_result', array $test_result )

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

Source Source

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

Advertisement

Changelog Changelog

Changelog
Version Description
5.3.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.