plugins.md

Using Kirby Twig with other plugins

Kirby Modules and Kirby Patterns

Using Twig templates with the Patterns or Modules plugins requires a few steps.

First, you should declare Twig namespaces for the patterns and modules folders in your config:

c::set('twig.namespace.modules', dirname(__DIR__) . '/modules');
c::set('twig.namespace.patterns', dirname(__DIR__) . '/patterns');

Now let’s say you’re using the Patterns plugin. You could have a file structure like this:

site/
    patterns/
        mypattern/
            mypattern.html.php
            mypattern.html.twig

In the mypattern.html.php script, use the twig() helper function:

echo twig('@patterns/mypattern/mypattern.html.twig');

The Twig template will have access to the kirby, site and page variables, and to any variable defined in the page’s controller. But if you defined other variables for your Module or Pattern, they won’t be automatically passed to the Twig template. Two solutions:

<?php
// 1. Explicitly pass variables to the Twig template
$data = compact('myVar', 'myOtherVar');
echo twig('@patterns/mypattern/mypattern.html.twig', $data);

// 2. Nuclear option: pass everything in the current scope
echo twig('@patterns/mypattern/mypattern.html.twig', get_defined_vars());

Using Twig in plugin code

If you’re developing a Kirby plugin to share it with the Kirby community, it’s not a great idea to make it rely on kirby-twig; you should provide PHP templates or snippets.

For project-specific plugins, though, if your project is using Twig, you might want to keep your plugin-related templates and snippets in your plugin’s folder. Here are a few config tricks that might help.

<?php
// site/myplugin/myplugin.php

/**
 * Add a Twig namespace for our plugin's templates
 * Allows including with {% include '@myplugin/mytemplate.twig' %}
 */
c::set('twig.namespace.myplugin', __DIR__ . '/templates');

/**
 * Expose functions from our plugin to the Twig environment
 */
c::set('twig.function.myPluginHelper', 'myPluginHelper');
c::set('twig.function.myOtherHelper', 'myOtherHelper');

See “Using your own functions in templates” for more details about exposing functions, static methods and classes to templates.