Changeset 56144

Timestamp:

07/06/2023 12:14:34 AM (21 months ago)

Author:

SergeyBiryukov

Message:

Docs: Document the return value of wp_check_php_version() using hash notation.

Follow-up to [42832].

See #57840.

File:

• trunk/src/wp-admin/includes/misc.php (modified) (2 diffs)

trunk/src/wp-admin/includes/misc.php

@@ -1573 +1573 @@
  * @since 5.1.1 Added the {@see 'wp_is_php_version_acceptable'} filter.
  *
- * @return array|false Array of PHP version data. False on failure.
+ * @return array|false {
+ *     Array of PHP version data. False on failure.
+ *
+ *     @type string $recommended_version The PHP version recommended by WordPress.
+ *     @type string $minimum_version     The minimum required PHP version.
+ *     @type bool   $is_supported        Whether the PHP version is actively supported.
+ *     @type bool   $is_secure           Whether the PHP version receives security updates.
+ *     @type bool   $is_acceptable       Whether the PHP version is still acceptable or warnings
+ *                                       should be shown and an update recommended.
+ * }
  */
 function wp_check_php_version() {
@@ -1596 +1605 @@
         }
 
-        /**
-         * Response should be an array with:
-         *  'recommended_version' - string - The PHP version recommended by WordPress.
-         *  'is_supported' - boolean - Whether the PHP version is actively supported.
-         *  'is_secure' - boolean - Whether the PHP version receives security updates.
-         *  'is_acceptable' - boolean - Whether the PHP version is still acceptable or warnings
-         *                              should be shown and an update recommended.
-         */
         $response = json_decode( wp_remote_retrieve_body( $response ), true );