Changeset 63378

Timestamp:

08/27/2026 10:33:18 PM (3 days ago)

Author:

westonruter

Message:

Code Quality: Add the documented return null; to 14 functions.

PHPStan reports return.missing where a documented return type obliges a function to return a value on every path, but one path falls off the end instead. Adding the return null; that the annotation already implies resolves the report without changing behavior, since PHP was returning null implicitly anyway. This is the shape r61716 used on get_category_by_path(), which replaced a bare return; in that same function; its remaining path is now handled too.

Covered here are get_category_by_path(), wp_list_users(), single_month_title(), WP_Customize_Manager::get_setting(), get_panel(), get_section() and get_control(), WP_Customize_Widgets::get_setting_type(), WP_Customize_Header_Image_Control::get_current_image_src(), WP_Image_Editor_Imagick::set_imagick_time_limit(), and the four pagination helpers in link-template.php.

Every change is a pure append, leaving the diff additive at 30 insertions and no deletions. Two further groups of return.missing fixes from the same pull request carry more risk and will follow separately.

The baseline tests/phpstan/baselines/return.missing.neon drops from 41 entries covering 44 errors to 27 covering 29, so the file and its entry in phpstan.neon.dist both remain for now.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/13082.
Follow-up to r61716, r63020.

Props dpantazis, dmsnell.
See #65817.

Location:

trunk

Files:

• src/wp-includes/category.php (modified) (1 diff)
• src/wp-includes/class-wp-customize-manager.php (modified) (4 diffs)
• src/wp-includes/class-wp-customize-widgets.php (modified) (1 diff)
• src/wp-includes/class-wp-image-editor-imagick.php (modified) (1 diff)
• src/wp-includes/customize/class-wp-customize-header-image-control.php (modified) (1 diff)
• src/wp-includes/general-template.php (modified) (1 diff)
• src/wp-includes/link-template.php (modified) (4 diffs)
• src/wp-includes/user.php (modified) (1 diff)
• tests/phpstan/baselines/return.missing.neon (modified) (3 diffs)

trunk/src/wp-includes/category.php

@@ -177 +177 @@
                 return $category;
         }
+
+        return null;
 }
 

trunk/src/wp-includes/class-wp-customize-manager.php

@@ -3876 +3876 @@
                         return $this->settings[ $id ];
                 }
+
+                return null;
         }
 
@@ -3928 +3930 @@
                         return $this->panels[ $id ];
                 }
+
+                return null;
         }
 
@@ -4024 +4028 @@
                         return $this->sections[ $id ];
                 }
+
+                return null;
         }
 
@@ -4103 +4109 @@
                         return $this->controls[ $id ];
                 }
+
+                return null;
         }
 

trunk/src/wp-includes/class-wp-customize-widgets.php

@@ -190 +190 @@
                         }
                 }
+
+                return null;
         }
 

trunk/src/wp-includes/class-wp-image-editor-imagick.php

@@ -532 +532 @@
                         return $limit;
                 }
+
+                return null;
         }
 

trunk/src/wp-includes/customize/class-wp-customize-header-image-control.php

@@ -202 +202 @@
                         return $src;
                 }
+
+                return null;
         }
 

trunk/src/wp-includes/general-template.php

@@ -1897 +1897 @@
                 return $result;
         }
+
         echo $result;
+
+        return null;
 }
 

trunk/src/wp-includes/link-template.php

@@ -2531 +2531 @@
                 }
         }
+
+        return null;
 }
 
@@ -2599 +2601 @@
                 );
         }
+
+        return null;
 }
 
@@ -2638 +2642 @@
                 return get_pagenum_link( $previous_page );
         }
+
+        return null;
 }
 
@@ -2693 +2699 @@
                 );
         }
+
+        return null;
 }
 

trunk/src/wp-includes/user.php

@@ -1014 +1014 @@
                 return $return;
         }
+
         echo $return;
+
+        return null;
 }
 

trunk/tests/phpstan/baselines/return.missing.neon

@@ -30 +30 @@
                         path: ../../../src/wp-content/themes/twentyfourteen/inc/widgets.php
                 -
-                        message: '#^Function get_category_by_path\(\) should return array\|WP_Error\|WP_Term\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/category.php
-                -
-                        message: '#^Method WP_Customize_Manager\:\:get_control\(\) should return WP_Customize_Control\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/class-wp-customize-manager.php
-                -
-                        message: '#^Method WP_Customize_Manager\:\:get_panel\(\) should return WP_Customize_Panel\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/class-wp-customize-manager.php
-                -
-                        message: '#^Method WP_Customize_Manager\:\:get_section\(\) should return WP_Customize_Section\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/class-wp-customize-manager.php
-                -
-                        message: '#^Method WP_Customize_Manager\:\:get_setting\(\) should return WP_Customize_Setting\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/class-wp-customize-manager.php
-                -
-                        message: '#^Method WP_Customize_Widgets\:\:get_setting_type\(\) should return string\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/class-wp-customize-widgets.php
-                -
-                        message: '#^Method WP_Image_Editor_Imagick\:\:set_imagick_time_limit\(\) should return int\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/class-wp-image-editor-imagick.php
-                -
-                        message: '#^Method WP_Customize_Header_Image_Control\:\:get_current_image_src\(\) should return string\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/customize/class-wp-customize-header-image-control.php
-                -
                         message: '#^Function post_type_archive_title\(\) should return string\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/general-template.php
-                -
-                        message: '#^Function single_month_title\(\) should return string\|false\|null but return statement is missing\.$#'
                         identifier: return.missing
                         count: 1
@@ -110 +65 @@
                         path: ../../../src/wp-includes/link-template.php
                 -
-                        message: '#^Function get_next_posts_link\(\) should return string\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/link-template.php
-                -
-                        message: '#^Function get_next_posts_page_link\(\) should return string\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 2
-                        path: ../../../src/wp-includes/link-template.php
-                -
-                        message: '#^Function get_previous_posts_link\(\) should return string\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/link-template.php
-                -
-                        message: '#^Function get_previous_posts_page_link\(\) should return string\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/link-template.php
-                -
                         message: '#^Function next_posts\(\) should return string\|null but return statement is missing\.$#'
                         identifier: return.missing
@@ -139 +74 @@
                         count: 1
                         path: ../../../src/wp-includes/link-template.php
-                -
-                        message: '#^Function wp_list_users\(\) should return string\|null but return statement is missing\.$#'
-                        identifier: return.missing
-                        count: 1
-                        path: ../../../src/wp-includes/user.php
                 -
                         message: '#^Method WP_Nav_Menu_Widget\:\:form\(\) should return string\|null but return statement is missing\.$#'