Make WordPress Core

Changeset 54114


Ignore:
Timestamp:
09/09/2022 08:45:07 AM (4 years ago)
Author:
audrasjb
Message:

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

This addresses some files modified in changeset [54113].

See #55646.

Location:
trunk/src/wp-admin/includes
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/class-wp-debug-data.php

    r54113 r54114  
    13951395
    13961396                /**
    1397                  * Add to or modify the debug information shown on the Tools -> Site Health -> Info screen.
     1397                 * Filters the debug information shown on the Tools -> Site Health -> Info screen.
    13981398                 *
    13991399                 * Plugin or themes may wish to introduce their own debug information without creating
    … …  
    14851485
    14861486        /**
    1487          * Format the information gathered for debugging, in a manner suitable for copying to a forum or support ticket.
     1487         * Formats the information gathered for debugging, in a manner suitable for copying to a forum or support ticket.
    14881488         *
    14891489         * @since 5.2.0
    … …  
    15541554
    15551555        /**
    1556          * Fetch the total size of all the database tables for the active database user.
     1556         * Fetches the total size of all the database tables for the active database user.
    15571557         *
    15581558         * @since 5.2.0
    … …  
    15751575
    15761576        /**
    1577          * Fetch the sizes of the WordPress directories: `wordpress` (ABSPATH), `plugins`, `themes`, and `uploads`.
     1577         * Fetches the sizes of the WordPress directories: `wordpress` (ABSPATH), `plugins`, `themes`, and `uploads`.
    15781578         * Intended to supplement the array returned by `WP_Debug_Data::debug_data()`.
    15791579         *
  • trunk/src/wp-admin/includes/class-wp-site-health.php

    r54113 r54114  
    5757
    5858        /**
    59          * Output the content of a tab in the Site Health screen.
     59         * Outputs the content of a tab in the Site Health screen.
    6060         *
    6161         * @since 5.8.0
    … …  
    7070
    7171        /**
    72          * Return an instance of the WP_Site_Health class, or create one if none exist yet.
     72         * Returns an instance of the WP_Site_Health class, or create one if none exist yet.
    7373         *
    7474         * @since 5.4.0
    … …  
    162162
    163163        /**
    164          * Run a Site Health test directly.
     164         * Runs a Site Health test directly.
    165165         *
    166166         * @since 5.4.0
    … …  
    195195
    196196        /**
    197          * Run the SQL version checks.
     197         * Runs the SQL version checks.
    198198         *
    199199         * These values are used in later tests, but the part of preparing them is more easily managed
    … …  
    221221
    222222        /**
    223          * Test if `wp_version_check` is blocked.
     223         * Tests whether `wp_version_check` is blocked.
    224224         *
    225225         * It's possible to block updates with the `wp_version_check` filter, but this can't be checked
    … …  
    343343
    344344        /**
    345          * Test if plugins are outdated, or unnecessary.
     345         * Tests if plugins are outdated, or unnecessary.
    346346         *
    347347         * The test checks if your plugins are up to date, and encourages you to remove any
    … …  
    476476
    477477        /**
    478          * Test if themes are outdated, or unnecessary.
     478         * Tests if themes are outdated, or unnecessary.
    479479         *
    480480         * Сhecks if your site has a default theme (to fall back on if there is a need),
    … …  
    717717
    718718        /**
    719          * Test if the supplied PHP version is supported.
     719         * Tests if the supplied PHP version is supported.
    720720         *
    721721         * @since 5.2.0
    … …  
    797797
    798798        /**
    799          * Check if the passed extension or function are available.
     799         * Checks if the passed extension or function are available.
    800800         *
    801801         * Make the check for available PHP modules into a simple boolean operator for a cleaner test runner.
    … …  
    836836
    837837        /**
    838          * Test if required PHP modules are installed on the host.
     838         * Tests if required PHP modules are installed on the host.
    839839         *
    840840         * This test builds on the recommendations made by the WordPress Hosting Team
    … …  
    971971
    972972                /**
    973                  * An array representing all the modules we wish to test for.
     973                 * Filters the array representing all the modules we wish to test for.
    974974                 *
    975975                 * @since 5.2.0
    … …  
    10751075
    10761076        /**
    1077          * Test if the PHP default timezone is set to UTC.
     1077         * Tests if the PHP default timezone is set to UTC.
    10781078         *
    10791079         * @since 5.3.1
    … …  
    11161116
    11171117        /**
    1118          * Test if there's an active PHP session that can affect loopback requests.
     1118         * Tests if there's an active PHP session that can affect loopback requests.
    11191119         *
    11201120         * @since 5.5.0
    … …  
    11621162
    11631163        /**
    1164          * Test if the SQL server is up to date.
     1164         * Tests if the SQL server is up to date.
    11651165         *
    11661166         * @since 5.2.0
    … …  
    12511251
    12521252        /**
    1253          * Test if the database server is capable of using utf8mb4.
     1253         * Tests if the database server is capable of using utf8mb4.
    12541254         *
    12551255         * @since 5.2.0
    … …  
    13721372
    13731373        /**
    1374          * Test if the site can communicate with WordPress.org.
     1374         * Tests if the site can communicate with WordPress.org.
    13751375         *
    13761376         * @since 5.2.0
    … …  
    14351435
    14361436        /**
    1437          * Test if debug information is enabled.
     1437         * Tests if debug information is enabled.
    14381438         *
    14391439         * When WP_DEBUG is enabled, errors and information may be disclosed to site visitors,
    … …  
    15121512
    15131513        /**
    1514          * Test if your site is serving content over HTTPS.
     1514         * Tests if the site is serving content over HTTPS.
    15151515         *
    15161516         * Many sites have varying degrees of HTTPS support, the most common of which is sites that have it
    … …  
    16611661
    16621662        /**
    1663          * Check if the HTTP API can handle SSL/TLS requests.
     1663         * Checks if the HTTP API can handle SSL/TLS requests.
    16641664         *
    16651665         * @since 5.2.0
    … …  
    17041704
    17051705        /**
    1706          * Test if scheduled events run as intended.
     1706         * Tests if scheduled events run as intended.
    17071707         *
    17081708         * If scheduled events are not running, this may indicate something with WP_Cron is not working
    … …  
    17761776
    17771777        /**
    1778          * Test if WordPress can run automated background updates.
     1778         * Tests if WordPress can run automated background updates.
    17791779         *
    17801780         * Background updates in WordPress are primarily used for minor releases and security updates.
    … …  
    18501850
    18511851        /**
    1852          * Test if plugin and theme auto-updates appear to be configured correctly.
     1852         * Tests if plugin and theme auto-updates appear to be configured correctly.
    18531853         *
    18541854         * @since 5.5.0
    … …  
    18891889
    18901890        /**
    1891          * Test if loopbacks work as expected.
     1891         * Tests if loopbacks work as expected.
    18921892         *
    18931893         * A loopback is when WordPress queries itself, for example to start a new WP_Cron instance,
    … …  
    19321932
    19331933        /**
    1934          * Test if HTTP requests are blocked.
     1934         * Tests if HTTP requests are blocked.
    19351935         *
    19361936         * It's possible to block all outgoing communication (with the possibility of allowing certain
    … …  
    20042004
    20052005        /**
    2006          * Test if the REST API is accessible.
     2006         * Tests if the REST API is accessible.
    20072007         *
    20082008         * Various security measures may block the REST API from working, or it may have been disabled in general.
    … …  
    21102110
    21112111        /**
    2112          * Test if 'file_uploads' directive in PHP.ini is turned off.
     2112         * Tests if 'file_uploads' directive in PHP.ini is turned off.
    21132113         *
    21142114         * @since 5.5.0
    … …  
    24692469
    24702470        /**
    2471          * Return a set of tests that belong to the site status page.
     2471         * Returns a set of tests that belong to the site status page.
    24722472         *
    24732473         * Each site status test is defined here, they may be `direct` tests, that run on page load, or `async` tests
    … …  
    26042604
    26052605                /**
    2606                  * Add or modify which site status tests are run on a site.
     2606                 * Filters which site status tests are run on a site.
    26072607                 *
    26082608                 * The site health is determined by a set of tests based on best practices from
    … …  
    26702670
    26712671        /**
    2672          * Add a class to the body HTML tag.
     2672         * Adds a class to the body HTML tag.
    26732673         *
    26742674         * Filters the body class string for admin pages and adds our own class for easier styling.
    … …  
    26912691
    26922692        /**
    2693          * Initiate the WP_Cron schedule test cases.
     2693         * Initiates the WP_Cron schedule test cases.
    26942694         *
    26952695         * @since 5.2.0
    … …  
    27012701
    27022702        /**
    2703          * Populate our list of cron events and store them to a class-wide variable.
     2703         * Populates the list of cron events and store them to a class-wide variable.
    27042704         *
    27052705         * @since 5.2.0
    … …  
    27342734
    27352735        /**
    2736          * Check if any scheduled tasks have been missed.
     2736         * Checks if any scheduled tasks have been missed.
    27372737         *
    27382738         * Returns a boolean value of `true` if a scheduled task has been missed and ends processing.
    … …  
    27602760
    27612761        /**
    2762          * Check if any scheduled tasks are late.
     2762         * Checks if any scheduled tasks are late.
    27632763         *
    27642764         * Returns a boolean value of `true` if a scheduled task is late and ends processing.
    … …  
    27902790
    27912791        /**
    2792          * Check for potential issues with plugin and theme auto-updates.
     2792         * Checks for potential issues with plugin and theme auto-updates.
    27932793         *
    27942794         * Though there is no way to 100% determine if plugin and theme auto-updates are configured
    … …  
    28742874
    28752875        /**
    2876          * Run a loopback test on our site.
     2876         * Runs a loopback test on the site.
    28772877         *
    28782878         * Loopbacks are what WordPress uses to communicate with itself to start up WP_Cron, scheduled posts,
    … …  
    29462946
    29472947        /**
    2948          * Create a weekly cron event, if one does not already exist.
     2948         * Creates a weekly cron event, if one does not already exist.
    29492949         *
    29502950         * @since 5.4.0
    … …  
    29572957
    29582958        /**
    2959          * Run our scheduled event to check and update the latest site health status for the website.
     2959         * Runs the scheduled event to check and update the latest site health status for the website.
    29602960         *
    29612961         * @since 5.4.0
    … …  
    32043204
    32053205        /**
    3206          * Get page cache details.
     3206         * Gets page cache details.
    32073207         *
    32083208         * @since 6.1.0
    … …  
    32533253
    32543254        /**
    3255          * Get the threshold below which a response time is considered good.
     3255         * Gets the threshold below which a response time is considered good.
    32563256         *
    32573257         * @since 6.1.0
Note: See TracChangeset for help on using the changeset viewer.