Blocks methods

Blocks methods are registered with the blocksMethods extension.

Default blocks methods

For a full list of default blocks methods, please check out the Reference.

Getting started

You can extend the set of defined blocks methods very easily in a plugin file.

Kirby::plugin('my/blocksMethods', [
    'blocksMethods' => [
        'wrap' => function () {
            return '<div class="blocks-wrapper">' . $this->toHtml() . '</div>';
        }
    ]
]);

This example shows the basic architecture of a blocks method. You define the method name with the key for the blocksMethods array. $this in the callback function is the $blocks collection.

The blocks method can be used afterwards in your code:

<?= $page->text()->toBlocks()->wrap() ?>

Working with method arguments

In some cases it might be helpful to be able to pass arguments to the method:

<?= $page->text()->toBlocks()->wrap('custom-wrapper-class') ?>

The definition for such a method with arguments is very simple:

Kirby::plugin('my/blocksMethods', [
    'blocksMethods' => [
        'wrap' => function ($className = 'blocks-wrapper') {
            return '<div class="' . $className . '">' . $this->toHtml() . '</div>';
        }
    ]
]);