8000 [OptionsResolver] Add note about deprecated options · symfony/symfony-docs@aaac426 · GitHub
[go: up one dir, main page]

Skip to content

Commit aaac426

Browse files
ycerutojaviereguiluz
authored andcommitted
[OptionsResolver] Add note about deprecated options
1 parent 1e11b50 commit aaac426

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

components/options_resolver.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -733,6 +733,12 @@ method::
733733
somewhere, either its value is provided by the user or the option is evaluated
734734
within closures of lazy options and normalizers.
735735

736+
.. note::
737+
738+
If you use your own deprecated option within your own library and need to fix it,
739+
pass ``false`` as second argument of the :method:`Symfony\\Component\\OptionsResolver\\Options::offsetGet()` method
740+
so as not to trigger the deprecation warning.
741+
736742
Instead of passing the message, you may also pass a closure which returns
737743
a string (the deprecation message) or an empty string to ignore the deprecation.
738744
This closure is useful to only deprecate some of the allowed types or values of

0 commit comments

Comments
 (0)
0