apply_filters( 'site_status_tests', array $test_type )

Add or modify which site status tests are run on a site.

Description

The site health is determined by a set of tests based on best practices from both the WordPress Hosting Team, but also web standards in general.

Some sites may not have the same requirements, for example the automatic update checks may be handled by a host, and are therefore disabled in core. Or maybe you want to introduce a new test, is caching enabled/disabled/stale for example.

Tests may be added either as direct, or asynchronous ones. Any test that may require some time to complete should run asynchronously, to avoid extended loading periods within wp-admin.

Parameters

$test_type

(array) An associative array, where the $test_type is either direct or async, to declare if the test should run via Ajax calls after page load.

  • 'identifier'
    (array) $identifier should be a unique identifier for the test that should run. Plugins and themes are encouraged to prefix test identifiers with their slug to avoid any collisions between tests.
    • 'label'
      (string) A friendly label for your test to identify it by.
    • 'test'
      (mixed) A callable to perform a direct test, or a string AJAX action to be called to perform an async test.
    • 'has_rest'
      (boolean) Optional. Denote if $test has a REST API endpoint.
    • 'skip_cron'
      (boolean) Whether to skip this test when running as cron.
    • 'async_direct_test'
      (callable) A manner of directly calling the test marked as asynchronous, as the scheduled event can not authenticate, and endpoints may require authentication.

Source

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

View on Trac

Used By

Used By Description
wp-admin/includes/class-wp-site-health.php: WP_Site_Health::get_tests()

Return a set of tests that belong to the site status page.

Changelog

Version Description
5.6.0 Added the async_direct_test array key. Added the skip_cron array key.
5.2.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/hooks/site_status_tests