Unable to find the template

Question

I know this question has been asked multiple times. I have read all the post on this topic, and craft's docs. But still, I haven't figure out what I'm doing wrong. I would really appreciate a hand here!

I'm using Craft 3.7, and I am trying to render a template file, which is called from my module's twig extension.

I have this:

The template file is in

modules/abc/passwordglobal/src/templates/_formTemplate.twig

In app.php:

'modules' => [
        'password-global' => abc\passwordglobal\PasswordGlobal::class,
    ],
    'bootstrap' => ['password-global']

And in my twig extension file, I have a function with this code:

// ... returns html template;
$oldMode = \Craft::$app->view->getTemplateMode();
\Craft::$app->view->setTemplateMode(View::TEMPLATE_MODE_CP);
$html = \Craft::$app->view->renderTemplate('password-global/templates/_formTemplate');
\Craft::$app->view->setTemplateMode($oldMode);

return $html;

And the error I see:

Twig Template Loading Error – craft\web\twig\TemplateLoaderException

Unable to find the template “password-global/templates/_formTemplate”.

Thank you so much.

Answer 1

You need to define the template root (password-global) in your main module file. This is a gotcha when working on site-specific modules instead of plugins – plugins get a template root based on their ID automatically, but modules don't.

Use View::EVENT_REGISTER_CP_TEMPLATE_ROOTS to define your template root:

use yii\base\Event;
use craft\web\View;
use craft\events\RegisterTemplateRootsEvent;

// put this inside the init() method
Event::on(
    View::class,
    View::EVENT_REGISTER_CP_TEMPLATE_ROOTS,
    function (RegisterTemplateRootsEvent $e) {
        $e->roots[$this->id] = __DIR__ . '/src/templates';
    }
);

See Template Roots for more information.

---

Small sidenote, you don't need to manually keep track of and restore the old template mode afterwards. If you pass a template mode as the third argument to View::renderTemplate, it only applies to this function call:

return \Craft::$app->view->renderTemplate(
    'password-global/_formTemplate',
    [],
    \craft\web\View::TEMPLATE_MODE_CP,
);

Answer 2

For future reference, this is what solved my issue: On main class' init() function -- note the DIRECTORY_SEPARATOR part:

Event::on(
            View::class, 
            View::EVENT_REGISTER_SITE_TEMPLATE_ROOTS, 
            function (RegisterTemplateRootsEvent $e) {
            if (is_dir($baseDir = $this->getBasePath() . DIRECTORY_SEPARATOR . 'templates')) {
                $e->roots[$this->id] = $baseDir;
                }
            }
        );

This is registering this path:

/app/modules/abc/passwordglobal/src/templates

And in my twig extension function, there's no need to add the TEMPLATE_MODE_SITE parameter:

 $html = \Craft::$app->view->renderTemplate(
                'password-global/_formTemplate');