Twig for Template Designers ¶

Global Variables ¶

The following variables are always available in templates:

• _self: references the current template name;
  _self: 現在のテンプレート名を参照します。
• _context: references the current context;
  _context: 現在のコンテキストを参照します。
• _charset: references the current charset.
  _charset: 現在の文字セットを参照します。

Setting Variables ¶

You can assign values to variables inside code blocks. Assignments use the set tag:

1
2
3

{% set foo = 'foo' %}
{% set foo = [1, 2] %}
{% set foo = {'foo': 'bar'} %}

Working with Manual Escaping ¶

If manual escaping is enabled, it is your responsibility to escape variables if needed. What to escape? Any variable that comes from an untrusted source.

Escaping works by using the escape or e filter:

1

{{ user.username|e }}

By default, the escape filter uses the html strategy, but depending on the escaping context, you might want to explicitly use another strategy:

1
2
3
4

{{ user.username|e('js') }}
{{ user.username|e('css') }}
{{ user.username|e('url') }}
{{ user.username|e('html_attr') }}

Working with Automatic Escaping ¶

Whether automatic escaping is enabled or not, you can mark a section of a template to be escaped or not by using the autoescape tag:

1
2
3

{% autoescape %}
    Everything will be automatically escaped in this block (using the HTML strategy)
{% endautoescape %}

By default, auto-escaping uses the html escaping strategy. If you output variables in other contexts, you need to explicitly escape them with the appropriate escaping strategy:

1
2
3

{% autoescape 'js' %}
    Everything will be automatically escaped in this block (using the JS strategy)
{% endautoescape %}

Literals ¶

The simplest form of expressions are literals. Literals are representations for PHP types such as strings, numbers, and arrays. The following literals exist:

• "Hello World": Everything between two double or single quotes is a string. They are useful whenever you need a string in the template (for example as arguments to function calls, filters or just to extend or include a template). A string can contain a delimiter if it is preceded by a backslash (\) -- like in 'It\'s good'. If the string contains a backslash (e.g. 'c:\Program Files') escape it by doubling it (e.g. 'c:\\Program Files').
  "Hello World": 2 つの二重引用符または単一引用符の間はすべて astring です。これらは、テンプレートに文字列が必要な場合に便利です (たとえば、関数呼び出し、フィルターへの引数として、または単にテンプレートを拡張または含めるため)。 'It\'s good' のように、バックスラッシュ (\) が前にある場合、文字列に区切り文字を含めることができます。文字列にバックスラッシュが含まれている場合 (例: 'c:\Program Files')、二重にしてエスケープします (例: 'c:\\Program Files')。
• 42 / 42.23: Integers and floating point numbers are created by writing the number down. If a dot is present the number is a float, otherwise an integer.
  42 / 42.23: 整数と浮動小数点数は、数値を書き留めることによって作成されます。ドットが存在する場合、数値は float であり、そうでない場合は整数です。
• ["foo", "bar"]: Arrays are defined by a sequence of expressions separated by a comma (,) and wrapped with squared brackets ([]).
  ["foo", "bar"]: 配列は、コンマ (,) で区切られ、角かっこ ([]) で囲まれた一連の式によって定義されます。

• {"foo": "bar"}: Hashes are defined by a list of keys and values separated by a comma (,) and wrapped with curly braces ({}):

  {"foo": "bar"}: ハッシュは、コンマ (,) で区切られ、中かっこ ({}) で囲まれたキーと値のリストによって定義されます。

  1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17

  {# keys as string #} { 'foo': 'foo', 'bar': 'bar' } {# keys as names (equivalent to the previous hash) #} { foo: 'foo', bar: 'bar' } {# keys as integer #} { 2: 'foo', 4: 'bar' } {# keys can be omitted if it is the same as the variable name #} { foo } {# is equivalent to the following #} { 'foo': foo } {# keys as expressions (the expression must be enclosed into parentheses) #} {% set foo = 'foo' %} { (foo): 'foo', (1 + 1): 'bar', (foo ~ 'b'): 'baz' }

• true / false: true represents the true value, false represents the false value.
  true / false: true は真の値を表し、false は偽の値を表します。
• null: null represents no specific value. This is the value returned when a variable does not exist. none is an alias for null.
  null: null は特定の値がないことを表します。これは、変数が存在しない場合に返される値です。 none は null のエイリアスです。

Arrays and hashes can be nested:

1

{% set foo = [1, {"foo": "bar"}] %}

Math ¶

Twig allows you to do math in templates; the following operators are supported:

• +: Adds two numbers together (the operands are casted to numbers). {{ 1 + 1 }} is 2.
  +: 2 つの数値を加算します (オペランドは数値にキャストされます)。 {{1 + 1}} は 2 です。
• -: Subtracts the second number from the first one. {{ 3 - 2 }} is 1.
  -: 最初の数値から 2 番目の数値を引きます。 {{ 3 - 2 }} は 1 です。
• /: Divides two numbers. The returned value will be a floating point number. {{ 1 / 2 }} is {{ 0.5 }}.
  /: 2 つの数値を除算します。戻り値は浮動小数点数になります。 {{ 1 / 2 }} は {{ 0.5 }} です。
• %: Calculates the remainder of an integer division. {{ 11 % 7 }} is 4.
  %: 整数除算の剰余を計算します。 {{ 11 % 7 }} は 4.
• //: Divides two numbers and returns the floored integer result. {{ 20 // 7 }} is 2, {{ -20 // 7 }} is -3 (this is just syntactic sugar for the round filter).
  //: 2 つの数値を除算し、フロア型整数の結果を返します。 {{ 20// 7 }} は 2、{{ -20// 7 }} は -3 です (これはラウンド フィルターの単なる構文糖衣です)。
• *: Multiplies the left operand with the right one. {{ 2 * 2 }} would return 4.
  *: 左オペランドと右オペランドを乗算します。 {{ 2 * 2 }} は 4 を返します。
• **: Raises the left operand to the power of the right operand. {{ 2 ** 3 }} would return 8.
  **: 左オペランドを右オペランドで累乗します。 {{ 2 **3 }} は 8 を返します。

Logic ¶

You can combine multiple expressions with the following operators:

• and: Returns true if the left and the right operands are both true.
  and: 左右のオペランドが両方とも true の場合に true を返します。
• or: Returns true if the left or the right operand is true.
  or: 左または右のオペランドが true の場合に true を返します。
• not: Negates a statement.
  not: ステートメントを否定します。
• (expr): Groups an expression.
  (expr): 式をグループ化します。

Comparisons ¶

The following comparison operators are supported in any expression: ==, !=, <, >, >=, and <=.

Check if a string starts with or ends with another string:

1
2
3
4
5

{% if 'Fabien' starts with 'F' %}
{% endif %}

{% if 'Fabien' ends with 'n' %}
{% endif %}

Check that a string contains another string via the containment operator (see next section).

1
2

{% if phone matches '/^[\\d\\.]+$/' %}
{% endif %}

Check that a sequence or a mapping has every or has some of its elements return true using an arrow function. The arrow function receives the value of the sequence or mapping:

1
2
3
4
5
6
7

{% set sizes = [34, 36, 38, 40, 42] %}

{% set hasOnlyOver38 = sizes has every v => v > 38 %}
{# hasOnlyOver38 is false #}

{% set hasOver38 = sizes has some v => v > 38 %}
{# hasOver38 is true #}

Containment Operator ¶

The in operator performs containment test. It returns true if the left operand is contained in the right:

1
2
3
4
5

{# returns true #}

{{ 1 in [1, 2, 3] }}

{{ 'cd' in 'abcde' }}

To perform a negative test, use the not in operator:

1
2
3
4

{% if 1 not in [1, 2, 3] %}

{# is equivalent to #}
{% if not (1 in [1, 2, 3]) %}

Test Operator ¶

The is operator performs tests. Tests can be used to test a variable against a common expression. The right operand is name of the test:

1
2
3

{# find out if a variable is odd #}

{{ name is odd }}

Tests can accept arguments too:

1

{% if post.status is constant('Post::PUBLISHED') %}

Tests can be negated by using the is not operator:

1
2
3
4

{% if post.status is not constant('Post::PUBLISHED') %}

{# is equivalent to #}
{% if not (post.status is constant('Post::PUBLISHED')) %}

Go to the tests page to learn more about the built-in tests.

Other Operators ¶

The following operators don't fit into any of the other categories:

• |: Applies a filter.
  |: フィルターを適用します。

• ..: Creates a sequence based on the operand before and after the operator (this is syntactic sugar for the range function):

  ..: 演算子の前後のオペランドに基づいてシーケンスを作成します (これは range 関数のシンタックス シュガーです):

  1 2 3 4

  {{ 1..5 }} {# equivalent to #} {{ range(1, 5) }}

  Note that you must use parentheses when combining it with the filter operator due to the operator precedence rules:

  演算子の優先順位規則により、フィルター演算子と組み合わせる場合は括弧を使用する必要があることに注意してください。

  1	(1..5)|join(', ')

• ~: Converts all operands into strings and concatenates them. {{ "Hello " ~ name ~ "!" }} would return (assuming name is 'John') Hello John!.
  ~: すべてのオペランドを文字列に変換して連結します。 {{「こんにちは」～名前～「！」 }} は (名前が 'John' であると仮定して) HelloJohn! を返します。
• ., []: Gets an attribute of a variable.
  ., []: 変数の属性を取得します。

• ?:: The ternary operator:

  ?:: 三項演算子:

  1 2 3

  {{ foo ? 'yes' : 'no' }} {{ foo ?: 'no' }} is the same as {{ foo ? foo : 'no' }} {{ foo ? 'yes' }} is the same as {{ foo ? 'yes' : '' }}

• ??: The null-coalescing operator:

  ??: null 合体演算子:

  1 2	{# returns the value of foo if it is defined and not null, 'no' otherwise #} {{ foo ?? 'no' }}

String Interpolation ¶

String interpolation (#{expression}) allows any valid expression to appear within a double-quoted string. The result of evaluating that expression is inserted into the string:

1
2

{{ "foo #{bar} baz" }}
{{ "foo #{1 + 2} baz" }}