Twig Template Naming Conventions

Twig Template naming conventions
Last updated on
15 November 2017
Drupal loads templates based on certain naming conventions. This allows you to override
templates by adding them to your theme and giving them specific names.
After adding a template you must rebuild the cache in order for Drupal to discover your new
template.
You can debug Twig templates to figure out which templates are being used to output the
markup for any given element. More about Twig debugging here.
This page lists the conventions used for the base html structure, the page, regions, blocks,
nodes, fields, and other core components. (It's good to know that it is possible to create
custom template name suggestions using function hook_theme_suggestions_HOOK_alter.)
HTML (<head> template)

The HTML template provides markup for the basic structure of the HTML-page including the
<head>, <title> and <body> tags.
Base template: html.html.twig (base location: core/modules/system/templates/html.html.twig)
The following are some examples of how you may override the base template:
1. html--internalviewpath.html.twig
2. html--node--id.html.twig
3. html.html.twig
See the html.html.twig API documentation.
Page template
Pattern: page--[front|internal/path].html.twig
Base template: page.html.twig (base location: core/modules/system/templates/page.html.twig)
The suggestions are numerous. The front page takes precedence. The rest is based on the
internal path of the current page. The front page can be set at "Administration >
Configuration > System > Site information." (http://example.com/admin/config/system/site-
information). The front page template is page--front.html.twig.
Do not confuse the internal path with path aliases, which are not accounted for.
The list of suggested template files is in order of specificity based on internal paths. One
suggestion is made for every element of the current path, though numeric elements are not
carried to subsequent suggestions. For example, "http://www.example.com/node/1/edit"
would result in the following suggestions:
1. page--node--edit.html.twig
2. page--node--1.html.twig
3. page--node.html.twig
4. page.html.twig
5. page--path.html.twig (if your page path is {"http://example.com/path"})
See the page.html.twig API documentation. Also see below for the maintenance page
template.
Regions
Pattern: region--[region].html.twig
Base template: region.html.twig (base location:
core/modules/system/templates/region.html.twig)
The region template is used when a page region has content, either from the Block system or a
function like hook_page_build(). Possible region names are determined by the theme's
.info.yml file.
See the region.html.twig API documentation.
Blocks
Pattern: block--[module|-delta].html.twig
Base template: block.html.twig (base location: core/modules/block/templates/block.html.twig)
1. block--module-delta.html.twig
2. block--module.html.twig
3. block.html.twig
"module" being the name of the module and "delta", the internal id assigned to the block by
the module.
For example, "block--block--1.html.twig" would be used for the first user-submitted block
added from the block administration screen since it was created by the block module with the
id of 1. Region-specific block templates are not available in Drupal 8.
If you had a block created by a custom module called "custom" and a delta of "my-block", the
theme hook suggestion would be called "block--custom--my-block.html.twig."
Also one more example with Views, if you have a block created by views with a view name
"front_news" and display id "block_1" then the theme hook suggestion would be: block--
views-block--front-news-block-1.html.twig (notice, when you have underscores in a display id
or in a view name - you have to transform them in to a single dash)
Be aware that module names are case sensitive in this context. For instance if your module is
called 'MyModule', the most general theme hook suggestion for this module would be "block-
-MyModule.html.twig."
See the block.html.twig API documentation.
Nodes
Pattern: node--[type|nodeid]--[viewmode].html.twig
Base template: node.html.twig (base location: core/modules/node/templates/node.html.twig)
Theme hook suggestions are made based on these factors, listed from the most specific
template to the least. Drupal will use the most specific template it finds:
1. node--nodeid--viewmode.html.twig
2. node--nodeid.html.twig
3. node--type--viewmode.html.twig
4. node--type.html.twig
5. node--viewmode.html.twig
6. node.html.twig
Note that underscores in a content type's machine name are replaced by hyphens.
See the node.html.twig API documentation.
Taxonomy terms
Pattern: taxonomy-term--[vocabulary-machine-name|tid].html.twig
Base template: taxonomy-term.html.twig (base location:
core/modules/taxonomy/templates/taxonomy-term.html.twig)
1. taxonomy-term--tid.html.twig
2. taxonomy-term--vocabulary-machine-name.html.twig
3. taxonomy-term.html.twig
Note that underscores in a vocabulary's machine name are replaced by hyphens.
See the taxonomy-term.html.twig API documentation.
Fields
Pattern: field--[type|name[--content-type]|content-type].html.twig
Base template: field.html.twig (base location: core/modules/system/templates/field.html.twig)
1. field--node--field-name--content-type.html.twig
2. field--node--content-type.html.twig
3. field--node--field-name.html.twig
4. field--field-type.html.twig
5. field.html.twig
Note that underscores in a Field's machine name are replaced by hyphens. Also remember to
include "field-" in custom field names, e.g: field--field-phone.html.twig.
See the field.html.twig API documentation.
Comments
Pattern: comment--node-[type].html.twig
Base template: comment.html.twig (base location:
core/modules/comment/template/comment.html.twig)
Support was added to create comment--node-type.html.twig files, to format comments of a

certain node type differently than other comments in the site. For example, a comment made
on an article-type node would be "comment--node-article.html.twig".
See the comment.html.twig API documentation.
Comment wrappers
Pattern: comment-wrapper--node-[type].html.twig
Base template: comment-wrapper.html.twig
Similar to the above but for the wrapper template.
Forums
Pattern: forums--[[container|topic]--forumID].html.twig
Base template: forums.html.twig (base location:
core/modules/forum/templates/forums.html.twig)
For forum containers:
1. forums--containers--forumID.html.twig
2. forums--forumID.html.twig
3. forums--containers.html.twig
4. forums.html.twig
For forum topics:
1. forums--topics--forumID.html.twig
2. forums--forumID.html.twig
3. forums--topics.html.twig
4. forums.html.twig
See the API documentation for forums.html.twig.
Maintenance page
Pattern: maintenance-page--[offline].html.twig
Base template: maintenance-page.html.twig (base location:
core/modules/system/templates/maintenance-page.html.twig)
This applies when the database fails. Useful for presenting a friendlier page without error
messages. Theming the maintenance page must be properly setup first.
See the maintenance-page.html.twig API documentation.
Please note that the maintenance-page--offline.html.twig file is currently not rendering when
the database is unavailable. Issue being tracked: #2720109: "Theming" page--maintenance--
offline - fatal errors.
Search result
Pattern: search-result--[searchType].html.twig
Base template: search-result.html.twig (base location: core/modules/search/templates/search-
result.html.twig)
search-result.html.twig is the default wrapper for individual search results. Depending on type
of search different suggestions are made. For example,
"example.com/search/node/Search+Term" would result in "search-result--node.html.twig"
being used. Compare that with "example.com/search/user/bob" resulting in "search-result--
user.html.twig". Modules can extend search types adding more suggestions of their type.

Twig Template Naming Conventions

Uploaded by

Copyright:

Available Formats

Twig Template Naming Conventions

Uploaded by

Document Information

Original Description:

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Twig Template Naming Conventions

Uploaded by

Copyright:

Available Formats

Twig Template naming conventions

HTML (<head> template)

Base template: html.html.twig (base location: core/modules/system/templates/html.html.twig)

See the html.html.twig API documentation.

See the region.html.twig API documentation.

See the node.html.twig API documentation.

Note that underscores in a vocabulary's machine name are replaced by hyphens.

See the taxonomy-term.html.twig API documentation.

See the field.html.twig API documentation.

Support was added to create comment--node-type.html.twig files, to format comments of a

See the comment.html.twig API documentation.

Similar to the above but for the wrapper template.

For forum containers:

For forum topics:

See the maintenance-page.html.twig API documentation.

You might also like