ApplicationTrait::onInit()

[brandonkelly]

Description

Adds a new onInit() method to craft\base\ApplicationTrait, which can be used to simplify initialization code for plugins and modules.

It accepts a callback function that contains code that shouldn’t be executed until the app (including all installed plugins) is fully initialized, such as rendering a Twig template, executing an element query, etc.

If Craft is already initialized, the callback function will be called immediately. Otherwise it will be called on EVENT_INIT.

class Plugin extends \craft\base\Plugin
{
    public function init(): void
    {
        // Defer most setup tasks until Craft is fully initialized
        Craft::$app->onInit(function() {
            // ...
        });
    }

    // ...
}

Related issues

• Clarify Craft intialisation order for modules/plugins #9671
• Add methods or guidelines for plugin developers to avoid conflicts/loading order issues #3028