Changeset 63379

Timestamp:

08/27/2026 10:54:07 PM (6 weeks ago)

Author:

westonruter

Message:

Code Quality: Resolve the remaining return.missing PHPStan errors.

Nine template functions take a $display parameter and either echo their result or return it. Each is documented as returning string|null, but the echoing branch fell off the end without returning, which is what PHPStan reports as return.missing. Inverting the condition lets the value-returning path exit first and the echoing path fall through to an explicit return null;, the same shape single_month_title() received in r63378. Affected are wp_title(), single_post_title(), post_type_archive_title(), single_term_title(), the_date(), the_modified_date(), edit_term_link(), next_posts() and previous_posts(). No behavior changes.

WP_Widget::form() is documented as string|void again. r59336 added the void deliberately, noting that unlike its siblings it is the child classes which return nothing when the method is correctly implemented. r62178 replaced it with null on the premise that void cannot belong to a union, which holds for PHP's native return types but not for PHPDoc, where PHPStan reads void in a union as "may not return at all". Under string|null the annotation instead obliged every override to return, putting all 18 of them in breach, two of which live in bundled themes that r62178 did not touch.

With no occurrences left, tests/phpstan/baselines/return.missing.neon is deleted along with its entry in phpstan.neon.dist, completing the work begun in r63378.

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

Props dpantazis, dmsnell.
See #65817, #64704.

Location:

trunk

Files:

• phpstan.neon.dist (modified) (1 diff)
• src/wp-includes/class-wp-widget.php (modified) (1 diff)
• src/wp-includes/general-template.php (modified) (6 diffs)
• src/wp-includes/link-template.php (modified) (3 diffs)
• tests/phpstan/baselines/return.missing.neon (deleted)

trunk/phpstan.neon.dist

@@ -77 +77 @@
         - tests/phpstan/baselines/property.private.neon
         - tests/phpstan/baselines/property.protected.neon
-        - tests/phpstan/baselines/return.missing.neon
         - tests/phpstan/baselines/return.type.neon
         - tests/phpstan/baselines/return.unusedType.neon

trunk/src/wp-includes/class-wp-widget.php

@@ -139 +139 @@
          *
          * @param array $instance The settings for the particular instance of the widget.
-         * @return string|null Default return is 'noform'. A subclass may opt to return null.
+         * @return string|void Default return is 'noform'. A subclass which echoes its own
+         *                     form returns nothing.
          */
         public function form( $instance ) {

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

@@ -1674 +1674 @@
 
         // Send it out.
-        if ( $display ) {
-                echo $title;
-        } else {
+        if ( ! $display ) {
                 return $title;
         }
+
+        echo $title;
+
+        return null;
 }
 
@@ -1713 +1715 @@
          */
         $title = apply_filters( 'single_post_title', $_post->post_title, $_post );
-        if ( $display ) {
-                echo $prefix . $title;
-        } else {
+
+        if ( ! $display ) {
                 return $prefix . $title;
         }
+
+        echo $prefix . $title;
+
+        return null;
 }
 
@@ -1754 +1759 @@
         $title = apply_filters( 'post_type_archive_title', $post_type_obj->labels->name, $post_type );
 
-        if ( $display ) {
-                echo $prefix . $title;
-        } else {
+        if ( ! $display ) {
                 return $prefix . $title;
         }
+
+        echo $prefix . $title;
+
+        return null;
 }
 
@@ -1850 +1857 @@
         }
 
-        if ( $display ) {
-                echo $prefix . $term_name;
-        } else {
+        if ( ! $display ) {
                 return $prefix . $term_name;
         }
+
+        echo $prefix . $term_name;
+
+        return null;
 }
 
@@ -2914 +2923 @@
         $the_date = apply_filters( 'the_date', $the_date, $format, $before, $after );
 
-        if ( $display ) {
-                echo $the_date;
-        } else {
+        if ( ! $display ) {
                 return $the_date;
         }
+
+        echo $the_date;
+
+        return null;
 }
 
@@ -2982 +2993 @@
         $the_modified_date = apply_filters( 'the_modified_date', $the_modified_date, $format, $before, $after );
 
-        if ( $display ) {
-                echo $the_modified_date;
-        } else {
+        if ( ! $display ) {
                 return $the_modified_date;
         }
+
+        echo $the_modified_date;
+
+        return null;
 }
 

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

@@ -1165 +1165 @@
         $link = $before . apply_filters( 'edit_term_link', $link, $term->term_id ) . $after;
 
-        if ( $display ) {
-                echo $link;
-        } else {
+        if ( ! $display ) {
                 return $link;
         }
+
+        echo $link;
+
+        return null;
 }
 
@@ -2548 +2550 @@
         $output = $link ? esc_url( $link ) : '';
 
-        if ( $display ) {
-                echo $output;
-        } else {
+        if ( ! $display ) {
                 return $output;
         }
+
+        echo $output;
+
+        return null;
 }
 
@@ -2658 +2662 @@
         $output = $link ? esc_url( $link ) : '';
 
-        if ( $display ) {
-                echo $output;
-        } else {
+        if ( ! $display ) {
                 return $output;
         }
+
+        echo $output;
+
+        return null;
 }