Changeset 52053 for trunk/src/wp-admin/site-health.php

Timestamp:

11/08/2021 09:41:43 PM (3 years ago)

Author:

johnjamesjacoby

Message:

Admin/Help: add docs links to several screens.

This change intends to better guide users towards many of the useful resources available on WordPress.org.

• Appearance/Customizer - Add link to Customizer docs.
• Appearance/Editor - Improve link text & destination.
• Privacy Settings - Link to Privacy Settings docs.
• Site Health - Link to Site Health docs.

Props audrasjb, jdy68, webcommsat.

Fixes #54357.

File:

• trunk/src/wp-admin/site-health.php (modified) (1 diff)

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

@@ -74 +74 @@
 
 $health_check_site_status = WP_Site_Health::get_instance();
+
+get_current_screen()->add_help_tab(
+    array(
+        'id'      => 'overview',
+        'title'   => __( 'Overview' ),
+        'content' =>
+                '<p>' . __( 'This screen allows you to obtain a health diagnosis of your site, and displays an overall rating of the status of your installation.' ) . '</p>' .
+                '<p>' . __( 'In the Status tab, you can see critical information about your WordPress configuration, along with anything else that requires your attention.' ) . '</p>' .
+                '<p>' . __( 'In the Info tab, you will find all the details about the configuration of your WordPress site, server, and database. There is also an export feature that allows you to copy all of the information about your site to the clipboard, help solve problems on your site when obtaining support.' ) . '</p>'
+    )
+);
+
+get_current_screen()->set_help_sidebar(
+    '<p><strong>' . __( 'For more information:' ) . '</strong></p>' .
+    '<p>' . __( '<a href="https://wordpress.org/support/article/site-health-screen/">Documentation on Site Health tool</a>' ) . '</p>'
+);
 
 // Start by checking if this is a special request checking for the existence of certain filters.