Marks a class as deprecated and informs when it has been used.
Description
There is a ‘deprecated_class_run’ hook that will be called that can be used to get the backtrace up to what file and function called the deprecated class.
The current behavior is to trigger a user error if WP_DEBUG is true.
This function is to be used in the class constructor for every deprecated class.
See _deprecated_constructor() for deprecating PHP4-style constructors.
Parameters
$class_namestringrequired- The name of the class being instantiated.
$versionstringrequired- The version of WordPress that deprecated the class.
$replacementstringoptional- The class or function that should have been called.
Default:
''
Source
function _deprecated_class( $class_name, $version, $replacement = '' ) { /** * Fires when a deprecated class is called. * * @since 6.4.0 * * @param string $class_name The name of the class being instantiated. * @param string $replacement The class or function that should have been called. * @param string $version The version of WordPress that deprecated the class. */ do_action( 'deprecated_class_run', $class_name, $replacement, $version ); /** * Filters whether to trigger an error for a deprecated class. * * @since 6.4.0 * * @param bool $trigger Whether to trigger an error for a deprecated class. Default true. */ if ( WP_DEBUG && apply_filters( 'deprecated_class_trigger_error', true ) ) { if ( function_exists( '__' ) ) { if ( $replacement ) { $message = sprintf( /* translators: 1: PHP class name, 2: Version number, 3: Alternative class or function name. */ __( 'Class %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ), $class_name, $version, $replacement ); } else { $message = sprintf( /* translators: 1: PHP class name, 2: Version number. */ __( 'Class %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.' ), $class_name, $version ); } } else { if ( $replacement ) { $message = sprintf( 'Class %1$s is <strong>deprecated</strong> since version %2$s! Use %3$s instead.', $class_name, $version, $replacement ); } else { $message = sprintf( 'Class %1$s is <strong>deprecated</strong> since version %2$s with no alternative available.', $class_name, $version ); } } wp_trigger_error( '', $message, E_USER_DEPRECATED ); } } Hooks
- do_action( ‘deprecated_class_run’,
string $class_name ,string $replacement ,string $version ) Fires when a deprecated class is called.
- apply_filters( ‘deprecated_class_trigger_error’,
bool $trigger ) Filters whether to trigger an error for a deprecated class.
Changelog
| Version | Description |
|---|---|
| 6.4.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.