Changeset 53634

Timestamp:

07/02/2022 06:05:32 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Build/Test Tools: Add support for WP_Error in the test suite's wp_die() handlers.

This brings parity with WordPress core wp_die() handlers and ensures that if a WP_Error object is passed as the $message argument to wp_die(), the PHPUnit test suite displays the error message correctly.

Previously, this would cause a silent fatal error: Object of class WP_Error could not be converted to string, leading to just displaying wp_die called without any further details.

Follow-up to [28797], [41966], [44666], [45160], [47882].

See #55652.

File:

• trunk/tests/phpunit/includes/functions.php (modified) (5 diffs)

trunk/tests/phpunit/includes/functions.php

@@ -153 +153 @@
  * Handles the WP die handler by outputting the given values as text.
  *
- * @param string $message The message.
- * @param string $title   The title.
- * @param array  $args    Array with arguments.
+ * @param string|WP_Error $message Error message or WP_Error object.
+ * @param string          $title   Error title.
+ * @param array           $args    Arguments passed to wp_die().
  */
 function _wp_die_handler( $message, $title = '', $args = array() ) {
@@ -200 +200 @@
  * Dies without an exit.
  *
- * @param string $message The message.
- * @param string $title   The title.
- * @param array  $args    Array with arguments.
+ * @param string|WP_Error $message Error message or WP_Error object.
+ * @param string          $title   Error title.
+ * @param array           $args    Arguments passed to wp_die().
  */
 function _wp_die_handler_txt( $message, $title, $args ) {
-    echo "\nwp_die called\n";
+    list( $message, $title, $args ) = _wp_die_process_input( $message, $title, $args );
+
+    echo "\nwp_die() called\n";
     echo "Message: $message\n";
 
@@ -213 +215 @@
 
     if ( ! empty( $args ) ) {
-        echo "Args: \n";
-        foreach ( $args as $k => $v ) {
-            echo "\t $k : $v\n";
+        echo "Args:\n";
+        foreach ( $args as $key => $value ) {
+            if ( ! is_scalar( $value ) ) {
+                $value = var_export( $value, true );
+            }
+
+            echo "\t$key: $value\n";
         }
     }
@@ -223 +229 @@
  * Dies with an exit.
  *
- * @param string $message The message.
- * @param string $title   The title.
- * @param array  $args    Array with arguments.
+ * @param string|WP_Error $message Error message or WP_Error object.
+ * @param string          $title   Error title.
+ * @param array           $args    Arguments passed to wp_die().
  */
 function _wp_die_handler_exit( $message, $title, $args ) {
-    echo "\nwp_die called\n";
+    list( $message, $title, $args ) = _wp_die_process_input( $message, $title, $args );
+
+    echo "\nwp_die() called\n";
     echo "Message: $message\n";
 
@@ -236 +244 @@
 
     if ( ! empty( $args ) ) {
-        echo "Args: \n";
-        foreach ( $args as $k => $v ) {
-            echo "\t $k : $v\n";
+        echo "Args:\n";
+        foreach ( $args as $key => $value ) {
+            if ( ! is_scalar( $value ) ) {
+                $value = var_export( $value, true );
+            }
+
+            echo "\t$key: $value\n";
         }
     }
+
     exit( 1 );
 }