Changeset 49154 for trunk/src/wp-admin/includes/class-wp-site-health.php

Timestamp:

10/15/2020 01:58:28 AM (4 years ago)

Author:

TimothyBlynJacobs

Message:

Site Health, REST API: Move async tests to REST API endpoints.

This provides more flexibility when writing tests and benefits from running in a front-end context which is necessary for some tests like checking that updates are supported. Additionally, this provides a more robust interface for developers who want to integrate with Site Health tests.

Because the wp/v2 endpoint is reserved for modeling core entities, site health is registered in its own wp-site-health/v1 namespace.

The existing ajax actions have been maintained for backward compatibility.

Props Clorith, chrisvanpatten, afragen, pokhriyal, TimothyBlynJacobs.
Fixes #48105.

File:

• trunk/src/wp-admin/includes/class-wp-site-health.php (modified) (4 diffs)

trunk/src/wp-admin/includes/class-wp-site-health.php

@@ -134 +134 @@
                     $health_check_js_variables['site_status']['async'][] = array(
                         'test'      => $test['test'],
+                        'has_rest'  => ( isset( $test['has_rest'] ) ? $test['has_rest'] : false ),
                         'completed' => false,
                     );
@@ -2081 +2082 @@
      *
      * @since 5.2.0
+     * @since 5.6.0 Added support for `has_rest` and `permissions`.
      *
      * @return array The list of tests to run.
@@ -2154 +2156 @@
             'async'  => array(
                 'dotorg_communication' => array(
-                    'label' => __( 'Communication with WordPress.org' ),
-                    'test'  => 'dotorg_communication',
+                    'label'    => __( 'Communication with WordPress.org' ),
+                    'test'     => rest_url( 'wp-site-health/v1/tests/dotorg-communication' ),
+                    'has_rest' => true,
                 ),
                 'background_updates'   => array(
-                    'label' => __( 'Background updates' ),
-                    'test'  => 'background_updates',
+                    'label'    => __( 'Background updates' ),
+                    'test'     => rest_url( 'wp-site-health/v1/tests/background-updates' ),
+                    'has_rest' => true,
                 ),
                 'loopback_requests'    => array(
-                    'label' => __( 'Loopback request' ),
-                    'test'  => 'loopback_requests',
+                    'label'    => __( 'Loopback request' ),
+                    'test'     => rest_url( 'wp-site-health/v1/tests/loopback-requests' ),
+                    'has_rest' => true,
                 ),
             ),
@@ -2200 +2205 @@
          *         to avoid any collisions between tests.
          *
-         *         @type string $label A friendly label for your test to identify it by.
-         *         @type mixed  $test  A callable to perform a direct test, or a string Ajax action to be called
-         *                             to perform an async test.
+         *         @type string  $label       A friendly label for your test to identify it by.
+         *         @type mixed   $test        A callable to perform a direct test, or a string AJAX action to be
+         *                                    called to perform an async test.
+         *         @type boolean $has_rest    Optional. Denote if `$test` has a REST API endpoint.
          *     }
          * }