aboutsummaryrefslogtreecommitdiffhomepage
path: root/vendor/twig/twig/doc/filters/convert_encoding.rst
blob: 1b0eb60c3ab4f252f7f6c175e3c84af2708b645b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
``convert_encoding``
====================

.. versionadded:: 1.4
    The ``convert_encoding`` filter was added in Twig 1.4.

The ``convert_encoding`` filter converts a string from one encoding to
another. The first argument is the expected output charset and the second one
is the input charset:

.. code-block:: jinja

    {{ data|convert_encoding('UTF-8', 'iso-2022-jp') }}

.. note::

    This filter relies on the `iconv`_ or `mbstring`_ extension, so one of
    them must be installed. In case both are installed, `mbstring`_ is used by
    default (Twig before 1.8.1 uses `iconv`_ by default).

Arguments
---------

 * ``from``: The input charset
 * ``to``:   The output charset

.. _`iconv`:    http://php.net/iconv
.. _`mbstring`: http://php.net/mbstring