Changeset 54205

Timestamp:

09/19/2022 03:28:33 PM (2 years ago)

Author:

Clorith

Message:

Site Health: Improve the details provided by the REST API checks.

The descriptions provided whenever a REST API check failed lacked details that would help in troubleshooting any issues, most notably the actual REST API endpoint that was being tested.

Adding this vital piece of detail, along with a revamp of the error messages shown, where previously there was a risk that the markup of your website was included as an error message, improves the overall user experience, and gives more accurate details that can be looked when looking up how to fix or improve the behavior of the REST API.

Props dingo_d, shetheliving.
Fixes #54617.

File:

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

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

@@ -2053 +2053 @@
             'description' => sprintf(
                 '<p>%s</p>',
-                __( 'The REST API is one way WordPress, and other applications, communicate with the server. One example is the block editor screen, which relies on this to display, and save, your posts and pages.' )
+                __( 'The REST API is one way that WordPress and other applications communicate with the server. For example, the block editor screen relies on the REST API to display and save your posts and pages.' )
             ),
             'actions'     => '',
@@ -2091 +2091 @@
 
             $result['description'] .= sprintf(
-                '<p>%s</p>',
+                '<p>%s</p><p>%s<br>%s</p>',
+                __( 'When testing the REST API, an error was encountered:' ),
                 sprintf(
-                    '%s<br>%s',
-                    __( 'The REST API request failed due to an error.' ),
-                    sprintf(
-                        /* translators: 1: The WordPress error message. 2: The WordPress error code. */
-                        __( 'Error: %1$s (%2$s)' ),
-                        $r->get_error_message(),
-                        $r->get_error_code()
-                    )
+                    // translators: %s: The REST API URL.
+                    __( 'REST API Endpoint: %s' ),
+                    $url
+                ),
+                sprintf(
+                    // translators: 1: The WordPress error code. 2: The WordPress error message.
+                    __( 'REST API Response: (%1$s) %2$s' ),
+                    $r->get_error_code(),
+                    $r->get_error_message()
                 )
             );
@@ -2109 +2111 @@
 
             $result['description'] .= sprintf(
-                '<p>%s</p>',
+                '<p>%s</p><p>%s<br>%s</p>',
+                __( 'When testing the REST API, an unexpected result was returned:' ),
                 sprintf(
-                    /* translators: 1: The HTTP error code. 2: The HTTP error message. */
-                    __( 'The REST API call gave the following unexpected result: (%1$d) %2$s.' ),
+                    // translators: %s: The REST API URL.
+                    __( 'REST API Endpoint: %s' ),
+                    $url
+                ),
+                sprintf(
+                    // translators: 1: The WordPress error code. 2: The HTTP status code error message.
+                    __( 'REST API Response: (%1$s) %2$s' ),
                     wp_remote_retrieve_response_code( $r ),
-                    esc_html( wp_remote_retrieve_body( $r ) )
+                    wp_remote_retrieve_response_message( $r )
                 )
             );