Here are a few common tasks you might do in your templates, as they would be written in ExpressionEngine vs. Craft CMS.
- Comments
- Conditionals
- Loops
- Looping Through Entries
- Single-Entry Pages
- Looping Through Matrix Rows
- Looping Through Assets
- Template Inheritance
- Template Includes
- Stuff You Can Only Do in Craft
- Other Resources
Let’s start simple! Both CMSes support comment tags, enabling you to make notes in the template code that never make it to the browser.
{!-- You can’t see me! --}
{# You can’t see me! #}
Resources:
{if something == 'value'}
...
{if:elseif something_else == 'other_value'}
...
{if:else}
...
{/if}
{% if something == 'value' %}
...
{% elseif somethingElse == 'otherValue' %}
...
{% else %}
...
{% endif %}
Resources:
EE loops are always done with tag pairs, named after what we’re looping through.
{exp:channel:entries channel="news"}
{matrix_field}
...
{/matrix_field}
{/exp:channel:entries}
Looping through things in Craft is always done with a for-loop, where you pass in what you want to loop through, as well as what you want to call each item within the loop.
{% for entry in craft.entries.section('news') %}
{% for block in entry.matrixField %}
...
{% endfor %}
{% endfor %}
There are pros and cons to both ways: EE’s is arguably more elegant for simple things, but you can quickly run into tag name conflicts and other gotchas when dealing with more complex templates with nested loops. That’s never an issue with Craft.
Both CMSes have various tags that are available within the loops, as well:
Thing | ExpressionEngine | Craft |
---|---|---|
How many items? | {total_results} | {{ loop.length }} |
1-based index | {count} | {{ loop.index }} |
0-based index | - | {{ loop.index0 }} |
Number of items left | - | {{ loop.revindex0 }} |
Number of ites left, inc. this one | - | {{ loop.revindex }} |
First item? | {if count == 1} | {% if loop.first %} |
Last item? | {if count == total_results} | {% if loop.last %} |
Odd? | {if count % 2 == 1} | {% if loop.index is odd %} |
Even? | {if count % 2 == 0} | {% if loop.index is even %} |
Cycle through values for each item | {switch='odd|even'} | {{ cycle(['odd','even'], loop.index0) }} |
The parent loop’s index | - | {{ loop.parent.loop.index }} |
Resources:
ExpressionEngine’s {exp:channel:entries}
tag is optimized for this task. Just tell it which channel, how many, and so on. (And don’t forget dynamic="no"
on single-entry pages!)
{exp:channel:entries channel="news" limit="10"}
<h2><a href="{path='news/{url_title}'}">{title}</a></h2>
<p>{summary}</p>
{/exp:channel:entries}
In Craft you grab the entries using
craft.entries and loop through them with
a for-loop. You get to choose a variable name that
each entry is going to be set to. In this case we’re going with newsEntry
so it’s clear which
‘title’ we’re outputting, etc..
{% for newsEntry in craft.entries.section('news').limit(10) %}
<h2><a href="{{ newsEntry.url }}">{{ newsEntry.title }}</a></h2>
<p>{{ newsEntry.summary }}</p>
{% endfor %}
Resources:
On templates EE thinks are for displaying a single entry, {exp:channel:entries}
will only return that one entry by default – based on a URL Title match with the second URI segment.
{exp:channel:entries channel="news"}
<h1>{title}</h1>
{body}
{/exp:channel:entries}
Entries in Craft can have explicit URLs, so when one of those URLs is requested, Craft can confidently know which entry you’re trying to access, and which template it should load. In the process it will pass an entry
variable, pre-set to the entry you’re accessing. (Note that in this case the entry
variable name is not customizable.)
<h1>{{ entry.title }}</h1>
{{ entry.body }}
Resources:
Matrix follows the standard EE fieldtype convention of parsing a tag pair based on the field’s short name:
{matrix_field}
{column_one}
{column_two}
{/matrix_field}
As with looping through entries, we loop through Matrix blocks using a for-loop.
{% for block in entry.matrixField %}
{{ block.fieldOne }}
{{ block.fieldTwo }}
{% endfor %}
If you have multiple block types, you can add conditionals for them:
{% for block in entry.matrixField %}
{% if block.type == "text" %}
{{ block.textField }}
{% elseif block.type == "quote" %}
<blockquote>{{ block.quoteField }}</blockquote>
<p>– {{ block.authorField }}</p>
{% endif %}
{% endfor %}
Resources:
Like Matrix/EE, Assets uses a tag pair based on the field’s short name:
{assets_field}
<img src="{url:image_manipulation_name}" alt="{title}"> {filename}
{/assets_field}
Like entries and Matrix fields in Craft, we once again use the for-loop to loop through assets:
{% for asset in entry.assetsField %}
<img src="{{ asset.url('transformHandle') }}" alt="{{ asset.title }}"> {{ asset.filename }}
{% endfor %}
Resources:
EE 2.8 introduced Template Layouts, which makes it possible for templates to extend other templates, via the {layout=}
tag:
<html>
<head>
<title>{layout:title}</title>
</head>
<body>
{layout:contents}
<p class="copyright">
© {current_time format='%Y'} {site_name}
</p>
</body>
</html>
{layout="site/.site-layout"}
{layout:set name="title" value="News"}
{exp:channel:entries channel="news"}
<h2>{title}</h2>
{summary}
{/exp:channel:entries}
The same is also possible in Twig:
<html>
<head>
<title>{{ title }}</title>
</head>
<body>
{% block body %}
Default content
{% endblock %}
<p class="copyright">
© {{ now | date('Y') }} {{ siteName }}
</p>
</body>
</html>
{% extends "_site_layout" %}
{% set title = "News" %}
{% block body %}
<h1>News</h1>
...
{% endblock %}
There is one key difference between EE and Twig here: In Twig, if a template extends another, all of its HTML output must be placed within {% block %}...{% endblock %}
tags. If the template attepmts to output anything outside of block tags, Twig will complain about it. Whereas in EE, all of the HTML that is output gets sucked into a single “block” called contents
, which is output in the layout template with {layout:contents}
.
Resources:
You can include other templates in EE using the {embed}
tag, passing any variables you want available to the embedded template as parameters:
{embed="includes/_photo_gallery" entry_id="{entry_id}"}
{exp:channel:entries entry_id="{embed:entry_id}" dynamic="no"}
<div class="gallery">
{assets_field}
<img src="{url:manipulation_name}">
{/assets_field}
</div>
{/exp:channel:entries}
Twig has a similar tag, called {% include %}
.
Unlike {embed}
, all variables that are already defined in the template leading up to the
{% include %}
tag will automatically be available to the included template.
{% include "_includes/photo_gallery" %}
<div class="gallery">
{% for photo in entry.assetsField %}
<img src="{{ photo.url('transformHandle') }}">
{% endfor %}
</div>
Note how entry
was already available to _includes/photo_gallery, since it was presumably already
defined by the parent template.
You also have the option to pass additional variables to the included template that weren’t already defined in the parent. In the above example, we might not want the include template to worry about the entry variable’s name, and just be passed the array of images directly. We could do do that with this syntax:
{% include "_includes/photo_gallery" with {
photos: entry.assetsField
} %}
<div class="gallery">
{% for photo in photos %}
<img src="{{ photo.url('transformHandle') }}">
{% endfor %}
</div>
Now the include template is expecting to be passed a photos
variable, and it’s up to whoever’s
including it to ensure that photos
is set properly. Thanks to that with
parameter, we can do
that without having to make a photos
variable available to the parent template.
Twig also has an {% embed %}
tag, which you can think of as a more dynamic version of {% include %}
. In addition to including a template into the parent template, it also allows the parent template to override aspects of the included template, using {% block %}
tags.
Here’s a simple example, where a photo gallery include template allows its parent templates to override a header area:
{% embed "_includes/photo_gallery" %}
{% block header %}
<h3>The Best Photo Gallery</h3>
{% endblock %}
{% endembed %}
{% block header %}
<h3>Photo Gallery</h3>
{% endblock %}
<div class="gallery">
{% for photo in entry.assetsField %}
<img src="{{ photo.url('transformHandle') }}">
{% endfor %}
</div>
Resources:
All of the above examples have been focused on things that are relatively easy to do in both EE and Craft. But thanks to Twig, there are a ton of things you can easily do in Craft that aren’t even possible in EE out of the box.
You’re not stuck with a limited set of variable tags in Craft. Thanks to Twig, you can define new variables right in your templates, manipulate them, and output them as you see fit.
{% set title = "About Us" %}
<html>
<head>
<title>{{ title }} - {{ siteName }}</title>
</head>
<body>
<h1>{{ title | upper }}</h1>
</body>
</html>
Resources:
All sorts of advanced math operations are possible in Twig thanks to its rich support of mathematical operators
You can concatenate strings, modify them, split them into arrays, or pretty much anything else you can think of.
{% if currentUser %}
{% set greeting = "Hello, " ~ currentUser.name %}
{% else %}
{% set greeting = "Nice to meet you." %}
{% endif %}
{% set totalWords = greeting | split(' ') | length %}
{% set greeting = greeting ~ ' (That was '~totalWords~' words!)' %}
{# Output the greeting in all caps #}
{{ greeting | upper }}
Resources:
You aren’t limited to creating simple numbers and strings. You can even create full-blown arrays:
{% set nav = [
{ uri: '', title: 'Home' },
{ uri: 'about', title: 'About' },
{ uri: 'products', title: 'Products' },
{ uri: 'blog', title: 'Blog' }
] %}
<nav>
<ul>
{% for item in nav %}
{% set sel = (craft.request.path == item.uri) %}
<li><a {{ sel ? 'class="sel"' }} href="{{ url(item.uri) }}">{{ item.title }}</a></li>
{% endfor %}
</ul>
</nav>
There’s also a shorthand syntax for creating arrays of consecutive numbers:
<select name="cc_exp_year">
{% for year in now.year .. now.year+10 %}
<option>{{ year }}</option>
{% endfor %}
</select>
If you want to learn more, here are a few helpful templating resources:
- Twig for Template Designers – the official Twig documentation
- Twig Templates in Craft – Video course by Mijingo
- Control Flow in Twig – Video course by Mijingo
- Twig’s core tags
- Twig’s core filters
- Twig’s core functions
- Craft-added tags
- Craft-added filters
- Craft-added functions
- Global template variables in Craft
this should be on the craft docs yeah?