在 Symfony 项目中使用 Twig 时,最规范的方式是通过继承 Twig\Extension\AbstractExtension 创建自定义扩展类,在 getFunctions() 中注册 TwigFunction 实例,再将其作为服务自动或手动注册,最后直接在模板中调用函数名即可。

在 Symfony 项目中使用 Twig 时,若想在模板里调用自定义逻辑(比如格式化时间、生成 URL、处理字符串等),最规范的方式是通过 Twig 扩展(Twig\Extension\AbstractExtension)注册自定义函数。这不是简单写个 PHP 函数就能用,而是要让 Twig “认识”它。
创建一个 Twig 扩展类
在 src/Twig/ 目录下新建一个扩展类(如 App\Twig\MyCustomExtension.php),继承 AbstractExtension,并重写 getFunctions() 方法:
- 每个自定义函数需包装为
Twig\TwigFunction实例 - 第一个参数是模板中调用的函数名(如
'price'),第二个是对应的 PHP 回调(可以是静态方法、闭包或 [‘ClassName’, ‘methodName’] 数组) - 支持可选配置,例如
is_safe(防 XSS)、needs_environment(是否需要访问 Twig Environment)
示例:添加一个 price 函数,把数字转成带 ¥ 符号和千分位的字符串:
namespace App\Twig;
<p>use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;</p><p>class MyCustomExtension extends AbstractExtension
{
public function getFunctions(): array
{
return [
new TwigFunction('price', [$this, 'formatPrice']),
];
}</p><pre class='brush:php;toolbar:false;'>public function formatPrice(float $amount): string
{
return '¥' . number_format($amount, 2, '.', ',');
}}
注册为服务并启用自动发现
Symfony 默认启用 Twig 扩展的自动注册(只要类实现 Twig\Extension\ExtensionInterface 或继承 AbstractExtension,且位于 src/Twig/ 下)。确保 config/packages/twig.yaml 中有:
twig:
# ...
paths: ['%kernel.project_dir%/templates']
# 自动加载 src/Twig/ 下的扩展(Symfony 5.4+ 默认开启)
如果未生效,可手动在 config/services.yaml 中显式注册:
services:
App\Twig\MyCustomExtension:
tags: [{ name: 'twig.extension' }]
在模板中使用自定义函数
定义好后,无需任何引入操作,直接在 Twig 模板中调用即可:
{{ price(1999.99) }} {# 输出:¥1,999.99 #}
{{ price(product.price) }} {# 假设 product.price = 89.5 #}
注意:
- 函数名区分大小写
- 参数传递与普通 PHP 函数一致,支持默认值、类型提示(PHP 7.1+)和可变参数
- 若函数需访问 Twig 环境(如渲染子模板),设置 needs_environment: true 并在方法签名中声明 Environment $env
进阶技巧:带选项的函数 & 安全输出
比如想让 truncate 支持自定义省略符和是否保留 HTML:
new TwigFunction('truncate', [$this, 'truncateText'], [
'is_safe' => ['html'], // 告诉 Twig 返回内容已转义或可信,可直接输出
'needs_environment' => true,
]),
对应方法中可使用 $env->getFilter('striptags') 或调用 $env->render() 等。
不复杂但容易忽略的是:函数必须返回字符串或可转换为字符串的值;若返回数组或对象,Twig 会报错 —— 需提前处理好数据形态。


















