Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2025-02-08 16:41:44 +01:00
Code Issues Projects Releases Wiki Activity

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

Browse Source 
This addresses some files modified in changeset [54113].

See #55646.

Built from https://develop.svn.wordpress.org/trunk@54114


git-svn-id: http://core.svn.wordpress.org/trunk@53673 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2022-09-09 08:47:08 +00:00
parent c7fe0f88d2
commit 7c20a1d2d5
3 changed files with 44 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
wp-admin/includes/class-wp-debug-data.php
View File

@ -1394,7 +1394,7 @@ class WP_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 * 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 * additional admin pages. They can utilize this filter to introduce their own sections
@ -1484,7 +1484,7 @@ class WP_Debug_Data {
} }
/** /**
* 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 * @since 5.2.0
* *
@ -1553,7 +1553,7 @@ class WP_Debug_Data {
} }
/** /**
* 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 * @since 5.2.0
* *
@ -1574,7 +1574,7 @@ class WP_Debug_Data {
} }
/** /**
* 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()`. * Intended to supplement the array returned by `WP_Debug_Data::debug_data()`.
* *
* @since 5.2.0 * @since 5.2.0

78
wp-admin/includes/class-wp-site-health.php
View File

@ -56,7 +56,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * @since 5.8.0
* *
@ -69,7 +69,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * @since 5.4.0
* *
@ -161,7 +161,7 @@ class WP_Site_Health {
} }
/** /**
* Run a Site Health test directly. * Runs a Site Health test directly.
* *
* @since 5.4.0 * @since 5.4.0
* *
@ -194,7 +194,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * 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. * early in the class for ease of access and discovery.
@ -220,7 +220,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * 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. * during an Ajax call, as the filter is never introduced then.
@ -342,7 +342,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * The test checks if your plugins are up to date, and encourages you to remove any
* that are not in use. * that are not in use.
@ -475,7 +475,7 @@ class WP_Site_Health {
} }
/** /**
* 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), * С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 * if your themes are up to date and, finally, encourages you to remove any themes
@ -716,7 +716,7 @@ class WP_Site_Health {
} }
/** /**
* Test if the supplied PHP version is supported. * Tests if the supplied PHP version is supported.
* *
* @since 5.2.0 * @since 5.2.0
* *
@ -796,7 +796,7 @@ class WP_Site_Health {
} }
/** /**
* 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. * Make the check for available PHP modules into a simple boolean operator for a cleaner test runner.
* *
@ -835,7 +835,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * 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 * as seen at https://make.wordpress.org/hosting/handbook/handbook/server-environment/#php-extensions
@ -970,7 +970,7 @@ class WP_Site_Health {
); );
/** /**
* 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.2.0
* @since 5.3.0 The `$constant` and `$class` parameters were added. * @since 5.3.0 The `$constant` and `$class` parameters were added.
@ -1074,7 +1074,7 @@ class WP_Site_Health {
} }
/** /**
* Test if the PHP default timezone is set to UTC. * Tests if the PHP default timezone is set to UTC.
* *
* @since 5.3.1 * @since 5.3.1
* *
@ -1115,7 +1115,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * @since 5.5.0
* *
@ -1161,7 +1161,7 @@ class WP_Site_Health {
} }
/** /**
* Test if the SQL server is up to date. * Tests if the SQL server is up to date.
* *
* @since 5.2.0 * @since 5.2.0
* *
@ -1250,7 +1250,7 @@ class WP_Site_Health {
} }
/** /**
* Test if the database server is capable of using utf8mb4. * Tests if the database server is capable of using utf8mb4.
* *
* @since 5.2.0 * @since 5.2.0
* *
@ -1371,7 +1371,7 @@ class WP_Site_Health {
} }
/** /**
* Test if the site can communicate with WordPress.org. * Tests if the site can communicate with WordPress.org.
* *
* @since 5.2.0 * @since 5.2.0
* *
@ -1434,7 +1434,7 @@ class WP_Site_Health {
} }
/** /**
* 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, * When WP_DEBUG is enabled, errors and information may be disclosed to site visitors,
* or logged to a publicly accessible file. * or logged to a publicly accessible file.
@ -1511,7 +1511,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * 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. * enabled, but only if you visit the right site address.
@ -1660,7 +1660,7 @@ class WP_Site_Health {
} }
/** /**
* Check if the HTTP API can handle SSL/TLS requests. * Checks if the HTTP API can handle SSL/TLS requests.
* *
* @since 5.2.0 * @since 5.2.0
* *
@ -1703,7 +1703,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * 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. * as intended, or that there are orphaned events hanging around from older code.
@ -1775,7 +1775,7 @@ class WP_Site_Health {
} }
/** /**
* 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. * 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 * It's important to either have these working, or be aware that they are intentionally disabled
@ -1849,7 +1849,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * @since 5.5.0
* *
@ -1888,7 +1888,7 @@ class WP_Site_Health {
} }
/** /**
* 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, * 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, * or when editing a plugin or theme. This has shown itself to be a recurring issue,
@ -1931,7 +1931,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * 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 * hosts) via the HTTP API. This may create problems for users as many features are running as
@ -2003,7 +2003,7 @@ class WP_Site_Health {
} }
/** /**
* 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. * 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. * This is required for the new block editor to work, so we explicitly test for this.
@ -2109,7 +2109,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * @since 5.5.0
* *
@ -2468,7 +2468,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * 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 * which will run later down the line via JavaScript calls to improve page performance and hopefully also user
@ -2603,7 +2603,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * 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. * both the WordPress Hosting Team and web standards in general.
@ -2669,7 +2669,7 @@ class WP_Site_Health {
} }
/** /**
* 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. * Filters the body class string for admin pages and adds our own class for easier styling.
* *
@ -2690,7 +2690,7 @@ class WP_Site_Health {
} }
/** /**
* Initiate the WP_Cron schedule test cases. * Initiates the WP_Cron schedule test cases.
* *
* @since 5.2.0 * @since 5.2.0
*/ */
@ -2700,7 +2700,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * @since 5.2.0
*/ */
@ -2733,7 +2733,7 @@ class WP_Site_Health {
} }
/** /**
* 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. * Returns a boolean value of `true` if a scheduled task has been missed and ends processing.
* *
@ -2759,7 +2759,7 @@ class WP_Site_Health {
} }
/** /**
* 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. * Returns a boolean value of `true` if a scheduled task is late and ends processing.
* *
@ -2789,7 +2789,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * 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 * correctly, a few educated guesses could be made to flag any conditions that would
@ -2873,7 +2873,7 @@ class WP_Site_Health {
} }
/** /**
* 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, * 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. * make sure plugin or theme edits don't cause site failures and similar.
@ -2945,7 +2945,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * @since 5.4.0
*/ */
@ -2956,7 +2956,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * @since 5.4.0
*/ */
@ -3203,7 +3203,7 @@ class WP_Site_Health {
} }
/** /**
* Get page cache details. * Gets page cache details.
* *
* @since 6.1.0 * @since 6.1.0
* *
@ -3252,7 +3252,7 @@ class WP_Site_Health {
} }
/** /**
* 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 * @since 6.1.0
* *

2
wp-includes/version.php
View File

@ -16,7 +16,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '6.1-alpha-54113'; $wp_version = '6.1-alpha-54114';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.