docs: add never|void return type to wp_die()

Author: justlevine

phpstan.neon.dist

@@ -19,7 +19,7 @@ parameters:
 
 	ignoreErrors:
 		# Level 0:
-		- # Inner functions arent supported by PHPstan.
+		- # Inner functions aren't supported by PHPStan.
 			message: '#Function wxr_[a-z_]+ not found#'
 			path: src/wp-admin/includes/export.php
 		-

src/wp-includes/functions.php

@@ -3765,6 +3765,10 @@ function wp_nonce_ays( $action ) {
  *                                  is a WP_Error.
  *     @type bool   $exit           Whether to exit the process after completion. Default true.
  * }
+ *
+ * @return never|void Returns false if `$args['exit']` is false, otherwise exists.
+ *
+ * @phpstan-return ($args['exit'] is false ? void : never)
  */
 function wp_die( $message = '', $title = '', $args = array() ) {
 	global $wp_query;