What is the difference between use
and include
in Twig?
Documentation:
include
The
include
statement includes a template and returns the rendered content of that template into the current one:{% include 'header.html' %} Body here... {% include 'footer.html' %}
use
The
use
statement tells Twig to import the blocks defined inblocks.html
into the current template (it's like macros, but for blocks):blocks.html
{% block sidebar %}{% endblock %}
main.html
{% extends "base.html" %} {% use "blocks.html" %} {% block title %}{% endblock %} {% block content %}{% endblock %}
Possible answer:
I think this should explain the difference:
include
is to get all the code from an external file and import it into your actual file at the right location of the call.
use
is completely different as it parses the linked file to find a particular section of code and then overwrites the blocks with the same name, in your current file, with the one found in this external file.
include
is like "go find this file and render it with my page here".
use
is "parse this other file to find block definitions to use instead of my owns defined here".If
use
command finds nothing matching the task, nothing is displayed at all from this file.
Question
is the explanation correct? are there any other explanations to this difference?
thanks
After months, I am posting an answer for any further reference to this question. I also added some description for
extends
&import
¯o
&embed
for more clearance:There are various types of inheritance and code reuse in Twig:
Include
The main goal is code reuse. Consider using
header.html.twig
&footer.html.twig
insidebase.html.twig
as an example.header.html.twig
base.html.twig
Extends
The main goal is vertical inheritance. Consider extending
base.html.twig
insidehomepage.html.twig
andabout.html.twig
as an example.base.html.twig
homepage.html.twig
about.html.twig
Use
The main goal is horizontal reuse. Consider using
sidebar.html.twig
insidesingle.product.html.twig
(extendsproduct.layout.html.twig
) andsingle.service.html.twig
(extendsservice.layout.html.page
) pages. (it's like macros, but for blocks)sidebar.html.twig
single.product.html.twig
single.service.html.twig
Macro
The main goal is having reusable markup across many templates with variables. Consider a function which gets some variables and outputs some markup.
form.html.twig
profile.service.html.twig
Embed
The main goal is block overriding. It has functionality of both
Use
&Include
together. Consider embeddingpagination.html.twig
inproduct.table.html.twig
&service.table.html.twig
.pagination.html.twig
product.table.html.twig
service.table.html.twig
Please note that embedded file (
pagination.html.twig
here) has access to the current context (min
,max
variables here). Also you may pass extra variables to the embedded file:pagination.html.twig
product.table.html.twig