Context Navigation

← Previous Change
Next Change →

class-custom-image-header.php

Timestamp:

07/13/2026 07:14:54 AM (18 hours ago)

Author:

westonruter

Message:

Docs: Add never return types to functions that always terminate.

Documents @return never on 30 functions and methods whose every control-flow path ends in exit, die(), wp_die(), or wp_send_json_*(), so static analysis knows the code following a call to them is unreachable. Native never requires PHP 8.1, so these are PHPDoc-only.

Where terminating depends on a parameter, a conditional @phpstan-return describes each case rather than over-widening to the union of both. The seven wp_die() handlers gain the same conditional wp_die() itself already carries. trackback_response() and wp_protect_special_option() never return for the parameter values that die, while redirect_canonical(), check_admin_referer(), check_ajax_referer(), and get_cli_args() narrow their return types accordingly.

The bottom type never was also incorrectly declared in the return type union for get_cli_args(), so it was removed.

Developed as subset of https://github.com/WordPress/wordpress-develop/pull/12488.
Follow-up to r62703, r62178, r62177.

Props westonruter, mukesh27.
See #64896, #64898.

File:

: 1 edited

trunk/src/wp-admin/includes/class-custom-image-header.php (modified) (3 diffs)

Legend:

: Unmodified
: Added
: Removed

trunk/src/wp-admin/includes/class-custom-image-header.php

-              r62353
+              r62704
+         *
          * @since 3.9.0
+         *
+         * @return never
          */
         public function ajax_header_crop() {
 …
+         *
          * @since 3.9.0
+         *
+         * @return never
          */
         public function ajax_header_add() {
 …
+         *
          * @since 3.9.0
+         *
+         * @return never
          */
         public function ajax_header_remove() {

Note: See TracChangeset for help on using the changeset viewer.

Make WordPress Core

Context Navigation

Changeset 62704 for trunk/src/wp-admin/includes/class-custom-image-header.php

Legend:

trunk/src/wp-admin/includes/class-custom-image-header.php

Download in other formats: