plugin に Twig 関数を追加

\user\plugins\hello\hello.php に以下のように修正

  • 55行目
    'onTwigInitialized' => ['onTwigInitialized', 0] のように、起動するべイベントを登録
  • 58~68行目
    関数の追加と実施に処理を行うコードを記述
    処理結果は、67行目の用に、return で戻すことでレンダリング結果に反映されるようになります。

基本的に、Twig の標準的な書き方と同じなので、Twig の説明サイトを見ると、より深く理解できることもあると思います。

<?php
namespace Grav\Plugin;

use Composer\Autoload\ClassLoader;
use Grav\Common\Plugin;

/**
 * Class HelloPlugin
 * @package Grav\Plugin
 */
class HelloPlugin extends Plugin
{
    /**
     * @return array
     *
     * The getSubscribedEvents() gives the core a list of events
     *     that the plugin wants to listen to. The key of each
     *     array section is the event that the plugin listens to
     *     and the value (in the form of an array) contains the
     *     callable (or function) as well as the priority. The
     *     higher the number the higher the priority.
     */
    public static function getSubscribedEvents(): array
    {
        return [
            'onPluginsInitialized' => [
                // Uncomment following line when plugin requires Grav < 1.7
                // ['autoload', 100000],
                ['onPluginsInitialized', 0]
            ]
        ];
    }

    /**
     * Composer autoload
     *
     * @return ClassLoader
     */
    public function autoload(): ClassLoader
    {
        return require __DIR__ . '/vendor/autoload.php';
    }

    /**
     * Initialize the plugin
     */
    public function onPluginsInitialized(): void
    {
        // Don't proceed if we are in the admin plugin
        if ($this->isAdmin()) {
            return;
        }
        // Enable the main events we are interested in
        $this->enable([
            'onTwigInitialized' => ['onTwigInitialized', 0]
        ]);
    }
    public function onTwigInitialized()
    {
        $this->grav['twig']->twig()->addFunction(
            new \Twig_SimpleFunction('hello', [$this, 'hello']),
        );
    }

    public function hello()
    {       
        return 'hello';
    }

}

Twig テンプレートか、ページ内に以下のコードを書くことで hello が表示されます。

{{ hello() }}