e544ed6d9a
Comparing changes: https://github.com/smarty-php/smarty/compare/v4.3.1...v4.4.1 It is noticeable that Smarty 4.3.1 does not officially support PHP 8.3. Is only supported with 4.4.0. Remark: During tests with Smarty 4.5.1, it was noticed that the following warning occurs: Deprecated: Using the unregistered function "function_exists" in a template is deprecated and will be removed in a future version. Use Smarty::registerPlugin to explicitly register a custom modifier. As of Smarty 5.X.X, templates must be revised again. The Smarty release 5.0.2 is already officially available. However, integration into FlatPress is not entirely trivial.
82 lines
2.8 KiB
Markdown
82 lines
2.8 KiB
Markdown
# {capture}
|
|
|
|
`{capture}` is used to collect the output of the template between the
|
|
tags into a variable instead of displaying it. Any content between
|
|
`{capture name='foo'}` and `{/capture}` is collected into the variable
|
|
specified in the `name` attribute.
|
|
|
|
The captured content can be used in the template from the variable
|
|
[`$smarty.capture.foo`](../language-variables/language-variables-smarty.md#smartycapture-languagevariablessmartycapture) where "foo"
|
|
is the value passed in the `name` attribute. If you do not supply the
|
|
`name` attribute, then "default" will be used as the name ie
|
|
`$smarty.capture.default`.
|
|
|
|
`{capture}'s` can be nested.
|
|
|
|
## Attributes
|
|
|
|
| Attribute Name | Required | Description |
|
|
|----------------|----------|----------------------------------------------------------------------|
|
|
| name | Yes | The name of the captured block |
|
|
| assign | No | The variable name where to assign the captured output to |
|
|
| append | No | The name of an array variable where to append the captured output to |
|
|
|
|
## Option Flags
|
|
|
|
| Name | Description |
|
|
|---------|-----------------------------------------|
|
|
| nocache | Disables caching of this captured block |
|
|
|
|
> **Note**
|
|
>
|
|
> Be careful when capturing [`{insert}`](#language.function.insert)
|
|
> output. If you have [`$caching`](#caching) enabled and you have
|
|
> [`{insert}`](#language.function.insert) commands that you expect to
|
|
> run within cached content, do not capture this content.
|
|
|
|
## Examples
|
|
|
|
```smarty
|
|
{* we don't want to print a div tag unless content is displayed *}
|
|
{capture name="banner"}
|
|
{capture "banner"} {* short-hand *}
|
|
{include file="get_banner.tpl"}
|
|
{/capture}
|
|
|
|
{if $smarty.capture.banner ne ""}
|
|
<div id="banner">{$smarty.capture.banner}</div>
|
|
{/if}
|
|
```
|
|
|
|
This example demonstrates the capture function.
|
|
```smarty
|
|
|
|
{capture name=some_content assign=popText}
|
|
{capture some_content assign=popText} {* short-hand *}
|
|
The server is {$my_server_name|upper} at {$my_server_addr}<br>
|
|
Your ip is {$my_ip}.
|
|
{/capture}
|
|
<a href="#">{$popText}</a>
|
|
```
|
|
|
|
|
|
This example also demonstrates how multiple calls of capture can be used
|
|
to create an array with captured content.
|
|
|
|
```smarty
|
|
{capture append="foo"}hello{/capture}I say just {capture append="foo"}world{/capture}
|
|
{foreach $foo as $text}{$text} {/foreach}
|
|
```
|
|
|
|
The above example will output:
|
|
|
|
```
|
|
I say just hello world
|
|
```
|
|
|
|
|
|
See also [`$smarty.capture`](../language-variables/language-variables-smarty.md#smartycapture-languagevariablessmartycapture),
|
|
[`{eval}`](../language-custom-functions/language-function-eval.md),
|
|
[`{fetch}`](../language-custom-functions/language-function-fetch.md), [`fetch()`](../../programmers/api-functions/api-fetch.md) and
|
|
[`{assign}`](./language-function-assign.md).
|