2023-02-06 10:40:00 +01:00
|
|
|
# {include}
|
2021-12-03 11:59:22 +01:00
|
|
|
|
|
|
|
|
`{include}` tags are used for including other templates in the current
|
|
|
|
|
template. Any variables available in the current template are also
|
|
|
|
|
available within the included template.
|
|
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
## Attributes
|
|
|
|
|
|
|
|
|
|
| Attribute Name | Required | Description |
|
|
|
|
|
|----------------|----------|--------------------------------------------------------------------------------------------|
|
|
|
|
|
| file | Yes | The name of the template file to include |
|
|
|
|
|
| assign | No | The name of the variable that the output of include will be assigned to |
|
|
|
|
|
| cache_lifetime | No | Enable caching of this subtemplate with an individual cache lifetime |
|
|
|
|
|
| compile_id | No | Compile this subtemplate with an individual compile_id |
|
|
|
|
|
| cache_id | No | Enable caching of this subtemplate with an individual cache_id |
|
|
|
|
|
| scope | No | Define the scope of all in the subtemplate assigned variables: 'parent','root' or 'global' |
|
|
|
|
|
| \[var \...\] | No | variable to pass local to template |
|
|
|
|
|
|
|
|
|
|
|
2021-12-03 11:59:22 +01:00
|
|
|
- The `{include}` tag must have the `file` attribute which contains
|
|
|
|
|
the template resource path.
|
|
|
|
|
|
|
|
|
|
- Setting the optional `assign` attribute specifies the template
|
|
|
|
|
variable that the output of `{include}` is assigned to, instead of
|
2023-02-06 10:40:00 +01:00
|
|
|
being displayed. Similar to [`{assign}`](./language-function-assign.md).
|
2021-12-03 11:59:22 +01:00
|
|
|
|
|
|
|
|
- Variables can be passed to included templates as
|
2023-02-06 10:40:00 +01:00
|
|
|
[attributes](../language-basic-syntax/language-syntax-attributes.md). Any variables explicitly
|
2021-12-03 11:59:22 +01:00
|
|
|
passed to an included template are only available within the scope
|
|
|
|
|
of the included file. Attribute variables override current template
|
|
|
|
|
variables, in the case when they are named the same.
|
|
|
|
|
|
|
|
|
|
- You can use all variables from the including template inside the
|
|
|
|
|
included template. But changes to variables or new created variables
|
|
|
|
|
inside the included template have local scope and are not visible
|
|
|
|
|
inside the including template after the `{include}` statement. This
|
|
|
|
|
default behaviour can be changed for all variables assigned in the
|
|
|
|
|
included template by using the scope attribute at the `{include}`
|
|
|
|
|
statement or for individual variables by using the scope attribute
|
2023-02-06 10:40:00 +01:00
|
|
|
at the [`{assign}`](./language-function-assign.md) statement. The later
|
2021-12-03 11:59:22 +01:00
|
|
|
is useful to return values from the included template to the
|
|
|
|
|
including template.
|
|
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
- Use the syntax for [template resources](../../programmers/resources.md) to `{include}`
|
|
|
|
|
files outside of the [`$template_dir`](../../programmers/api-variables/variable-template-dir.md)
|
2021-12-03 11:59:22 +01:00
|
|
|
directory.
|
|
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
## Option Flags
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
| Name | Description |
|
|
|
|
|
|---------|--------------------------------------------------------------------------------------|
|
|
|
|
|
| nocache | Disables caching of this subtemplate |
|
|
|
|
|
| caching | Enable caching of this subtemplate |
|
|
|
|
|
| inline | If set, merge the compile-code of the subtemplate into the compiled calling template |
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
## Examples
|
|
|
|
|
```smarty
|
|
|
|
|
<html>
|
2021-12-03 11:59:22 +01:00
|
|
|
<head>
|
|
|
|
|
<title>{$title}</title>
|
|
|
|
|
</head>
|
|
|
|
|
<body>
|
|
|
|
|
{include file='page_header.tpl'}
|
|
|
|
|
|
|
|
|
|
{* body of template goes here, the $tpl_name variable
|
|
|
|
|
is replaced with a value eg 'contact.tpl'
|
|
|
|
|
*}
|
|
|
|
|
{include file="$tpl_name.tpl"}
|
|
|
|
|
|
|
|
|
|
{* using shortform file attribute *}
|
|
|
|
|
{include 'page_footer.tpl'}
|
|
|
|
|
</body>
|
2023-02-06 10:40:00 +01:00
|
|
|
</html>
|
|
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```smarty
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
{include 'links.tpl' title='Newest links' links=$link_array}
|
|
|
|
|
{* body of template goes here *}
|
|
|
|
|
{include 'footer.tpl' foo='bar'}
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
|
|
|
|
|
The template above includes the example `links.tpl` below
|
|
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```smarty
|
|
|
|
|
<div id="box">
|
2021-12-03 11:59:22 +01:00
|
|
|
<h3>{$title}{/h3>
|
|
|
|
|
<ul>
|
2023-02-06 10:40:00 +01:00
|
|
|
{foreach from=$links item=l}
|
|
|
|
|
.. do stuff ...
|
|
|
|
|
</foreach}
|
2021-12-03 11:59:22 +01:00
|
|
|
</ul>
|
2023-02-06 10:40:00 +01:00
|
|
|
</div>
|
|
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
Variables assigned in the included template will be seen in the
|
|
|
|
|
including template.
|
|
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```smarty
|
|
|
|
|
{include 'sub_template.tpl' scope=parent}
|
|
|
|
|
...
|
|
|
|
|
{* display variables assigned in sub_template *}
|
|
|
|
|
{$foo}<br>
|
|
|
|
|
{$bar}<br>
|
|
|
|
|
...
|
|
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
|
|
|
|
|
The template above includes the example `sub_template.tpl` below
|
|
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```smarty
|
|
|
|
|
...
|
|
|
|
|
{assign var=foo value='something'}
|
|
|
|
|
{assign var=bar value='value'}
|
|
|
|
|
...
|
|
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
|
|
|
|
|
The included template will not be cached.
|
|
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```smarty
|
|
|
|
|
{include 'sub_template.tpl' nocache}
|
|
|
|
|
...
|
|
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
|
|
|
|
|
In this example included template will be cached with an individual
|
|
|
|
|
cache lifetime of 500 seconds.
|
|
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```smarty
|
|
|
|
|
{include 'sub_template.tpl' cache_lifetime=500}
|
|
|
|
|
...
|
|
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
|
|
|
|
|
In this example included template will be cached independent of the
|
2022-10-22 22:08:38 +02:00
|
|
|
global caching setting.
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```smarty
|
|
|
|
|
{include 'sub_template.tpl' caching}
|
|
|
|
|
...
|
|
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
|
|
|
|
|
This example assigns the contents of `nav.tpl` to the `$navbar`
|
|
|
|
|
variable, which is then output at both the top and bottom of the page.
|
|
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```smarty
|
|
|
|
|
<body>
|
|
|
|
|
{include 'nav.tpl' assign=navbar}
|
|
|
|
|
{include 'header.tpl' title='Smarty is cool'}
|
|
|
|
|
{$navbar}
|
|
|
|
|
{* body of template goes here *}
|
|
|
|
|
{$navbar}
|
|
|
|
|
{include 'footer.tpl'}
|
|
|
|
|
</body>
|
|
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
|
|
|
|
|
This example includes another template relative to the directory of the
|
|
|
|
|
current template.
|
|
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```smarty
|
|
|
|
|
{include 'template-in-a-template_dir-directory.tpl'}
|
|
|
|
|
{include './template-in-same-directory.tpl'}
|
|
|
|
|
{include '../template-in-parent-directory.tpl'}
|
|
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
```smarty
|
|
|
|
|
{* absolute filepath *}
|
|
|
|
|
{include file='/usr/local/include/templates/header.tpl'}
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
{* absolute filepath (same thing) *}
|
|
|
|
|
{include file='file:/usr/local/include/templates/header.tpl'}
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
{* windows absolute filepath (MUST use "file:" prefix) *}
|
|
|
|
|
{include file='file:C:/www/pub/templates/header.tpl'}
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
{* include from template resource named "db" *}
|
|
|
|
|
{include file='db:header.tpl'}
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
{* include a $variable template - eg $module = 'contacts' *}
|
|
|
|
|
{include file="$module.tpl"}
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
{* wont work as its single quotes ie no variable substitution *}
|
|
|
|
|
{include file='$module.tpl'}
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
{* include a multi $variable template - eg amber/links.view.tpl *}
|
|
|
|
|
{include file="$style_dir/$module.$view.tpl"}
|
|
|
|
|
```
|
2021-12-03 11:59:22 +01:00
|
|
|
|
2023-02-06 10:40:00 +01:00
|
|
|
See also [template resources](../../programmers/resources.md) and
|
|
|
|
|
[componentized templates](../../appendixes/tips.md#componentized-templates).
|
