Skip to content

Twig Extensions#

Date extension#

time_ago filter#

This filter allows you to display relative text to a given date (Datetime or string). It will use the current locale by default, but you can force another locale as parameter.

{{ some_datetime_object|time_ago }} {# eg. "3 days ago" #}
{{ '2021-12-12'|time_ago('fr') }} {# eg. "Il y a 5 minutes" #}

Gravatar extension#

gravatar filter#

Get either a Gravatar URL or complete image tag for a specified email address.

{{ 'contact@email.com'|gravatar }} {# will output an image HTML tag with the Gravatar related to the given email address #}

QrCode extension#

Info

The QrCode extension was introduced in 4.4.

get_qr_code_from_string function#

Retrieve a QR code base64 string from a given string to be able to render it.

It requires you to have the endroid/qr-code package installed in your application. If it is not installed, a clear error message should be displayed when using the function.

Usage

<img src="{{ get_qr_code_from_string('My text to include in the QR code') }}" alt="QR code">
Arguments
Name Description Required Default value
qrCodeContent Text to encode in the QR code. Yes N/A
size Image size. No 200
margin The margin to apply in the image. No 0

Site extension#

Page title helper#

There are three functions available that help build a page title:

  • prepend_page_title('text to prepend')
  • append_page_title('text to append')
  • page_title('Base title', separator = ' - ')

Usage

{% do prepend_page_title('Demo') %}
{% do append_page_title('Dashboard') %}
{% do append_page_title('Home') %}

<head>
    {# Would render "Demo - ACME Website - Dashboard - Home" #}
    <title>{{ page_title('ACME Website') }}</title>
</head>

Meta description helper#

There are two functions available to generate the meta description:

  • set_meta_description('text')
  • meta_description('default description')

Usage

{% do set_meta_description('Basic description') %}

<head>
    {# Would render "Basic description" as it's defined before, "Default description" is `set_meta_description` was not called earlier #}
    <meta name="description" content="{{ meta_description('Default description') }}">
</head>

Meta keywords helper#

There are two functions available helping you build meta keywords:

  • add_meta_keywords(['array', 'of', 'keywords'])
  • meta_keywords(['default', 'keywords'])

It will trim & display unique keywords only.

Usage

{% do add_meta_keywords(['some', 'keywords']) %}
{% do add_meta_keywords(['other', 'keywords']) %}

<head>
    {# Would render "default,keywords,some,other" #}
    <meta name="keywords" content="{{ meta_keywords(['default', 'keywords']) }}">
</head>

false test#

A simple test to assert if a variable is false.

Usage

{% if myVar is false %}

Text extension#

camelize filter#

{{ 'Some.text.is.now.camelized.'|camelize }} {# will output "Some_Text_Is_Now_Camelized." #}

safe_truncate filter#

Returns truncated text without breaking HTML tags.

Parameters:

  • length (int, default 30)
  • preserve (bool, default true) to preserve full words
  • separator (string, default ...)
{{ 'Lorem <strong class="super" style="display: none;">ipsum dolor sit</strong> amet'|safe_truncate(16) }}
{# will output "Lorem <strong class="super" style="display: none;">ipsum...</strong>" #}

More extensions#

More filters & functions exist but are not documented yet. You can find them in the following files:

PRs welcome :)