View Decorators

View Decorators allow your application to modify the HTML output during the rendering process. This happens just prior to being cached, and allows you to apply custom functionality to your views.

Creating Decorators

Creating your own view decorators requires creating a new class that implements CodeIgniter\Views\ViewDecoratorInterface. This requires a single method that takes the generated HTML string, performs any modifications on it, and returns the resulting HTML.

<?php

namespace App\Views\Decorators;

use CodeIgniter\Views\ViewDecoratorInterface;

class MyDecorator implements ViewDecoratorInterface
{
    public static function decorate(string $html): string
    {
        // Modify the output here

        return $html;
    }
}

Once created, the class must be registered in app/Config/View.php:

<?php

namespace Config;

use CodeIgniter\Config\View as BaseView;

class View extends BaseView
{
    public array $decorators = [
        'App\Views\Decorators\MyDecorator',
    ];

    // ...
}

Now that it’s registered the decorator will be called for every view that is rendered or parsed. Decorators are called in the order specified in this configuration setting.