Make WordPress Core


Ignore:
Timestamp:
03/30/2026 05:31:56 AM (6 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-theme-json.php

    r61699 r62178  
    42684268         *                   of manually after instantiation.
    42694269         *
    4270          * @return null|void
     4270         * @return void
    42714271         */
    42724272        public function set_spacing_sizes() {
    … …  
    42974297                                );
    42984298                        }
    4299                         return null;
     4299                        return;
    43004300                }
    43014301
    43024302                // If theme authors want to prevent the generation of the core spacing scale they can set their theme.json spacingScale.steps to 0.
    43034303                if ( 0 === $spacing_scale['steps'] ) {
    4304                         return null;
     4304                        return;
    43054305                }
    43064306
Note: See TracChangeset for help on using the changeset viewer.