Deprecating Services

Once you have decided to deprecate the use of a service (because it is outdated,

or you decided not to use and maintain it anymore), you can deprecate its

definition:

..configuration-block::

..code-block::yaml

..code-block::xml

..code-block::php

Now, every time a service is created using this deprecated definition will

trigger a deprecation error, advising you to stop or change your uses of that

service.

..note::

The deprecation message is optional. If not set, Symfony will show a default

message ``The "%service_id%" service is deprecated. You should stop using it,

as it will soon be removed.``.

..note::

The message is actually a message template, which will replace occurrences

of ``%service_id%`` by the service's id. You **must** have at least one

occurrence of ``%service_id%`` placeholder in your template.

..note::

It is strongly recommended that you fill the message template, to avoid a

message that could be too generic such as the default one. A good message

informs when this service was deprecated, and until when it will be

maintained (look at the examples above).

For services decorators (see above), if the definition does not modify the

deprecated status, it will inherit the status from the definition that is

decorated.