Changeset 59340

Timestamp:

11/04/2024 03:23:26 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Coding Standards: Use explicit returns in WP_Site_Health_Auto_Updates::test_*().

This commit corrects several instances of test_*() methods potentially returning void instead of their documented return types.

Since these methods are public, null is used to represent a passed test for backward compatibility with the coercion of the previously-returned void. Previous usage of false is preserved.

Includes updating some @return tags for clarity.

Follow-up to [44986], [46276], [49927].

Props justlevine, apermo, SergeyBiryukov.
See #52217.

File:

• trunk/src/wp-admin/includes/class-wp-site-health-auto-updates.php (modified) (13 diffs)

trunk/src/wp-admin/includes/class-wp-site-health-auto-updates.php

@@ -67 +67 @@
          * @param bool|string|array $value The value that the constant should be, if set,
          *                                 or an array of acceptable values.
-         * @return array The test results.
+         * @return array|null The test results if there are any constants set incorrectly,
+         *                    or null if the test passed.
          */
         public function test_constants( $constant, $value ) {
@@ -83 +84 @@
                         );
                 }
+
+                return null;
         }
 
@@ -90 +93 @@
          * @since 5.2.0
          *
-         * @return array The test results.
+         * @return array|null The test results if wp_version_check() is disabled,
+         *                    or null if the test passed.
          */
         public function test_wp_version_check_attached() {
@@ -105 +109 @@
                         );
                 }
+
+                return null;
         }
 
@@ -112 +118 @@
          * @since 5.2.0
          *
-         * @return array The test results.
+         * @return array|null The test results if the {@see 'automatic_updater_disabled'} filter is set,
+         *                    or null if the test passed.
          */
         public function test_filters_automatic_updater_disabled() {
@@ -126 +133 @@
                         );
                 }
+
+                return null;
         }
 
@@ -133 +142 @@
          * @since 5.3.0
          *
-         * @return array|false The test results. False if auto-updates are enabled.
+         * @return array|false The test results if auto-updates are disabled, false otherwise.
          */
         public function test_wp_automatic_updates_disabled() {
@@ -157 +166 @@
          * @since 5.2.0
          *
-         * @return array|false The test results. False if the auto-updates failed.
+         * @return array|false The test results if auto-updates previously failed, false otherwise.
          */
         public function test_if_failed_update() {
@@ -313 +322 @@
          * @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
          *
-         * @return array|false The test results. False if they're not writeable.
+         * @return array|false The test results if at least some of WordPress core files are writeable,
+         *                     or if a list of the checksums could not be retrieved from WordPress.org.
+         *                     False if the core files are not writeable.
          */
         public function test_all_files_writable() {
@@ -398 +409 @@
          * @since 5.2.0
          *
-         * @return array|false The test results. False if it isn't a development version.
+         * @return array|false|null The test results if development updates are blocked.
+         *                          False if it isn't a development version. Null if the test passed.
          */
         public function test_accepts_dev_updates() {
@@ -429 +441 @@
                         );
                 }
+
+                return null;
         }
 
@@ -436 +450 @@
          * @since 5.2.0
          *
-         * @return array The test results.
+         * @return array|null The test results if minor updates are blocked,
+         *                    or null if the test passed.
          */
         public function test_accepts_minor_updates() {
@@ -461 +476 @@
                         );
                 }
+
+                return null;
         }
 }