Home/ Manual/ predefined / attributes/ The Deprecated attribute

The Deprecated attribute

Guide Edit on GitHub ✎

This attribute is used to mark functionality as deprecated. Using deprecated functionality will cause an E_USER_DEPRECATED error to be emitted.

Intro

This attribute is used to mark functionality as deprecated. Using deprecated functionality will cause an E_USER_DEPRECATED error to be emitted.

As of PHP 8.5.0, this attribute can also be applied to traits and to compile-time constants declared outside of a class.

Class synopsis

#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_FUNCTION | \Attribute::TARGET_CLASS_CONSTANT | \Attribute::TARGET_CONSTANT | \Attribute::TARGET_CLASS)] Deprecated { }

Properties

message

An optional message explaining the reason for the deprecation and possible replacement functionality. Will be included in the emitted deprecation message.

since

An optional string indicating since when the functionality is deprecated. The contents are not validated by PHP and may contain a version number, a date or any other value that is considered appropriate. Will be included in the emitted deprecation message.

Functionality that is part of PHP will use Major.Minor as the since value, for example '8.4'.

Examples

php

<?php

#[\Deprecated(message: "use safe_replacement() instead", since: "1.5")]
function unsafe_function()
{
   echo "This is unsafe", PHP_EOL;
}

unsafe_function();

?>

Similar

output

Deprecated: Function unsafe_function() is deprecated since 1.5, use safe_replacement() instead in example.php on line 9
This is unsafe

Changelog

Version	Description
8.5.0	`Deprecated` can now be applied to traits and to compile-time constants declared outside of a class, the latter through the new `Attribute::TARGET_CONSTANT` target.

In this section

Deprecated::__construct

Construct a new Deprecated attribute instance

Source: language/predefined/attributes/deprecated.xml · from the official PHP manual (php/doc-en)