Changeset 62178 for trunk/src/wp-includes/canonical.php

Timestamp:

03/30/2026 05:31:56 AM (2 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/canonical.php (modified) (7 diffs)

trunk/src/wp-includes/canonical.php

@@ -38 +38 @@
  *                              figure if redirect is needed.
  * @param bool   $do_redirect   Optional. Redirect to the new URL.
- * @return string|void The string of the URL, if redirect needed.
+ * @return string|null The string of the URL, if redirect needed. Never returns if a redirect occurs, depending on $do_redirect.
  */
 function redirect_canonical( $requested_url = null, $do_redirect = true ) {
@@ -44 +44 @@
 
     if ( isset( $_SERVER['REQUEST_METHOD'] ) && ! in_array( strtoupper( $_SERVER['REQUEST_METHOD'] ), array( 'GET', 'HEAD' ), true ) ) {
-        return;
+        return null;
     }
 
@@ -63 +63 @@
         || ( $is_IIS && ! iis7_supports_permalinks() )
     ) {
-        return;
+        return null;
     }
 
@@ -75 +75 @@
     $original = parse_url( $requested_url );
     if ( false === $original ) {
-        return;
+        return null;
     }
 
@@ -772 +772 @@
 
     if ( ! $redirect_url || $redirect_url === $requested_url ) {
-        return;
+        return null;
     }
 
@@ -831 +831 @@
     // Yes, again -- in case the filter aborted the request.
     if ( ! $redirect_url || strip_fragment_from_url( $redirect_url ) === strip_fragment_from_url( $requested_url ) ) {
-        return;
+        return null;
     }
 
@@ -842 +842 @@
             // Debug.
             // die("1: $redirect_url<br />2: " . redirect_canonical( $redirect_url, false ) );
-            return;
+            return null;
         }
     } else {