feature #15039 add serialize reference (jrushlow)

wouterj · wouterj · commit 79c31b9ccaac · 2021-04-07T17:26:56.000+02:00
This PR was squashed before being merged into the 5.3-dev branch. Discussion ---------- add serialize reference add docs for the new `serialize` filter provided by `TwigBridge` Commits ------- 91096d5 Add serialize reference
diff --git a/reference/twig_reference.rst b/reference/twig_reference.rst
@@ -558,6 +558,29 @@ project's root directory:
 If the given file path is out of the project directory, a ``null`` value
 will be returned.
 
+serialize
+~~~~~~~~~
+
+.. code-block:: twig
+
+    {{ object|serialize(format = 'json', context = []) }}
+
+``object``
+    **type**: ``mixed``
+
+``format`` *(optional)*
+    **type**: ``string``
+
+``context`` *(optional)*
+    **type**: ``array``
+
+.. versionadded:: 5.3
+
+    The ``serialize`` filter was introduced in Symfony 5.3.
+
+Accepts any data that can be serialized by the :doc:`Serializer component </serializer>`
+and returns a serialized string in the specified ``format``.
+
 .. _reference-twig-tags:
 
 Tags
diff --git a/serializer.rst b/serializer.rst
@@ -41,6 +41,19 @@ you need it or it can be used in a controller::
         }
     }
 
+Or you can use the ``serialize`` Twig filter in a template:
+
+.. code-block:: twig
+
+    {{ object|serialize(format = 'json') }}
+
+See the :doc:`twig reference </reference/twig_reference>` for
+more information.
+
+.. versionadded:: 5.3
+
+    A ``serialize`` filter was introduced in Symfony 5.3 that uses the Serializer component.
+
 Adding Normalizers and Encoders
 -------------------------------
 
