Ticket #38777: 38777.5.diff

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

@@ -27 +27 @@
         public $errors = array();
 
         /**
-         * Stores the list of data for error codes.
+         * Stores the most-recently added data for error codes.
          *
          * @since 2.1.0
          * @var array
          */
         public $error_data = array();
 
+        /**
+         * Stores previously added data added for error codes, oldest-to-newest by code.
+         *
+         * @since 5.6.0
+         * @var array[]
+         */
+        protected $additional_data = array();
+
         /**
          * Initialize the error.
          *
@@ -140 +148 @@
         }
 
         /**
-         * Retrieve error data for error code.
+         * Retrieve the most-recently added error data for error code.
          *
          * @since 2.1.0
          *
@@ -203 +211 @@
         /**
          * Add data for error code.
          *
-         * The error code can only contain one error data.
-         *
          * @since 2.1.0
+         * @since 5.6.0 Error codes can now contain more than one error data. {@see WP_Error::$additional_data}.
          *
          * @param mixed      $data Error data.
          * @param string|int $code Error code.
@@ -215 +222 @@
                         $code = $this->get_error_code();
                 }
 
+                if ( isset( $this->error_data[ $code ] ) ) {
+                        $this->additional_data[ $code ][] = $this->error_data[ $code ];
+                }
+
                 $this->error_data[ $code ] = $data;
         }
 
+        /**
+         * Retrieve all error data for an error code in the order in which the data was added.
+         *
+         * @since 5.6.0
+         *
+         * @param string|int $code Error code.
+         * @return mixed[] Error data, if it exists.
+         */
+        public function get_all_error_data( $code ) {
+                $data = array();
+
+                if ( isset( $this->additional_data[ $code ] ) ) {
+                        $data = array_merge( $data, $this->additional_data[ $code ] );
+                }
+
+                if ( isset( $this->error_data[ $code ] ) ) {
+                        $data[] = $this->error_data[ $code ];
+                }
+
+                return $data;
+        }
+
         /**
          * Removes the specified error.
          *
@@ -231 +264 @@
         public function remove( $code ) {
                 unset( $this->errors[ $code ] );
                 unset( $this->error_data[ $code ] );
+                unset( $this->additional_data[ $code ] );
+        }
+
+        /**
+         * Merge the errors in another error object into this one.
+         *
+         * @since 5.6.0
+         *
+         * @param WP_Error $error Error object to merge.
+         */
+        public function merge_from( WP_Error $error ) {
+                static::copy_errors( $error, $this );
+        }
+
+        /**
+         * Export the errors in this object into another one.
+         *
+         * @since 5.6.0
+         *
+         * @param WP_Error $error Error object to export into.
+         */
+        public function export_to( WP_Error $error ) {
+                static::copy_errors( $this, $error );
+        }
+
+        /**
+         * Copy errors from one WP_Error to another.
+         *
+         * @since 5.6.0
+         *
+         * @param WP_Error $from From.
+         * @param WP_Error $to   To.
+         */
+        protected static function copy_errors( WP_Error $from, WP_Error $to ) {
+                foreach ( $from->get_error_codes() as $code ) {
+                        foreach ( $from->get_error_messages( $code ) as $error_message ) {
+                                $to->add( $code, $error_message );
+                        }
+
+                        foreach ( $from->get_all_error_data( $code ) as $data ) {
+                                $to->add_data( $data, $code );
+                        }
+                }
         }
 }

tests/phpunit/tests/general/wpError.php

@@ -375 +375 @@
                 $this->assertSame( 'data2', $this->wp_error->get_error_data( 'code' ) );
         }
 
+        /**
+         * @covers ::get_all_error_data
+         */
+        public function test_get_all_error_data_with_code_and_no_errors_should_evaluate_as_empty_array() {
+                $this->assertSame( array(), $this->wp_error->get_all_error_data( 'code' ) );
+        }
+
+        /**
+         * @covers ::get_all_error_data
+         */
+        public function test_get_all_error_data_with_code_and_one_error_with_no_data_should_evaluate_as_empty_array() {
+                $this->wp_error->add( 'code', 'message' );
+
+                $this->assertSame( array(), $this->wp_error->get_all_error_data( 'code' ) );
+        }
+
+        /**
+         * @covers ::get_all_error_data
+         */
+        public function test_get_all_error_data_with_code_and_one_error_with_data_should_return_that_data() {
+                $expected = array( 'data-key' => 'data-value' );
+                $this->wp_error->add( 'code', 'message', $expected );
+
+                $actual = $this->wp_error->get_all_error_data( 'code' );
+                $this->assertCount( 1, $actual );
+                $this->assertSameSetsWithIndex( $expected, $actual[0] );
+        }
+
+        /**
+         * @covers ::get_all_error_data
+         */
+        public function test_get_all_error_data_with_code_and_multiple_errors_same_code_should_return_all_data() {
+                $this->wp_error->add( 'code', 'message', 'data' );
+                $this->wp_error->add( 'code', 'message2', 'data2' );
+                $this->wp_error->add( 'code2', 'message3', 'data3' );
+
+                $this->assertSame( array( 'data', 'data2' ), $this->wp_error->get_all_error_data( 'code' ) );
+        }
+
         /**
          * @covers ::has_errors
          */
@@ -711 +750 @@
          * @covers ::remove
          */
         public function test_remove_should_remove_the_error_data_associated_with_the_given_code() {
-                $this->wp_error->add( 'code', 'message', 'data' );
+                $this->wp_error->add( 'code', 'message', 'data1' );
+                $this->wp_error->add( 'code', 'message', 'data2' );
 
                 $this->wp_error->remove( 'code' );
 
                 $this->assertEmpty( $this->wp_error->error_data );
+                $this->assertEmpty( $this->wp_error->get_all_error_data( 'code' ) );
         }
 
+        /**
+         * @covers ::merge_from()
+         */
+        public function test_merge_from_should_copy_other_error_into_instance() {
+                $this->wp_error->add( 'code1', 'message1', 'data1' );
+
+                $other = new \WP_Error( 'code1', 'message2', 'data2' );
+                $other->add( 'code2', 'message3' );
+                $this->wp_error->merge_from( $other );
+
+                $this->assertSame( array( 'message1', 'message2' ), $this->wp_error->get_error_messages( 'code1' ) );
+                $this->assertSame( 'data2', $this->wp_error->get_error_data( 'code1' ) );
+                $this->assertSame( array( 'data1', 'data2' ), $this->wp_error->get_all_error_data( 'code1' ) );
+                $this->assertSame( 'message3', $this->wp_error->get_error_message( 'code2' ) );
+        }
+
+        /**
+         * @covers ::merge_from()
+         */
+        public function test_merge_from_with_no_errors_should_not_add_to_instance() {
+                $other = new \WP_Error();
+
+                $this->wp_error->merge_from( $other );
+
+                $this->assertFalse( $this->wp_error->has_errors() );
+        }
+
+        /**
+         * @covers ::export_to()
+         */
+        public function test_export_to_should_copy_instance_into_other_error() {
+                $other = new \WP_Error();
+                $other->add( 'code1', 'message1', 'data1' );
+
+                $this->wp_error->add( 'code1', 'message2', 'data2' );
+                $this->wp_error->add( 'code2', 'message3' );
+
+                $this->wp_error->export_to( $other );
+
+                $this->assertSame( array( 'message1', 'message2' ), $other->get_error_messages( 'code1' ) );
+                $this->assertSame( 'data2', $other->get_error_data( 'code1' ) );
+                $this->assertSame( array( 'data1', 'data2' ), $other->get_all_error_data( 'code1' ) );
+                $this->assertSame( 'message3', $other->get_error_message( 'code2' ) );
+        }
+
+        /**
+         * @covers ::export_to()
+         */
+        public function test_export_to_with_no_errors_should_not_add_to_other_error() {
+                $other = new \WP_Error();
+
+                $this->wp_error->export_to( $other );
+
+                $this->assertFalse( $other->has_errors() );
+        }
 }