Symfony Twig Extensions

3.1 version

edit this page

Symfony Twig Extensions¶

Twig is the default template engine for Symfony. By itself, it already contains a lot of built-in functions, filters, tags and tests (learn more about them from the Twig Reference).

Symfony adds custom extensions on top of Twig to integrate some components into the Twig templates. The following sections describe the custom functions, filters, tags and tests that are available when using the Symfony Core Framework.

There may also be tags in bundles you use that aren't listed here.

Functions¶

render¶

{{ render(uri, options = []) }}

uri: type: string | ControllerReference
options (optional): type: array default: []

Renders the fragment for the given controller (using the controller function) or URI. For more information, see How to Embed Controllers in a Template.

The render strategy can be specified in the strategy key of the options.

Tip

The URI can be generated by other functions, like path and url.

render_esi¶

{{ render_esi(uri, options = []) }}

uri: type: string | ControllerReference
options (optional): type: array default: []

Generates an ESI tag when possible or falls back to the behavior of render function instead. For more information, see How to Embed Controllers in a Template.

Tip

The URI can be generated by other functions, like path and url.

Tip

The render_esi() function is an example of the shortcut functions of render. It automatically sets the strategy based on what's given in the function name, e.g. render_hinclude() will use the hinclude.js strategy. This works for all render_*() functions.

controller¶

{{ controller(controller, attributes = [], query = []) }}

controller: type: string
attributes (optional): type: array default: []
query (optional): type: array default: []

Returns an instance of ControllerReference to be used with functions like render() and render_esi().

asset¶

{{ asset(path, packageName = null) }}

path: type: string
packageName (optional): type: string | null default: null

Returns a public path to path, which takes into account the base path set for the package and the URL path. More information in Linking to Assets. For asset versioning, see version.

assets_version¶

{{ assets_version(packageName = null) }}

packageName (optional): type: string | null default: null

Returns the current version of the package, more information in Linking to Assets.

form¶

{{ form(view, variables = []) }}

view: type: FormView
variables (optional): type: array default: []

Renders the HTML of a complete form, more information in the Twig Form reference.

form_start¶

{{ form_start(view, variables = []) }}

view: type: FormView
variables (optional): type: array default: []

Renders the HTML start tag of a form, more information in the Twig Form reference.

form_end¶

{{ form_end(view, variables = []) }}

view: type: FormView
variables (optional): type: array default: []

Renders the HTML end tag of a form together with all fields that have not been rendered yet, more information in the Twig Form reference.

form_errors¶

{{ form_errors(view) }}

view: type: FormView

Renders any errors for the given field or the global errors, more information in the Twig Form reference.

form_label¶

{{ form_label(view, label = null, variables = []) }}

view: type: FormView
label (optional): type: string default: null
variables (optional): type: array default: []

Renders the label for the given field, more information in the Twig Form reference.

form_row¶

{{ form_row(view, variables = []) }}

view: type: FormView
variables (optional): type: array default: []

Renders the row (the field's label, errors and widget) of the given field, more information in the Twig Form reference.

form_rest¶

{{ form_rest(view, variables = []) }}

view: type: FormView
variables (optional): type: array default: []

Renders all fields that have not yet been rendered, more information in the Twig Form reference.

csrf_token¶

{{ csrf_token(intention) }}

intention: type: string

Renders a CSRF token. Use this function if you want CSRF protection without creating a form.

is_granted¶

{{ is_granted(role, object = null, field = null) }}

role: type: string
object (optional): type: object
field (optional): type: string

Returns true if the current user has the required role. Optionally, an object can be pasted to be used by the voter. More information can be found in Access Control in Templates.

Note

You can also pass in the field to use ACE for a specific field. Read more about this in Scope of Access Control Entries.

logout_path¶

{{ logout_path(key = null) }}

key (optional): type: string

Generates a relative logout URL for the given firewall. If no key is provided, the URL is generated for the current firewall the user is logged into.

logout_url¶

{{ logout_url(key = null) }}

key (optional): type: string

Equal to the logout_path function, but it'll generate an absolute URL instead of a relative one.

path¶

{{ path(name, parameters = [], relative = false) }}

name: type: string
parameters (optional): type: array default: []
relative (optional): type: boolean default: false

Returns the relative URL (without the scheme and host) for the given route. If relative is enabled, it'll create a path relative to the current path. More information in Linking to Pages.

url¶

{{ url(name, parameters = [], schemeRelative = false) }}

name: type: string
parameters (optional): type: array default: []
schemeRelative (optional): type: boolean default: false

Returns the absolute URL (with scheme and host) for the given route. If schemeRelative is enabled, it'll create a scheme-relative URL. More information in Linking to Pages.

absolute_url¶

{{ absolute_url(path) }}

path: type: string

Returns the absolute URL from the passed relative path. For example, assume you're on the following page in your app: http://example.com/products/hover-board.

{{ absolute_url('/human.txt') }}
{# http://example.com/human.txt #}

{{ absolute_url('products_icon.png') }}
{# http://example.com/products/products_icon.png #}

relative_path¶

{{ relative_path(path) }}

path: type: string

Returns the relative path from the passed absolute URL. For example, assume you're on the following page in your app: http://example.com/products/hover-board.

{{ relative_path('http://example.com/human.txt') }}
{# ../human.txt #}

{{ relative_path('http://example.com/products/products_icon.png') }}
{# products_icon.png #}

expression¶

Creates an Expression in Twig. See "Template Expressions".

Filters¶

humanize¶

{{ text|humanize }}

text: type: string

Makes a technical name human readable (i.e. replaces underscores by spaces or transforms camelCase text like helloWorld to hello world and then capitalizes the string).

trans¶

{{ message|trans(arguments = [], domain = null, locale = null) }}

message: type: string
arguments (optional): type: array default: []
domain (optional): type: string default: null
locale (optional): type: string default: null

Translates the text into the current language. More information in Translation Filters.

transchoice¶

{{ message|transchoice(count, arguments = [], domain = null, locale = null) }}

message: type: string
count: type: integer
arguments (optional): type: array default: []
domain (optional): type: string default: null
locale (optional): type: string default: null

Translates the text with pluralization support. More information in Translation Filters.

yaml_encode¶

{{ input|yaml_encode(inline = 0, dumpObjects = false) }}

input: type: mixed
inline (optional): type: integer default: 0
dumpObjects (optional): type: boolean default: false

Transforms the input into YAML syntax. See Objects for Mappings for more information.

yaml_dump¶

{{ value|yaml_dump(inline = 0, dumpObjects = false) }}

value: type: mixed
inline (optional): type: integer default: 0
dumpObjects (optional): type: boolean default: false

Does the same as yaml_encode(), but includes the type in the output.

abbr_class¶

{{ class|abbr_class }}

class: type: string

Generates an <abbr> element with the short name of a PHP class (the FQCN will be shown in a tooltip when a user hovers over the element).

abbr_method¶

{{ method|abbr_method }}

method: type: string

Generates an <abbr> element using the FQCN::method() syntax. If method is Closure, Closure will be used instead and if method doesn't have a class name, it's shown as a function (method()).

format_args¶

{{ args|format_args }}

args: type: array

Generates a string with the arguments and their types (within <em> elements).

format_args_as_text¶

{{ args|format_args_as_text }}

args: type: array

Equal to the format_args filter, but without using HTML tags.

file_excerpt¶

{{ file|file_excerpt(line = null) }}

file: type: string
line (optional): type: integer

Generates an excerpt of seven lines around the given line.

format_file¶

{{ file|format_file(line, text = null) }}

file: type: string
line: type: integer
text (optional): type: string default: null

Generates the file path inside an <a> element. If the path is inside the kernel root directory, the kernel root directory path is replaced by kernel.root_dir (showing the full path in a tooltip on hover).

format_file_from_text¶

{{ text|format_file_from_text }}

text: type: string

Uses format_file to improve the output of default PHP errors.

file_link¶

{{ file|file_link(line = null) }}

line (optional): type: integer

Generates a link to the provided file (and optionally line number) using a preconfigured scheme.

Tags¶

form_theme¶

{% form_theme form resources %}

form: type: FormView
resources: type: array | string

Sets the resources to override the form theme for the given form view instance. You can use _self as resources to set it to the current resource. More information in How to Customize Form Rendering.

trans¶

{% trans with vars from domain into locale %}{% endtrans %}

vars (optional): type: array default: []
domain (optional): type: string default: string
locale (optional): type: string default: string

Renders the translation of the content. More information in Twig Templates.

transchoice¶

{% transchoice count with vars from domain into locale %}{% endtranschoice %}

count: type: integer
vars (optional): type: array default: []
domain (optional): type: string default: null
locale (optional): type: string default: null

Renders the translation of the content with pluralization support, more information in Twig Templates.

trans_default_domain¶

{% trans_default_domain domain %}

domain: type: string

This will set the default domain in the current template.

stopwatch¶

{% stopwatch 'name' %}...{% endstopwatch %}

This will time the run time of the code inside it and put that on the timeline of the WebProfilerBundle.

Tests¶

selectedchoice¶

{% if choice is selectedchoice(selectedValue) %}

choice: type: ChoiceView
selectedValue: type: string

Checks if selectedValue was checked for the provided choice field. Using this test is the most effective way.

Global Variables¶

app¶

The app variable is available everywhere and gives access to many commonly needed objects and values. It is an instance of GlobalVariables.

The available attributes are:

app.user
app.request
app.session
app.environment
app.debug

Symfony Standard Edition Extensions¶

The Symfony Standard Edition adds some bundles to the Symfony Core Framework. Those bundles can have other Twig extensions:

Twig Extensions includes some interesting extensions that do not belong to the Twig core. You can read more in the official Twig Extensions documentation.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

Table of Contents

Symfony Twig Extensions

Symfony Twig Extensions¶

Functions¶

render¶

render_esi¶

controller¶

asset¶

assets_version¶

form¶

form_start¶

form_end¶

form_widget¶

form_errors¶

form_label¶

form_row¶

form_rest¶

csrf_token¶

is_granted¶

logout_path¶

logout_url¶

path¶

url¶

absolute_url¶

relative_path¶

expression¶

Filters¶

humanize¶

trans¶

transchoice¶

yaml_encode¶

yaml_dump¶

abbr_class¶

abbr_method¶

format_args¶

format_args_as_text¶

file_excerpt¶

format_file¶

format_file_from_text¶

file_link¶

Tags¶

form_theme¶

trans¶

transchoice¶

trans_default_domain¶

stopwatch¶

Tests¶

selectedchoice¶

Global Variables¶

app¶

Symfony Standard Edition Extensions¶