Changeset 62635

Timestamp:

07/05/2026 12:27:24 AM (2 months ago)

Author:

westonruter

Message:

Docs: Modernize and improve specificity of types in WP_Error class.

This brings the WP_Error class to full PHPStan rule level 10 compliance.

Also make use of null coalescing operator where appropriate, and simplify has_errors() method.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/12405.
Follow-up to r42761, r49115, r49116.

See #64898, #64897.

File:

• trunk/src/wp-includes/class-wp-error.php (modified) (14 diffs)

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

@@ -22 +22 @@
          *
          * @since 2.1.0
-         * @var array
+         * @var array<int|string, string[]>
          */
         public $errors = array();
@@ -30 +30 @@
          *
          * @since 2.1.0
-         * @var array
+         * @var array<int|string, mixed>
          */
         public $error_data = array();
@@ -38 +38 @@
          *
          * @since 5.6.0
-         * @var array[]
+         * @var array<int|string, mixed[]>
          */
         protected $additional_data = array();
@@ -72 +72 @@
          * @since 2.1.0
          *
-         * @return array List of error codes, if available.
+         * @return list<int|string> List of error codes, if available.
          */
         public function get_error_codes() {
@@ -112 +112 @@
                 if ( empty( $code ) ) {
                         $all_messages = array();
-                        foreach ( (array) $this->errors as $code => $messages ) {
+                        foreach ( (array) $this->errors as $messages ) {
                                 $all_messages = array_merge( $all_messages, $messages );
                         }
@@ -119 +119 @@
                 }
 
-                if ( isset( $this->errors[ $code ] ) ) {
-                        return $this->errors[ $code ];
-                } else {
-                        return array();
-                }
+                return $this->errors[ $code ] ?? array();
         }
 
@@ -162 +158 @@
                 }
 
-                if ( isset( $this->error_data[ $code ] ) ) {
-                        return $this->error_data[ $code ];
-                }
+                return $this->error_data[ $code ] ?? null;
         }
 
@@ -175 +169 @@
          */
         public function has_errors() {
-                if ( ! empty( $this->errors ) ) {
-                        return true;
-                }
-                return false;
+                return (bool) $this->errors;
         }
 
@@ -189 +180 @@
          * @param string     $message Error message.
          * @param mixed      $data    Optional. Error data. Default empty string.
+         * @return void
          */
         public function add( $code, $message, $data = '' ) {
@@ -218 +210 @@
          * @param mixed      $data Error data.
          * @param string|int $code Error code.
+         * @return void
          */
         public function add_data( $data, $code = '' ) {
@@ -266 +259 @@
          *
          * @param string|int $code Error code.
+         * @return void
          */
         public function remove( $code ) {
@@ -279 +273 @@
          *
          * @param WP_Error $error Error object to merge.
+         * @return void
          */
         public function merge_from( WP_Error $error ) {
@@ -290 +285 @@
          *
          * @param WP_Error $error Error object to export into.
+         * @return void
          */
         public function export_to( WP_Error $error ) {
@@ -302 +298 @@
          * @param WP_Error $from The WP_Error to copy from.
          * @param WP_Error $to   The WP_Error to copy to.
+         * @return void
          */
         protected static function copy_errors( WP_Error $from, WP_Error $to ) {