\n\nFunctions can be called to generate content. Functions are called by their name followed by parentheses (
\n()) and may have arguments.
Creates a valid URL for a page, a menu entry, an asset, a page ID or a path.
\n{{ url(value, {options}) }}| Option | \nDescription | \nType | \nDefault | \n
|---|---|---|---|
| canonical | \nPrefix URL with baseurl or use canonical.url if exists. | \nboolean | \nfalse | \n
| format | \nDefines page output format (e.g.: json). | \nstring | \nhtml | \n
| language | \nDefines page language (e.g.: fr). | \nstring | \nnull | \n
Examples:
\n{# page #}\n{{ url(page) }}\n{{ url(page, {canonical: true}) }}\n{{ url(page, {format: json}) }}\n{{ url(page, {language: fr}) }}\n{# menu entry #}\n{{ url(site.menus.main.about) }}\n{# asset #}\n{{ url(asset('styles.css')) }}\n{# page ID #}\n{{ url('page-id') }}\n{# path #}\n{{ url('about-me/') }}\n{{ url('tags/' ~ tag) }}Creates an HTML element from an asset (or an array of assets with custom attributes).
\n{{ html(asset, {attributes}, {options}) }}\n{# dedicated functions for each common type of asset #}\n{{ css(asset) }}\n{{ js(asset) }}\n{{ image(asset) }}\n{{ audio(asset) }}\n{{ video(asset) }}| Option | \nDescription | \nType | \n
|---|---|---|
| attributes | \nAdds name=\"value\" couple to the HTML element. | \narray | \n
| options | \n{preload: boolean}: preloads.For images: {formats: array}: adds alternative formats.{responsive: bool|string}: adds responsive images (based on width or pixels density).{placeholder: string}: fills the image background before loading (color or lqip). | \narray | \n
Examples:
\n{# CSS with an attribute #}\n{{ html(asset('print.css'), {media: 'print'}) }}\n{# CSS with an attribute and an option #}\n{{ html(asset('styles.css'), {title: 'Main theme'}, {preload: true}) }}\n{# Array of assets with media query #}\n{{ html([\n {asset: asset('css/style.css')},\n {asset: asset('css/style-dark.css'), attributes: {media: '(prefers-color-scheme: dark)'}}\n]) }}\n{# JavaScript #}\n{{ html(asset('script.js')) }}\n{# image without specific attributes nor options #}\n{{ html(asset('image.png')) }}\n{# image with specific attributes, responsive images and alternative formats #}\n{{ html(asset('image.jpg'), {alt: 'Description', loading: 'lazy'}, {responsive: true, formats: ['avif', 'webp']}) }}\n{# image with responsive pixels density images #}\n{{ html(asset('image.jpg'), options={responsive: 'density'}, attributes={width: 256}) }}\n{# image with a Low-Quality Image Placeholder #}\n{{ html(asset('image.jpg'), {alt: 'Description', loading: 'lazy'}, {placeholder: 'lqip'}) }}\n{# Audio #}\n{{ html(asset('audio.mp3')) }}\n{# Video #}\n{{ html(asset('video.mp4')) }}Determines read time of a text, in minutes.
\n{{ readtime(value) }}Example:
\n{{ readtime(page.content) }} minCalculates the hash of an object, an array or a string with a given algorithm.
\n{{ hash(value, algorithm) }}algorithm can be any algorithm supported by PHP's hash() function (e.g.: md5, sha256, etc.). Default is xxh128.
Example:
\n{{ hash('my string', 'sha256') }}Calculates a cache key for fragments cache based on a name and an optional value.
\n{% cache cache_key(name, value) %}\n {# cacheable content #}\n{% endcache %}The function adds a hash of the value (could be a string, an array or an object) to the name (and the current language and build ID to be sure the generated cache key is unique) so if the value is changed the cache key is changed too and the cache is automatically cleared.
\nGets the value of an environment variable from its key.
\n{{ getenv(var) }}Example:
\n{{ getenv('VAR') }}The dump function dumps information about a template variable. This is mostly useful to debug a template that does not behave as expected by introspecting its variables:
{{ dump(user) }}The d() function is the HTML version of dump() and use the Symfony VarDumper Component behind the scenes.
{{ d(variable, {theme: light}) }}Sorting collections (of pages, menus or taxonomies).
\nSorts a collection by title (with natural sort).
\n{{ collection|sort_by_title }}Example:
\n{{ site.pages|sort_by_title }}Sorts a collection by date (most recent first).
\n{{ collection|sort_by_date(variable='date', desc_title=false) }}Example:
\n{# sort by date #}\n{{ site.pages|sort_by_date }}\n{# sort by updated variable instead of date #}\n{{ site.pages|sort_by_date(variable='updated') }}\n{# sort items with the same date by desc title #}\n{{ site.pages|sort_by_date(desc_title=true) }}\n{# reverse sort #}\n{{ site.pages|sort_by_date|reverse }}Sorts a collection by weight (lighter first).
\n{{ collection|sort_by_weight }}Example:
\n{{ site.menus.main|sort_by_weight }}For more complex cases, you should use Twig’s native sort.
Example:
\n{% set files = site.static|sort((a, b) => a.date|date('U') < b.date|date('U')) %}Variables can be modified by filters. Filters are separated from the variable by a pipe symbol (|). Multiple filters can be chained. The output of one filter is applied to the next.
{{ page.title|truncate(25)|capitalize }}Filters a pages collection by variable name/value.
\n{{ collection|filter_by(variable, value) }}Example:
\n{{ pages|filter_by('section', 'blog') }}For more complex cases, you should use Twig’s native filter.
Example:
\n{% pages|filter(p => p.virtual == false and p.id not in ['page-1', 'page-2']) %}Converts a Markdown string to HTML.
\n{{ markdown|markdown_to_html }}{% apply markdown_to_html %}\n{# Markdown here #}\n{% endapply %}Examples:
\n{% set markdown = '**This is bold text**' %}\n{{ markdown|markdown_to_html }}{% apply markdown_to_html %}\n**This is bold text**\n{% endapply %}Extracts only headings matching the given selectors (h2, h3, etc.), or those defined in config pages.body.toc if not specified.
\nThe format parameter defines the output format: html or json.
\nThe url parameter is used to build links to headings.
{{ markdown|toc(format, selectors, url) }}Examples:
\n{{ page.body|toc }}\n{{ page.body|toc('html') }}\n{{ page.body|toc(selectors=['h2']) }}\n{{ page.body|toc(url=url(page)) }}Converts a JSON string to an array.
\n{{ json|json_decode }}Example:
\n{% set json = '{\"foo\": \"bar\"}' %}\n{% set array = json|json_decode %}\n{{ array.foo }}Converts a YAML string to an array.
\n{{ yaml|yaml_parse }}Example:
\n{% set yaml = 'key: value' %}\n{% set array = yaml|yaml_parse %}\n{{ array.key }}Converts a string to a slug.
\n{{ string|slugify }}The u filter wraps a text in a Unicode object (a Symfony UnicodeString instance) that exposes methods to \"manipulate\" the string.
Example:
\n{{ 'cecil_string with twig'|u.camel.title }}\n\nCecilStringWithTwig
\n
The singular filter transforms a given noun in its plural form into its singular version.
{{ string|singular(locale)}}Example:
\n{# English (en) rules are used by default #}\n{{ 'partitions'|singular }}\n\npartition
\n
{{ 'partitions'|singular('fr') }}\n\npartition
\n
The plural filter transforms a given noun in its singular form into its plural version.
{{ string|plural(locale)}}Example:
\n{# English (en) rules are used by default #}\n{{ 'animal'|plural }}\n\nanimals
\n
{{ 'animal'|plural('fr') }}\n\nanimaux
\n
Truncates a string and appends suffix.
\n{{ string|excerpt(length, suffix) }}| Option | \nDescription | \nType | \nDefault | \n
|---|---|---|---|
| length | \nTruncates after this number of characters. | \ninteger | \n450 | \n
| suffix | \nAppends characters. | \nstring | \n… | \n
Examples:
\n{{ variable|excerpt }}\n{{ variable|excerpt(250, '...') }}Reads characters before or after <!-- excerpt --> or <!-- break --> tag.
\nSee Content documentation for details.
{{ string|excerpt_html({separator, capture}) }}| Option | \nDescription | \nType | \nDefault | \n
|---|---|---|---|
| separator | \nString to use as separator. | \nstring | \nexcerpt|break | \n
| capture | \nPart to capture, before or after the separator. | \nstring | \nbefore | \n
Examples:
\n{{ variable|excerpt_html }}\n{{ variable|excerpt_html({separator: 'excerpt|break', capture: 'before'}) }}\n{{ variable|excerpt_html({capture: 'after'}) }}Highlights a code string with highlight.php.
\n{{ code|highlight(language) }}Examples:
\n{{ '<?php echo $highlighted->value; ?>'|highlight('php') }}Splits a string into an array using a regular expression.
\n{{ string|preg_split(pattern, limit) }}Example:
\n{% set headers = page.content|preg_split('/<br[^>]*>/') %}Performs a regular expression match and return the group for all matches.
\n{{ string|preg_match_all(pattern, group) }}Example:
\n{% set tags = page.content|preg_match_all('/<[^>]+>(.*)<\\/[^>]+>/') %}Converts a hexadecimal color to RGB.
\n{{ color|hex_to_rgb }}