Changeset 62178 for trunk/src/wp-includes/ms-functions.php

Timestamp:

03/30/2026 05:31:56 AM (5 months ago)

Author:

westonruter

Message:

Code Quality: Replace void with proper return types in union PHPDoc annotations.

In PHP's type system, void means a function does not return a value and cannot be part of a union type. Many functions in core were documented as returning e.g. string|void while actually returning null implicitly via bare return; statements. This replaces void with null in union return types, adds explicit return null; statements, and updates @return annotations across 22 files in wp-includes.

Additionally:

• Adds @return never for WP_Recovery_Mode::redirect_protected().
• Fixes WP_Theme_JSON::set_spacing_sizes() to use @return void instead of @return null|void.
• Removes void from return types where the function always returns a value or dies: remove_theme_support(), WP_Recovery_Mode::handle_error().
• Fixes wp_die() return type from never|void to void with clarified description.
• Initializes $primary variable in get_active_blog_for_user() to prevent a possible undefined variable notice.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/11012

Follow-up to r62177, r61766, r61719.

Props apermo, xateman, westonruter, parthvataliya, nimeshatxecurify.
See #64704.

File:

• trunk/src/wp-includes/ms-functions.php (modified) (5 diffs)

trunk/src/wp-includes/ms-functions.php

@@ -41 +41 @@
  *
  * @param int $user_id The unique ID of the user
- * @return WP_Site|void The blog object
+ * @return WP_Site|object|null|false The blog object
  */
 function get_active_blog_for_user( $user_id ) {
         $blogs = get_blogs_of_user( $user_id );
         if ( empty( $blogs ) ) {
-                return;
+                return null;
         }
 
@@ -53 +53 @@
         }
 
+        $primary      = null;
         $primary_blog = get_user_meta( $user_id, 'primary_blog', true );
         $first_blog   = current( $blogs );
@@ -101 +102 @@
                         }
                 } else {
-                        return;
+                        return null;
                 }
 
@@ -2270 +2271 @@
  *     @type string $role    The role to be assigned to the user.
  * }
- * @return true|WP_Error|void True on success or a WP_Error object if the user doesn't exist
- *                            or could not be added. Void if $details array was not provided.
+ * @return true|WP_Error|null True on success or a WP_Error object if the user doesn't exist
+ *                            or could not be added. Null if $details array was not provided.
  */
 function add_existing_user_to_blog( $details = false ) {
@@ -2291 +2292 @@
                 return $result;
         }
+        return null;
 }