Docs: Various docblock fixes in Site Health related files, as per documentation standards.

This addresses some files modified in changeset [54113].

See #55646.


git-svn-id: https://develop.svn.wordpress.org/trunk@54114 602fd350-edb4-49c9-b593-d223f7449a82

Author: audrasjb

src/wp-admin/includes/class-wp-debug-data.php

@@ -1394,7 +1394,7 @@ public static function debug_data() {
 		}
 
 		/**
-		 * Add to or modify the debug information shown on the Tools -> Site Health -> Info screen.
+		 * Filters the debug information shown on the Tools -> Site Health -> Info screen.
 		 *
 		 * Plugin or themes may wish to introduce their own debug information without creating
 		 * additional admin pages. They can utilize this filter to introduce their own sections
@@ -1484,7 +1484,7 @@ public static function get_mysql_var( $mysql_var ) {
 	}
 
 	/**
-	 * Format the information gathered for debugging, in a manner suitable for copying to a forum or support ticket.
+	 * Formats the information gathered for debugging, in a manner suitable for copying to a forum or support ticket.
 	 *
 	 * @since 5.2.0
 	 *
@@ -1553,7 +1553,7 @@ public static function format( $info_array, $data_type ) {
 	}
 
 	/**
-	 * Fetch the total size of all the database tables for the active database user.
+	 * Fetches the total size of all the database tables for the active database user.
 	 *
 	 * @since 5.2.0
 	 *
@@ -1574,7 +1574,7 @@ public static function get_database_size() {
 	}
 
 	/**
-	 * Fetch the sizes of the WordPress directories: `wordpress` (ABSPATH), `plugins`, `themes`, and `uploads`.
+	 * Fetches the sizes of the WordPress directories: `wordpress` (ABSPATH), `plugins`, `themes`, and `uploads`.
 	 * Intended to supplement the array returned by `WP_Debug_Data::debug_data()`.
 	 *
 	 * @since 5.2.0

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

@@ -56,7 +56,7 @@ public function __construct() {
 	}
 
 	/**
-	 * Output the content of a tab in the Site Health screen.
+	 * Outputs the content of a tab in the Site Health screen.
 	 *
 	 * @since 5.8.0
 	 *
@@ -69,7 +69,7 @@ public function show_site_health_tab( $tab ) {
 	}
 
 	/**
-	 * Return an instance of the WP_Site_Health class, or create one if none exist yet.
+	 * Returns an instance of the WP_Site_Health class, or create one if none exist yet.
 	 *
 	 * @since 5.4.0
 	 *
@@ -161,7 +161,7 @@ public function enqueue_scripts() {
 	}
 
 	/**
-	 * Run a Site Health test directly.
+	 * Runs a Site Health test directly.
 	 *
 	 * @since 5.4.0
 	 *
@@ -194,7 +194,7 @@ private function perform_test( $callback ) {
 	}
 
 	/**
-	 * Run the SQL version checks.
+	 * Runs the SQL version checks.
 	 *
 	 * These values are used in later tests, but the part of preparing them is more easily managed
 	 * early in the class for ease of access and discovery.
@@ -220,7 +220,7 @@ private function prepare_sql_data() {
 	}
 
 	/**
-	 * Test if `wp_version_check` is blocked.
+	 * Tests whether `wp_version_check` is blocked.
 	 *
 	 * It's possible to block updates with the `wp_version_check` filter, but this can't be checked
 	 * during an Ajax call, as the filter is never introduced then.
@@ -342,7 +342,7 @@ public function get_test_wordpress_version() {
 	}
 
 	/**
-	 * Test if plugins are outdated, or unnecessary.
+	 * Tests if plugins are outdated, or unnecessary.
 	 *
 	 * The test checks if your plugins are up to date, and encourages you to remove any
 	 * that are not in use.
@@ -475,7 +475,7 @@ public function get_test_plugin_version() {
 	}
 
 	/**
-	 * Test if themes are outdated, or unnecessary.
+	 * Tests if themes are outdated, or unnecessary.
 	 *
 	 * Сhecks if your site has a default theme (to fall back on if there is a need),
 	 * if your themes are up to date and, finally, encourages you to remove any themes
@@ -716,7 +716,7 @@ public function get_test_theme_version() {
 	}
 
 	/**
-	 * Test if the supplied PHP version is supported.
+	 * Tests if the supplied PHP version is supported.
 	 *
 	 * @since 5.2.0
 	 *
@@ -796,7 +796,7 @@ public function get_test_php_version() {
 	}
 
 	/**
-	 * Check if the passed extension or function are available.
+	 * Checks if the passed extension or function are available.
 	 *
 	 * Make the check for available PHP modules into a simple boolean operator for a cleaner test runner.
 	 *
@@ -835,7 +835,7 @@ private function test_php_extension_availability( $extension_name = null, $funct
 	}
 
 	/**
-	 * Test if required PHP modules are installed on the host.
+	 * Tests if required PHP modules are installed on the host.
 	 *
 	 * This test builds on the recommendations made by the WordPress Hosting Team
 	 * as seen at https://make.wordpress.org/hosting/handbook/handbook/server-environment/#php-extensions
@@ -970,7 +970,7 @@ public function get_test_php_extensions() {
 		);
 
 		/**
-		 * An array representing all the modules we wish to test for.
+		 * Filters the array representing all the modules we wish to test for.
 		 *
 		 * @since 5.2.0
 		 * @since 5.3.0 The `$constant` and `$class` parameters were added.
@@ -1074,7 +1074,7 @@ public function get_test_php_extensions() {
 	}
 
 	/**
-	 * Test if the PHP default timezone is set to UTC.
+	 * Tests if the PHP default timezone is set to UTC.
 	 *
 	 * @since 5.3.1
 	 *
@@ -1115,7 +1115,7 @@ public function get_test_php_default_timezone() {
 	}
 
 	/**
-	 * Test if there's an active PHP session that can affect loopback requests.
+	 * Tests if there's an active PHP session that can affect loopback requests.
 	 *
 	 * @since 5.5.0
 	 *
@@ -1161,7 +1161,7 @@ public function get_test_php_sessions() {
 	}
 
 	/**
-	 * Test if the SQL server is up to date.
+	 * Tests if the SQL server is up to date.
 	 *
 	 * @since 5.2.0
 	 *
@@ -1250,7 +1250,7 @@ public function get_test_sql_server() {
 	}
 
 	/**
-	 * Test if the database server is capable of using utf8mb4.
+	 * Tests if the database server is capable of using utf8mb4.
 	 *
 	 * @since 5.2.0
 	 *
@@ -1371,7 +1371,7 @@ public function get_test_utf8mb4_support() {
 	}
 
 	/**
-	 * Test if the site can communicate with WordPress.org.
+	 * Tests if the site can communicate with WordPress.org.
 	 *
 	 * @since 5.2.0
 	 *
@@ -1434,7 +1434,7 @@ public function get_test_dotorg_communication() {
 	}
 
 	/**
-	 * Test if debug information is enabled.
+	 * Tests if debug information is enabled.
 	 *
 	 * When WP_DEBUG is enabled, errors and information may be disclosed to site visitors,
 	 * or logged to a publicly accessible file.
@@ -1511,7 +1511,7 @@ public function get_test_is_in_debug_mode() {
 	}
 
 	/**
-	 * Test if your site is serving content over HTTPS.
+	 * Tests if the site is serving content over HTTPS.
 	 *
 	 * Many sites have varying degrees of HTTPS support, the most common of which is sites that have it
 	 * enabled, but only if you visit the right site address.
@@ -1660,7 +1660,7 @@ public function get_test_https_status() {
 	}
 
 	/**
-	 * Check if the HTTP API can handle SSL/TLS requests.
+	 * Checks if the HTTP API can handle SSL/TLS requests.
 	 *
 	 * @since 5.2.0
 	 *
@@ -1703,7 +1703,7 @@ public function get_test_ssl_support() {
 	}
 
 	/**
-	 * Test if scheduled events run as intended.
+	 * Tests if scheduled events run as intended.
 	 *
 	 * If scheduled events are not running, this may indicate something with WP_Cron is not working
 	 * as intended, or that there are orphaned events hanging around from older code.
@@ -1775,7 +1775,7 @@ public function get_test_scheduled_events() {
 	}
 
 	/**
-	 * Test if WordPress can run automated background updates.
+	 * Tests if WordPress can run automated background updates.
 	 *
 	 * Background updates in WordPress are primarily used for minor releases and security updates.
 	 * It's important to either have these working, or be aware that they are intentionally disabled
@@ -1849,7 +1849,7 @@ public function get_test_background_updates() {
 	}
 
 	/**
-	 * Test if plugin and theme auto-updates appear to be configured correctly.
+	 * Tests if plugin and theme auto-updates appear to be configured correctly.
 	 *
 	 * @since 5.5.0
 	 *
@@ -1888,7 +1888,7 @@ public function get_test_plugin_theme_auto_updates() {
 	}
 
 	/**
-	 * Test if loopbacks work as expected.
+	 * Tests if loopbacks work as expected.
 	 *
 	 * A loopback is when WordPress queries itself, for example to start a new WP_Cron instance,
 	 * or when editing a plugin or theme. This has shown itself to be a recurring issue,
@@ -1931,7 +1931,7 @@ public function get_test_loopback_requests() {
 	}
 
 	/**
-	 * Test if HTTP requests are blocked.
+	 * Tests if HTTP requests are blocked.
 	 *
 	 * It's possible to block all outgoing communication (with the possibility of allowing certain
 	 * hosts) via the HTTP API. This may create problems for users as many features are running as
@@ -2003,7 +2003,7 @@ public function get_test_http_requests() {
 	}
 
 	/**
-	 * Test if the REST API is accessible.
+	 * Tests if the REST API is accessible.
 	 *
 	 * Various security measures may block the REST API from working, or it may have been disabled in general.
 	 * This is required for the new block editor to work, so we explicitly test for this.
@@ -2109,7 +2109,7 @@ public function get_test_rest_availability() {
 	}
 
 	/**
-	 * Test if 'file_uploads' directive in PHP.ini is turned off.
+	 * Tests if 'file_uploads' directive in PHP.ini is turned off.
 	 *
 	 * @since 5.5.0
 	 *
@@ -2468,7 +2468,7 @@ public function get_test_persistent_object_cache() {
 	}
 
 	/**
-	 * Return a set of tests that belong to the site status page.
+	 * Returns a set of tests that belong to the site status page.
 	 *
 	 * Each site status test is defined here, they may be `direct` tests, that run on page load, or `async` tests
 	 * which will run later down the line via JavaScript calls to improve page performance and hopefully also user
@@ -2603,7 +2603,7 @@ public static function get_tests() {
 		}
 
 		/**
-		 * Add or modify which site status tests are run on a site.
+		 * Filters which site status tests are run on a site.
 		 *
 		 * The site health is determined by a set of tests based on best practices from
 		 * both the WordPress Hosting Team and web standards in general.
@@ -2669,7 +2669,7 @@ public static function get_tests() {
 	}
 
 	/**
-	 * Add a class to the body HTML tag.
+	 * Adds a class to the body HTML tag.
 	 *
 	 * Filters the body class string for admin pages and adds our own class for easier styling.
 	 *
@@ -2690,7 +2690,7 @@ public function admin_body_class( $body_class ) {
 	}
 
 	/**
-	 * Initiate the WP_Cron schedule test cases.
+	 * Initiates the WP_Cron schedule test cases.
 	 *
 	 * @since 5.2.0
 	 */
@@ -2700,7 +2700,7 @@ private function wp_schedule_test_init() {
 	}
 
 	/**
-	 * Populate our list of cron events and store them to a class-wide variable.
+	 * Populates the list of cron events and store them to a class-wide variable.
 	 *
 	 * @since 5.2.0
 	 */
@@ -2733,7 +2733,7 @@ private function get_cron_tasks() {
 	}
 
 	/**
-	 * Check if any scheduled tasks have been missed.
+	 * Checks if any scheduled tasks have been missed.
 	 *
 	 * Returns a boolean value of `true` if a scheduled task has been missed and ends processing.
 	 *
@@ -2759,7 +2759,7 @@ public function has_missed_cron() {
 	}
 
 	/**
-	 * Check if any scheduled tasks are late.
+	 * Checks if any scheduled tasks are late.
 	 *
 	 * Returns a boolean value of `true` if a scheduled task is late and ends processing.
 	 *
@@ -2789,7 +2789,7 @@ public function has_late_cron() {
 	}
 
 	/**
-	 * Check for potential issues with plugin and theme auto-updates.
+	 * Checks for potential issues with plugin and theme auto-updates.
 	 *
 	 * Though there is no way to 100% determine if plugin and theme auto-updates are configured
 	 * correctly, a few educated guesses could be made to flag any conditions that would
@@ -2873,7 +2873,7 @@ public function detect_plugin_theme_auto_update_issues() {
 	}
 
 	/**
-	 * Run a loopback test on our site.
+	 * Runs a loopback test on the site.
 	 *
 	 * Loopbacks are what WordPress uses to communicate with itself to start up WP_Cron, scheduled posts,
 	 * make sure plugin or theme edits don't cause site failures and similar.
@@ -2945,7 +2945,7 @@ public function can_perform_loopback() {
 	}
 
 	/**
-	 * Create a weekly cron event, if one does not already exist.
+	 * Creates a weekly cron event, if one does not already exist.
 	 *
 	 * @since 5.4.0
 	 */
@@ -2956,7 +2956,7 @@ public function maybe_create_scheduled_event() {
 	}
 
 	/**
-	 * Run our scheduled event to check and update the latest site health status for the website.
+	 * Runs the scheduled event to check and update the latest site health status for the website.
 	 *
 	 * @since 5.4.0
 	 */
@@ -3203,7 +3203,7 @@ private function check_for_page_caching() {
 	}
 
 	/**
-	 * Get page cache details.
+	 * Gets page cache details.
 	 *
 	 * @since 6.1.0
 	 *
@@ -3252,7 +3252,7 @@ private function get_page_cache_detail() {
 	}
 
 	/**
-	 * Get the threshold below which a response time is considered good.
+	 * Gets the threshold below which a response time is considered good.
 	 *
 	 * @since 6.1.0
 	 *