site_status_test_result filter-hookWP 5.3.0

Filters the output of a finished Site Health test.

Usage

add_filter( 'site_status_test_result', 'wp_kama_site_status_test_result_filter' );

/**
 * Function for `site_status_test_result` filter-hook.
 * 
 * @param array $test_result An associative array of test result data.
 *
 * @return array
 */
function wp_kama_site_status_test_result_filter( $test_result ){

	// filter...
	return $test_result;
}
$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.

Changelog

Since 5.3.0 Introduced.

Where the hook is called

WP_Site_Health::perform_test()
site_status_test_result
wp-admin/includes/class-wp-site-health.php 194
return apply_filters( 'site_status_test_result', call_user_func( $callback ) );

Where the hook is used in WordPress

Usage not found.