Changeset 56467 for trunk/tests/phpunit/includes/abstract-testcase.php

Timestamp:

08/25/2023 03:24:00 AM (13 months ago)

Author:

DrewAPicture

Message:

Introduce a _deprecated_class() function.

Similar to other function in the _deprecated_* series, _deprecated_class() comes with two new hooks: deprecated_class_run and deprecated_class_trigger_error.

Support has also been added for setting class deprecation expectations in tests.

Props jrf, wvega, ohryan.
See #41125.

File:

• trunk/tests/phpunit/includes/abstract-testcase.php (modified) (3 diffs)

trunk/tests/phpunit/includes/abstract-testcase.php

@@ -569 +569 @@
         add_action( 'deprecated_function_run', array( $this, 'deprecated_function_run' ), 10, 3 );
         add_action( 'deprecated_argument_run', array( $this, 'deprecated_function_run' ), 10, 3 );
+        add_action( 'deprecated_class_run', array( $this, 'deprecated_function_run' ), 10, 3 );
         add_action( 'deprecated_file_included', array( $this, 'deprecated_function_run' ), 10, 4 );
         add_action( 'deprecated_hook_run', array( $this, 'deprecated_function_run' ), 10, 4 );
@@ -575 +576 @@
         add_action( 'deprecated_function_trigger_error', '__return_false' );
         add_action( 'deprecated_argument_trigger_error', '__return_false' );
+        add_action( 'deprecated_class_trigger_error', '__return_false' );
         add_action( 'deprecated_file_trigger_error', '__return_false' );
         add_action( 'deprecated_hook_trigger_error', '__return_false' );
@@ -741 +743 @@
                         $message = sprintf(
                             'Function %1$s was called with an argument that is deprecated since version %2$s with no alternative available.',
+                            $function_name,
+                            $version
+                        );
+                    }
+                    break;
+
+                case 'deprecated_class_run':
+                    if ( $replacement ) {
+                        $message = sprintf(
+                            'Class %1$s is deprecated since version %2$s! Use %3$s instead.',
+                            $function_name,
+                            $version,
+                            $replacement
+                        );
+                    } else {
+                        $message = sprintf(
+                            'Class %1$s is deprecated since version %2$s with no alternative available.',
                             $function_name,
                             $version