Twig (template engine)
Twig is a template engine for the PHP programming language. Its syntax originates from Jinja and Django templates. It's an open source product licensed under a BSD License and maintained by Fabien Potencier. The initial version was created by Armin Ronacher. Symfony PHP framework comes with a bundled support for Twig as its default template engine since version 2.
The same template language is used by the Nunjucks template engine, thus Nunjucks is also supported by the following tools.
Features
- Complex control flow
- Automatic escaping
- Template inheritance
- Variable filters
- i18n support
- Macros
- Fully extendable
- Eclipse via the Twig plugin
- Komodo and Komodo Edit via the Twig highlight/syntax check mode
- NetBeans via the Twig syntax plugin
- PhpStorm
- IntelliJ IDEs, including WebStorm, via a plugin
- Atom via the PHP-twig for atom
- Emacs via web-mode.el
- Notepad++ via the Notepad++ Twig Highlighter
- Sublime Text via the Twig bundle
- TextMate via the Twig bundle
- Vim via the Jinja syntax plugin or the vim-twig plugin
- Brackets via Brackets Twig
- Visual Studio Code via the Twig extension
- GTKSourceView via the Twig language definition
- Coda via the Twig syntax mode
- Coda 2 via the other Twig syntax mode
- SubEthaEdit via the Twig syntax mode
Syntax
Twig defines three kinds of delimiters:- *
, to assign. - *
... : condition. - *
... : counter in a loop.
To create an iterative array:
An associative array:
Operators precedence
The operators precedence is, from the less to more priority:| Operator | Role |
| or | Or |
| xor | Xor |
| and | And |
| b-or | Bitwise OR |
| b-xor | Bitwise XOR |
| b-and | Bitwise AND |
| Is equal? | |
| != | Is different? |
| < | Inferior |
| > | Superior |
| >= | Superior or equal |
| <= | Inferior or equal |
| in | Into |
| matches | Corresponds |
| starts with | Begins by |
| ends with | Finishes by |
| .. | Sequence |
| + | Plus |
| - | Less |
| ~ | Concatenation |
| * | Multiplication |
| / | Division |
| // | Division rounded to lower |
| % | Modulo |
| is | Test |
| ** | Power |
| Filter | |
| Array entry | |
| . | Attribute or method from an object |
Filters
The filters provide some treatments on an expression, when placed after it, separated by pipes. For example:capitalize: changes a string's first letter to capital.upper: changes a whole string to capital.first: displays the first line of an array.length: returns a variable size.Special variables
loop contains the current loop information. For example loop.index corresponds to the number of iterations which have already occurred.- The global variables begin with underscores. For example:
- * _route
- * _self
- :So, to the a page route:
- The CGI environment variables, such as
Example
The example below demonstrates some basic features of Twig.Real world usage
Twig has become a widely adopted templating engine in the PHP ecosystem. It is the default templating language for the Symfony framework and is also integrated into several content management systems and applications, including:- Drupal adopted Twig as its default template engine starting from version 8, replacing PHPTemplate.
- CraftCMS uses Twig as its sole templating language, allowing developers to create highly customised front-end experiences.
- eZ Platform integrates Twig for rendering templates within its content management system.
- Bolt CMS uses Twig for theming and front-end rendering.
- ShopWired uses Twig for theming and front-end rendering.