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

Timestamp:

01/12/2020 01:31:49 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Site Health: Introduce Site Health Status dashboard widget.

The widget informs administrators of any potential issues that should be addressed to improve the performance or security of their website, and directs them to the Site Health screen for more details.

Props Clorith, hedgefield, guddu1315.
See #47606.

File:

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

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

@@ -9 +9 @@
 
 class WP_Site_Health {
+        private static $instance = null;
+
         private $mysql_min_version_check;
         private $mysql_rec_version_check;
@@ -30 +32 @@
          */
         public function __construct() {
+                $this->maybe_create_scheduled_event();
+
                 $this->prepare_sql_data();
 
@@ -43 +47 @@
 
                 add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
+                add_action( 'wp_site_health_scheduled_check', array( $this, 'wp_cron_scheduled_check' ) );
+        }
+
+        /**
+         * Return an instance of the WP_Site_Health class, or create one if none exist yet.
+         *
+         * @since 5.4.0
+         *
+         * @return WP_Site_Health|null
+         */
+        public static function initialize() {
+                if ( null === self::$instance ) {
+                        self::$instance = new WP_Site_Health();
+                }
+
+                return self::$instance;
         }
 
@@ -52 +72 @@
         public function enqueue_scripts() {
                 $screen = get_current_screen();
-                if ( 'site-health' !== $screen->id ) {
+                if ( 'site-health' !== $screen->id && 'dashboard' !== $screen->id ) {
                         return;
                 }
@@ -97 +117 @@
 
                                         if ( method_exists( $this, $test_function ) && is_callable( 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 ) ) );
+                                                $health_check_js_variables['site_status']['direct'][] = $this->perform_test( array( $this, $test_function ) );
                                                 continue;
                                         }
@@ -124 +123 @@
 
                                 if ( is_callable( $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'] ) );
+                                        $health_check_js_variables['site_status']['direct'][] = $this->perform_test( $test['test'] );
                                 }
                         }
@@ -140 +138 @@
 
                 wp_localize_script( 'site-health', 'SiteHealth', $health_check_js_variables );
+        }
+
+        /**
+         * Run a Site Health test directly.
+         *
+         * @since 5.4.0
+         *
+         * @param $callback
+         *
+         * @return mixed|void
+         */
+        private function perform_test( $callback ) {
+                /**
+                 * 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.
+                 * }
+                 */
+                return apply_filters( 'site_status_test_result', call_user_func( $callback ) );
         }
 
@@ -2006 +2038 @@
          */
         public function admin_body_class( $body_class ) {
+                $screen = get_current_screen();
+                if ( 'site-health' !== $screen->id ) {
+                        return $body_class;
+                }
+
                 $body_class .= ' site-health';
 
@@ -2168 +2205 @@
                 );
         }
+
+        /**
+         * Create a weekly cron event, if one does not already exist.
+         *
+         * @since 5.4.0
+         */
+        public function maybe_create_scheduled_event() {
+                if ( ! wp_next_scheduled( 'wp_site_health_scheduled_check' ) && ! wp_installing() ) {
+                        wp_schedule_event( time(), 'weekly', 'wp_site_health_scheduled_check' );
+                }
+        }
+
+        /**
+         * Run our scheduled event to check and update the latest site health status for the website.
+         *
+         * @since 5.4.0
+         */
+        public function wp_cron_scheduled_check() {
+                // Bootstrap wp-admin, as WP_Cron doesn't do this for us.
+                require_once( trailingslashit( ABSPATH ) . 'wp-admin/includes/admin.php' );
+
+                $tests = WP_Site_Health::get_tests();
+
+                $results = array();
+
+                $site_status = array(
+                        'good'        => 0,
+                        'recommended' => 0,
+                        'critical'    => 0,
+                );
+
+                // Don't run https test on localhost
+                if ( 'localhost' === preg_replace( '|https?://|', '', get_site_url() ) ) {
+                        unset( $tests['direct']['https_status'] );
+                }
+
+                foreach ( $tests['direct'] as $test ) {
+
+                        if ( is_string( $test['test'] ) ) {
+                                $test_function = sprintf(
+                                        'get_test_%s',
+                                        $test['test']
+                                );
+
+                                if ( method_exists( $this, $test_function ) && is_callable( array( $this, $test_function ) ) ) {
+                                        $results[] = $this->perform_test( array( $this, $test_function ) );
+                                        continue;
+                                }
+                        }
+
+                        if ( is_callable( $test['test'] ) ) {
+                                $results[] = $this->perform_test( $test['test'] );
+                        }
+                }
+
+                foreach ( $tests['async'] as $test ) {
+                        if ( is_string( $test['test'] ) ) {
+                                if ( isset( $test['has_rest'] ) && $test['has_rest'] ) {
+                                        $result_fetch = wp_remote_post(
+                                                rest_url( $test['test'] ),
+                                                array(
+                                                        'body' => array(
+                                                                '_wpnonce' => wp_create_nonce( 'wp_rest' ),
+                                                        ),
+                                                )
+                                        );
+                                } else {
+                                        $result_fetch = wp_remote_post(
+                                                admin_url( 'admin-ajax.php' ),
+                                                array(
+                                                        'body' => array(
+                                                                'action'   => $test['test'],
+                                                                '_wpnonce' => wp_create_nonce( 'health-check-site-status' ),
+                                                        ),
+                                                )
+                                        );
+                                }
+
+                                if ( ! is_wp_error( $result_fetch ) ) {
+                                        $results[] = json_decode( wp_remote_retrieve_body( $result_fetch ) );
+                                } else {
+                                        $results[] = array(
+                                                'status' => 'recommended',
+                                                'label'  => __( 'A test is unavailable' ),
+                                        );
+                                }
+                        }
+                }
+
+                foreach ( $results as $result ) {
+                        if ( 'critical' === $result['status'] ) {
+                                $site_status['critical']++;
+                        } elseif ( 'recommended' === $result['status'] ) {
+                                $site_status['recommended']++;
+                        } else {
+                                $site_status['good']++;
+                        }
+                }
+
+                set_transient( 'health-check-site-status-result', wp_json_encode( $site_status ) );
+        }
 }