Changeset 46269

Timestamp:

09/23/2019 08:03:15 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Site Health: Introduce site_status_test_result filter for the output of a finished Site Health test.

Props Clorith.
Fixes #47864.

Location:

trunk/src

Files:

• js/_enqueues/admin/site-health.js (modified) (1 diff)
• wp-admin/includes/class-wp-site-health.php (modified) (2 diffs)

trunk/src/js/_enqueues/admin/site-health.js

@@ -180 +180 @@
                     data,
                     function( response ) {
-                        AppendIssue( response.data );
+                        /** This filter is documented in wp-admin/includes/class-wp-site-health.php */
+                        AppendIssue( wp.hooks.applyFilters( 'site_status_test_result', response.data ) );
                         maybeRunNextAsyncTest();
                     }

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

@@ -97 +97 @@
 
                     if ( method_exists( $this, $test_function ) && is_callable( array( $this, $test_function ) ) ) {
-                        $health_check_js_variables['site_status']['direct'][] = call_user_func( array( $this, $test_function ) );
+                        /**
+                         * Filter the output of a finished Site Health test.
+                         *
+                         * @since 5.3.0
+                         *
+                         * @param array $test_result {
+                         *     An associated array of test result data.
+                         *
+                         *     @param string $label  A label describing the test, and is used as a header in the output.
+                         *     @param string $status The status of the test, which can be a value of `good`, `recommended` or `critical`.
+                         *     @param array  $badge {
+                         *         Tests are put into categories which have an associated badge shown, these can be modified and assigned here.
+                         *
+                         *         @param string $label The test label, for example `Performance`.
+                         *         @param string $color Default `blue`. A string representing a color to use for the label.
+                         *     }
+                         *     @param string $description A more descriptive explanation of what the test looks for, and why it is important for the end user.
+                         *     @param string $actions     An action to direct the user to where they can resolve the issue, if one exists.
+                         *     @param string $test        The name of the test being ran, used as a reference point.
+                         * }
+                         */
+                        $health_check_js_variables['site_status']['direct'][] = apply_filters( 'site_status_test_result', call_user_func( array( $this, $test_function ) ) );
                         continue;
                     }
@@ -103 +124 @@
 
                 if ( is_callable( $test['test'] ) ) {
-                    $health_check_js_variables['site_status']['direct'][] = call_user_func( $test['test'] );
+                    /** This filter is documented in wp-admin/includes/class-wp-site-health.php */
+                    $health_check_js_variables['site_status']['direct'][] = apply_filters( 'site_status_test_result', call_user_func( $test['test'] ) );
                 }
             }