Changeset 49022

Timestamp:

09/20/2020 05:43:00 PM (5 years ago)

Author:

johnbillion

Message:

General: Introduce the wp_error_added and wp_error_checked actions.

These actions allow debugging tools to track WP_Error instances as they're created and subsequently passed between functions which check for error objects.

Props Shelob9, Mte90, TimothyBlynJacobs, johnbillion

Fixes #40568

Location:

trunk/src/wp-includes

Files:

• class-wp-error.php (modified) (3 diffs)
• load.php (modified) (1 diff)

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

@@ -57 +57 @@
         }
 
-        $this->errors[ $code ][] = $message;
-
-        if ( ! empty( $data ) ) {
-            $this->error_data[ $code ] = $data;
-        }
+        $this->add( $code, $message, $data );
     }
 
@@ -177 +173 @@
 
     /**
-     * Add an error or append additional message to an existing error.
+     * Adds an error or appends an additional message to an existing error.
      *
      * @since 2.1.0
@@ -187 +183 @@
     public function add( $code, $message, $data = '' ) {
         $this->errors[ $code ][] = $message;
+
         if ( ! empty( $data ) ) {
-            $this->error_data[ $code ] = $data;
-        }
+            $this->add_data( $data, $code );
+        }
+
+        /**
+         * Fires when an error is added to a WP_Error object.
+         *
+         * @since 5.6.0
+         *
+         * @param string|int $code     Error code.
+         * @param string     $message  Error message.
+         * @param mixed      $data     Error data. Might be empty.
+         * @param WP_Error   $wp_error The WP_Error object.
+         */
+        do_action( 'wp_error_added', $code, $message, $data, $this );
     }
 

trunk/src/wp-includes/load.php

@@ -1447 +1447 @@
 
 /**
- * Check whether variable is a WordPress Error.
- *
- * Returns true if $thing is an object of the WP_Error class.
+ * Checks whether the given variable is a WordPress Error.
+ *
+ * Returns whether `$thing` is an instance of the `WP_Error` class.
  *
  * @since 2.1.0
  *
- * @param mixed $thing Check if unknown variable is a WP_Error object.
- * @return bool True, if WP_Error. False, if not WP_Error.
+ * @param mixed $thing The variable to check.
+ * @return bool Whether the variable is an instance of WP_Error.
  */
 function is_wp_error( $thing ) {
-    return ( $thing instanceof WP_Error );
+    $is = ( $thing instanceof WP_Error );
+
+    if ( $is ) {
+        /**
+         * Fires when `is_wp_error()` is called and it's an instance of `WP_Error`.
+         *
+         * @since 5.6.0
+         *
+         * @param WP_Error $thing The error object passed to `is_wp_error()`.
+         */
+        do_action( 'wp_error_checked', $thing );
+    }
+
+    return $is;
 }