WP_Site_Health::get_tests()public staticWP 5.2.0

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

Each site status test is defined here, they may be direct tests, that run on page load, or async tests which will run later down the line via JavaScript calls to improve page performance and hopefully also user experiences.

Метод класса: WP_Site_Health{}

Хуки из метода

Возвращает

Массив. The list of tests to run.

Использование

$result = WP_Site_Health::get_tests();

Список изменений

С версии 5.2.0 Введена.
С версии 5.6.0 Added support for has_rest and permissions.

Код WP_Site_Health::get_tests() WP 6.1.1

public static function get_tests() {
	$tests = array(
		'direct' => array(
			'wordpress_version'         => array(
				'label' => __( 'WordPress Version' ),
				'test'  => 'wordpress_version',
			),
			'plugin_version'            => array(
				'label' => __( 'Plugin Versions' ),
				'test'  => 'plugin_version',
			),
			'theme_version'             => array(
				'label' => __( 'Theme Versions' ),
				'test'  => 'theme_version',
			),
			'php_version'               => array(
				'label' => __( 'PHP Version' ),
				'test'  => 'php_version',
			),
			'php_extensions'            => array(
				'label' => __( 'PHP Extensions' ),
				'test'  => 'php_extensions',
			),
			'php_default_timezone'      => array(
				'label' => __( 'PHP Default Timezone' ),
				'test'  => 'php_default_timezone',
			),
			'php_sessions'              => array(
				'label' => __( 'PHP Sessions' ),
				'test'  => 'php_sessions',
			),
			'sql_server'                => array(
				'label' => __( 'Database Server version' ),
				'test'  => 'sql_server',
			),
			'utf8mb4_support'           => array(
				'label' => __( 'MySQL utf8mb4 support' ),
				'test'  => 'utf8mb4_support',
			),
			'ssl_support'               => array(
				'label' => __( 'Secure communication' ),
				'test'  => 'ssl_support',
			),
			'scheduled_events'          => array(
				'label' => __( 'Scheduled events' ),
				'test'  => 'scheduled_events',
			),
			'http_requests'             => array(
				'label' => __( 'HTTP Requests' ),
				'test'  => 'http_requests',
			),
			'rest_availability'         => array(
				'label'     => __( 'REST API availability' ),
				'test'      => 'rest_availability',
				'skip_cron' => true,
			),
			'debug_enabled'             => array(
				'label' => __( 'Debugging enabled' ),
				'test'  => 'is_in_debug_mode',
			),
			'file_uploads'              => array(
				'label' => __( 'File uploads' ),
				'test'  => 'file_uploads',
			),
			'plugin_theme_auto_updates' => array(
				'label' => __( 'Plugin and theme auto-updates' ),
				'test'  => 'plugin_theme_auto_updates',
			),
		),
		'async'  => array(
			'dotorg_communication' => array(
				'label'             => __( 'Communication with WordPress.org' ),
				'test'              => rest_url( 'wp-site-health/v1/tests/dotorg-communication' ),
				'has_rest'          => true,
				'async_direct_test' => array( WP_Site_Health::get_instance(), 'get_test_dotorg_communication' ),
			),
			'background_updates'   => array(
				'label'             => __( 'Background updates' ),
				'test'              => rest_url( 'wp-site-health/v1/tests/background-updates' ),
				'has_rest'          => true,
				'async_direct_test' => array( WP_Site_Health::get_instance(), 'get_test_background_updates' ),
			),
			'loopback_requests'    => array(
				'label'             => __( 'Loopback request' ),
				'test'              => rest_url( 'wp-site-health/v1/tests/loopback-requests' ),
				'has_rest'          => true,
				'async_direct_test' => array( WP_Site_Health::get_instance(), 'get_test_loopback_requests' ),
			),
			'https_status'         => array(
				'label'             => __( 'HTTPS status' ),
				'test'              => rest_url( 'wp-site-health/v1/tests/https-status' ),
				'has_rest'          => true,
				'async_direct_test' => array( WP_Site_Health::get_instance(), 'get_test_https_status' ),
			),
		),
	);

	// Conditionally include Authorization header test if the site isn't protected by Basic Auth.
	if ( ! wp_is_site_protected_by_basic_auth() ) {
		$tests['async']['authorization_header'] = array(
			'label'     => __( 'Authorization header' ),
			'test'      => rest_url( 'wp-site-health/v1/tests/authorization-header' ),
			'has_rest'  => true,
			'headers'   => array( 'Authorization' => 'Basic ' . base64_encode( 'user:pwd' ) ),
			'skip_cron' => true,
		);
	}

	// Only check for caches in production environments.
	if ( 'production' === wp_get_environment_type() ) {
		$tests['async']['page_cache'] = array(
			'label'             => __( 'Page cache' ),
			'test'              => rest_url( 'wp-site-health/v1/tests/page-cache' ),
			'has_rest'          => true,
			'async_direct_test' => array( WP_Site_Health::get_instance(), 'get_test_page_cache' ),
		);

		$tests['direct']['persistent_object_cache'] = array(
			'label' => __( 'Persistent object cache' ),
			'test'  => 'persistent_object_cache',
		);
	}

	/**
	 * Filters which site status tests are run on a site.
	 *
	 * The site health is determined by a set of tests based on best practices from
	 * both the WordPress Hosting Team and 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.
	 *
	 * @since 5.2.0
	 * @since 5.6.0 Added the `async_direct_test` array key for asynchronous tests.
	 *              Added the `skip_cron` array key for all tests.
	 *
	 * @param array[] $tests {
	 *     An associative array of direct and asynchronous tests.
	 *
	 *     @type array[] $direct {
	 *         An array of direct tests.
	 *
	 *         @type array ...$identifier {
	 *             `$identifier` should be a unique identifier for the test. Plugins and themes are encouraged to
	 *             prefix test identifiers with their slug to avoid collisions between tests.
	 *
	 *             @type string   $label     The friendly label to identify the test.
	 *             @type callable $test      The callback function that runs the test and returns its result.
	 *             @type bool     $skip_cron Whether to skip this test when running as cron.
	 *         }
	 *     }
	 *     @type array[] $async {
	 *         An array of asynchronous tests.
	 *
	 *         @type array ...$identifier {
	 *             `$identifier` should be a unique identifier for the test. Plugins and themes are encouraged to
	 *             prefix test identifiers with their slug to avoid collisions between tests.
	 *
	 *             @type string   $label             The friendly label to identify the test.
	 *             @type string   $test              An admin-ajax.php action to be called to perform the test, or
	 *                                               if `$has_rest` is true, a URL to a REST API endpoint to perform
	 *                                               the test.
	 *             @type bool     $has_rest          Whether the `$test` property points to a REST API endpoint.
	 *             @type bool     $skip_cron         Whether to skip this test when running as cron.
	 *             @type callable $async_direct_test A manner of directly calling the test marked as asynchronous,
	 *                                               as the scheduled event can not authenticate, and endpoints
	 *                                               may require authentication.
	 *         }
	 *     }
	 * }
	 */
	$tests = apply_filters( 'site_status_tests', $tests );

	// Ensure that the filtered tests contain the required array keys.
	$tests = array_merge(
		array(
			'direct' => array(),
			'async'  => array(),
		),
		$tests
	);

	return $tests;
}