如何在Craft CMS 3版本中添加自定义Twig函数？

嘿，我刚好在Craft CMS 3里折腾过自定义Twig函数，给你捋捋具体步骤——毕竟Twig官方的通用方法直接套在Craft里不太适用，得贴合它的插件/模块架构来：

1. 优先通过自定义插件实现（推荐） #

Craft的扩展机制最好通过插件来实现，这样核心更新不会覆盖你的自定义代码。如果还没有插件，可以用Craft自带的命令快速生成：

./craft plugin/create

跟着终端提示输入插件名称、开发者信息等就行，它会帮你生成基础的插件结构。

2. 在插件主类中注册Twig函数 #

找到插件目录下的src/Plugin.php文件，在init()方法里添加Twig扩展的注册代码——Craft会在系统初始化时调用这个方法，刚好适合我们注入自定义函数：

<?php

namespace yournamespace\yourplugin;

use Craft;
use craft\base\Plugin;
use Twig\Extension\AbstractExtension;
use Twig\TwigFunction;

class YourPlugin extends Plugin
{
    public function init()
    {
        parent::init();

        // 注册自定义Twig扩展
        Craft::$app->view->registerTwigExtension(new class extends AbstractExtension {
            // 定义要添加的Twig函数
            public function getFunctions()
            {
                return [
                    new TwigFunction('myCustomFunction', function($greeting, $name) {
                        // 这里写你的函数逻辑，比如处理参数并返回结果
                        return "{$greeting}, {$name}! 这是我的第一个Craft自定义Twig函数～";
                    }),
                ];
            }
        });
    }
}

3. 在Twig模板中使用自定义函数 #

现在你可以在任意Craft模板里直接调用这个函数了：

{{ myCustomFunction('Hello', 'Craft开发者') }}

渲染后会输出：Hello, Craft开发者! 这是我的第一个Craft自定义Twig函数～

额外小贴士 #

• 如果你的函数需要调用Craft的服务（比如查询条目、获取用户信息），直接在回调里用Craft::$app->xxx即可，比如：

  new TwigFunction('getEntryTitle', function($entryId) {
      $entry = Craft::$app->entries->getEntryById($entryId);
      return $entry ? $entry->title : '条目不存在';
  })
  

• 要是函数逻辑比较复杂，建议把逻辑抽成插件类的单独方法，让代码更易维护：

  // 在插件类中定义逻辑方法
  private function getEntryTitleLogic(int $entryId): string
  {
      $entry = Craft::$app->entries->getEntryById($entryId);
      return $entry ? $entry->title : '条目不存在';
  }
  
  // 在init()里注册时关联这个方法
  public function init()
  {
      parent::init();
  
      $plugin = $this;
      Craft::$app->view->registerTwigExtension(new class($plugin) extends AbstractExtension {
          private $plugin;
  
          public function __construct($plugin)
          {
              $this->plugin = $plugin;
          }
  
          public function getFunctions()
          {
              return [
                  new TwigFunction('getEntryTitle', [$this->plugin, 'getEntryTitleLogic']),
              ];
          }
      });
  }
  

内容的提问来源于stack exchange，提问作者Tim Arney