_deprecated_constructor( string $class_name, string $version, string $parent_class = '' )
Marks a constructor as deprecated and informs when it has been used.
Description
Similar to _deprecated_function() , but with different strings. Used to remove PHP4 style constructors.
The current behavior is to trigger a user error if WP_DEBUG
is true.
This function is to be used in every PHP4 style constructor method that is deprecated.
Parameters
-
$class_name
string Required -
The class containing the deprecated constructor.
-
$version
string Required -
The version of WordPress that deprecated the function.
-
$parent_class
string Optional -
The parent class calling the deprecated constructor.
Default:
''
Source
File: wp-includes/functions.php
.
View all references
function _deprecated_constructor( $class_name, $version, $parent_class = '' ) {
/**
* Fires when a deprecated constructor is called.
*
* @since 4.3.0
* @since 4.5.0 Added the `$parent_class` parameter.
*
* @param string $class_name The class containing the deprecated constructor.
* @param string $version The version of WordPress that deprecated the function.
* @param string $parent_class The parent class calling the deprecated constructor.
*/
do_action( 'deprecated_constructor_run', $class_name, $version, $parent_class );
/**
* Filters whether to trigger an error for deprecated functions.
*
* `WP_DEBUG` must be true in addition to the filter evaluating to true.
*
* @since 4.3.0
*
* @param bool $trigger Whether to trigger the error for deprecated functions. Default true.
*/
if ( WP_DEBUG && apply_filters( 'deprecated_constructor_trigger_error', true ) ) {
if ( function_exists( '__' ) ) {
if ( $parent_class ) {
trigger_error(
sprintf(
/* translators: 1: PHP class name, 2: PHP parent class name, 3: Version number, 4: __construct() method. */
__( 'The called constructor method for %1$s class in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.' ),
$class_name,
$parent_class,
$version,
'<code>__construct()</code>'
),
E_USER_DEPRECATED
);
} else {
trigger_error(
sprintf(
/* translators: 1: PHP class name, 2: Version number, 3: __construct() method. */
__( 'The called constructor method for %1$s class is <strong>deprecated</strong> since version %2$s! Use %3$s instead.' ),
$class_name,
$version,
'<code>__construct()</code>'
),
E_USER_DEPRECATED
);
}
} else {
if ( $parent_class ) {
trigger_error(
sprintf(
'The called constructor method for %1$s class in %2$s is <strong>deprecated</strong> since version %3$s! Use %4$s instead.',
$class_name,
$parent_class,
$version,
'<code>__construct()</code>'
),
E_USER_DEPRECATED
);
} else {
trigger_error(
sprintf(
'The called constructor method for %1$s class is <strong>deprecated</strong> since version %2$s! Use %3$s instead.',
$class_name,
$version,
'<code>__construct()</code>'
),
E_USER_DEPRECATED
);
}
}
}
}
Hooks
-
do_action( 'deprecated_constructor_run',
string $class_name ,string $version ,string $parent_class ) -
Fires when a deprecated constructor is called.
-
apply_filters( 'deprecated_constructor_trigger_error',
bool $trigger ) -
Filters whether to trigger an error for deprecated functions.
Changelog
Version | Description |
---|---|
5.4.0 | The error type is now classified as E_USER_DEPRECATED (used to default to E_USER_NOTICE). |
4.5.0 | Added the $parent_class parameter. |
4.3.0 | Introduced. |