Functions

In addition to the template functions that Twig comes with, Craft provides a few of its own:

actionInput( actionPath )

A shortcut for outputting a hidden input used to route a POST request to a particular controller and action. This is effectively the same as writing <input type="hidden" name="action" value="controller/action-name"> directly into a template.

<form method="POST">
    {{ actionInput('users/save-user') }}
    <!-- ... -->
</form>

alias( string )

Passes a string through Craft::getAlias(), which will check if the string begins with an alias. (See Configuration for more info.)

<img src="{{ alias('@assetBaseUrl/images/logo.png') }}">

beginBody()

Outputs any scripts and styles that were registered for the “begin body” position. It should be placed right after your <body> tag.

<body>
    {{ beginBody() }}

    <h1>{{ page.name }}</h1>
    {{ page.body }}
</body>

ceil( num )

Rounds a number up.

{{ ceil(42.1) }} → 43

className( object )

Returns the fully qualified class name of a given object.

clone( object )

Clones a given object.

{% set query = craft.entries.section('news') %}
{% set articles = clone(query).type('articles') %}

create( type )

Creates a new object instance based on a given class name or object configuration. See Yii::createObject() for a full explanation of supported arguments.

{# Pass in a class name #}
{% set cookie = create('yii\\web\\Cookie') %}

{# Or a full object configuration array #}
{% set cookie = create({
    class: 'yii\\web\\cookie',
    name: 'foo',
    value: 'bar'
}) %}

csrfInput()

Returns a hidden CSRF Token input. All sites that have CSRF Protection enabled must include this in each form that submits via POST.

<form method="post">
    {{ csrfInput() }}
    <!-- ... -->
</form>

endBody()

Outputs any scripts and styles that were registered for the “end body” position. It should be placed right before your </body> tag.

<body>
    <h1>{{ page.name }}</h1>
    {{ page.body }}

    {{ endBody() }}
</body>

expression( expression, params, config )

Creates and returns a new yii\db\Expression object, for use in database queries.

floor( num )

Rounds a number down.

{{ floor(42.9) }} → 42

getenv( name )

Returns the value of an environment variable.

{{ getenv('MAPS_API_KEY') }}

parseEnv( str )

Checks if a string references an environment variable ($VARIABLE_NAME) and/or an alias (@aliasName), and returns the referenced value.

Outputs any scripts and styles that were registered for the “head” position. It should be placed right before your </head> tag.

<head>
    <title>{{ siteName }}</title>
    {{ head() }}
</head>

plugin( handle )

Returns a plugin instance by its handle, or null if no plugin is installed and enabled with that handle.

{{ plugin('commerce').version }}

redirectInput( url )

Shortcut for typing <input type="hidden" name="redirect" value="{{ url|hash }}">.

seq( name, length, next )

Outputs the next or current number in a sequence, defined by name:

<p>This entry has been read {{ seq('hits:' ~ entry.id) }} times.</p>

Each time the function is called, the given sequence will be automatically incremented.

You can optionally have the number be zero-padded to a certain length.

{{ now|date('Y') ~ '-' ~ seq('orderNumber:' ~ now|date('Y'), 5) }}
{# outputs: 2018-00001 #}

To view the current number in the sequence without incrementing it, set the next argument to false.

<h5><a href="{{ entry.url }}">{{ entry.title }}</a></h5>
<p>{{ seq('hits:' ~ entry.id, next=false) }} views</p>

shuffle( array )

Randomizes the order of the elements within an array.

{% set promos = shuffle(homepage.promos) %}

{% for promo in promos %}
    <div class="promo {{ promo.slug }}">
        <h3>{{ promo.title }}</h3>
        <p>{{ promo.description }}</p>
        <a class="cta" href="{{ promo.ctaUrl }}">{{ promo.ctaLabel }}</a>
    </div>
{% endfor %}

siteUrl( path, params, scheme, siteId )

Similar to url(), except only for creating URLs to pages on your site.

<a href="{{ siteUrl('company/contact') }}">Contact Us</a>

Arguments

The siteUrl() function has the following arguments:

  • path – The path that the resulting URL should point to on your site. It will be appended to your base site URL.
  • params – Any query string parameters that should be appended to the URL. This can be either a string (e.g. 'foo=1&bar=2') or an object (e.g. {foo:'1', bar:'2'}).
  • scheme – Which scheme the URL should use ('http' or 'https'). The default value depends on whether the current request is served over SSL or not. If not, then the scheme in your Site URL will be used; if so, then https will be used.
  • siteId – The ID of the site that the URL should point to. By default the current site will be used.

svg( svg, sanitize, namespace, class )

Outputs an SVG document.

You can pass the following things into it:

  • An SVG file path.

    {{ svg('@webroot/icons/lemon.svg') }}
    
  • A craft\elements\Asset object, such as one pulled in from an Assets field.

    {% set image = entry.myAssetsField.one() %}
    {% if image and image.extension == 'svg' %}
      {{ svg(image) }}
    {% endif %}
    
  • Raw SVG markup.

    {% set image = include('_includes/icons/lemon.svg') %}
    {{ svg(image) }}
    

By default, if you pass an asset or raw markup into the function, the SVG will be sanitized of potentially malicious scripts using svg-sanitizer, and any IDs or class names within the document will be namespaced so they don’t conflict with other IDs or class names in the DOM. You can disable those behaviors using the sanitize and namespace arguments:

{{ svg(image, sanitize=false, namespace=false) }}

You can also specify a custom class name that should be added to the root <svg> node using the class argument:

{{ svg('@webroot/icons/lemon.svg', class='lemon-icon') }}

url( path, params, scheme, mustShowScriptName )

Returns a URL.

<a href="{{ url('company/contact') }}">Contact Us</a>

Arguments

The url() function has the following arguments:

  • path – The path that the resulting URL should point to on your site. It will be appended to your base site URL.
  • params – Any query string parameters that should be appended to the URL. This can be either a string (e.g. 'foo=1&bar=2') or an object (e.g. {foo:'1', bar:'2'}).
  • scheme – Which scheme the URL should use ('http' or 'https'). The default value depends on whether the current request is served over SSL or not. If not, then the scheme in your Site URL will be used; if so, then https will be used.
  • mustShowScriptName – If this is set to true, then the URL returned will include “index.php”, disregarding the omitScriptNameInUrls config setting. (This can be useful if the URL will be used by POST requests over Ajax, where the URL will not be shown in the browser’s address bar, and you want to avoid a possible collision with your site’s .htaccess file redirect.)

TIP

You can use the url() function for appending query string parameters and/or enforcing a scheme on an absolute URL:

{{ url('http://my-project.com', 'foo=1', 'https') }}
{# Outputs: "https://my-project.com?foo=1" #}