WP_Site_Health::perform_test( callable $callback ): mixed|void

In this article

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Runs a Site Health test directly.

Parameters

$callbackcallablerequired

Return

mixed|void

Source

private function perform_test( $callback ) {
	/**
	 * Filters the output of a finished Site Health test.
	 *
	 * @since 5.3.0
	 *
	 * @param array $test_result {
	 *     An associative array of test result data.
	 *
	 *     @type string $label       A label describing the test, and is used as a header in the output.
	 *     @type string $status      The status of the test, which can be a value of `good`, `recommended` or `critical`.
	 *     @type array  $badge {
	 *         Tests are put into categories which have an associated badge shown, these can be modified and assigned here.
	 *
	 *         @type string $label The test label, for example `Performance`.
	 *         @type string $color Default `blue`. A string representing a color to use for the label.
	 *     }
	 *     @type string $description A more descriptive explanation of what the test looks for, and why it is important for the end user.
	 *     @type string $actions     An action to direct the user to where they can resolve the issue, if one exists.
	 *     @type string $test        The name of the test being ran, used as a reference point.
	 * }
	 */
	return apply_filters( 'site_status_test_result', call_user_func( $callback ) );
}

Hooks

apply_filters( ‘site_status_test_result’, array $test_result )

Filters the output of a finished Site Health test.

Changelog

VersionDescription
5.4.0Introduced.

User Contributed Notes

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