Context Navigation

← Previous Change
Next Change →

pluggable.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-includes/pluggable.php (modified) (2 diffs)

Legend:

: Unmodified
: Added
: Removed

trunk/src/wp-includes/pluggable.php

-              r62590
+              r62704
          * @return int|false 1 if the nonce is valid and generated between 0-12 hours ago,
          *                   2 if the nonce is valid and generated between 12-24 hours ago.
+         *                   False if the nonce is invalid.
+         *                   False if the nonce is invalid. Only possible when `$action` is -1,
+         *                   as the function otherwise exits rather than returning false.
+         * @phpstan-return ( $action is -1 ? int|false : int )
          */
         function check_admin_referer( $action = -1, $query_arg = '_wpnonce' ) {
 …
          * @return int|false 1 if the nonce is valid and generated between 0-12 hours ago,
          *                   2 if the nonce is valid and generated between 12-24 hours ago.
+         *                   False if the nonce is invalid.
+         *                   False if the nonce is invalid. Only possible when `$stop` is false,
+         *                   as the function otherwise exits rather than returning false.
+         * @phpstan-return ( $stop is true ? int : int|false )
          */
         function check_ajax_referer( $action = -1, $query_arg = false, $stop = true ) {

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

Make WordPress Core

Context Navigation

Changeset 62704 for trunk/src/wp-includes/pluggable.php

Legend:

trunk/src/wp-includes/pluggable.php

Download in other formats: