A block type is made up of three components:
- A PHP code snippet to render the block content in the frontend
- A block blueprint which tells Kirby which fields should be available in the block
- An (optional) Panel preview for the WYSIWYG experience
You can find the source files for the existing block types in the documentation for each block type.
With this knowledge, we can go ahead and either modify existing block types or create new ones.
You can customize all existing block types to your needs in one or all of the following ways:
- Change how the block renders in the frontend by overwriting the snippet for the block
- Add or replace fields in a block type by overwriting the Blueprint file for the block type. This will often go hand in hand with modifying the output as in point 1.
- Change how the block looks in the Panel by overwriting its preview.
To modify a block, you can use the standard blueprints, snippets, and previews of each block type as a basis for your changes. Read more…
Let's take the heading block and add a simple text field to add a custom ID for the heading
This will add the
customID field below the default fields of the block.
Instead of only adding new fields, you can also adjust the field settings for the default fields of the block.
Let's limit the number of heading levels for our heading block.
You can find all block fields and their settings in the docs for each block.
You can extend our core blocks with additional tabs. Be aware though that you need to recreate all default fields in this case, as tabs will replace the default fields.
The HTML for each individual block is stored in its own block snippet. All our default block types bring their own snippets and can be overwritten. Block snippets are stored in
As an example, if you want to overwrite the snippet for our heading block, you would create a snippet file called
The default heading snippet
Your customized version
You create custom block types from the same three components. If you don't need a visual preview, you even make do with only a blueprint and a snippet. Learn how to create your own custom block types with our extensive documentation.
Custom blocks can be defined directly in the fieldsets list (however, if you want to use a block in multiple places, it's better to create it in a plugin, see below):
In the example above, we mix the default block types (heading and text) with our own custom block type to add a call to action button.
Custom block types don't have a visual preview by default. They show up with the icon and the name from your blueprint definition.
Custom block types can use the
label property to show some information from a field in the block. This can be particularly useful for blocks that don't have a preview:
Within the label property, you have access to an array of field properties, here are some more examples:
To edit a custom block type, editors can either double-tap on the block or click on the edit icon in the toolbar. The block drawer opens with the fields you've defined for the block.
If you don't define any
fields, the block won't have a drawer. This can be useful for blocks that don't feature any configuration (e.g. the default
You can also define tabs for your blocks when they have a lot of settings:
The tabs will then show up in the block drawer.
For reuse in multiple places, custom block type definitions can be stored in a folder called
site/blueprints/blocks. In this case we would store it in
Now, we can use it in our fieldsets option for any blocks field.
This also works in groups:
To render the HTML for your custom block type in the frontend, create a snippet in
/site/snippets/blocks. In this case we create a file called
You can turn your custom blocks into highly visual, interactive representations with a custom block preview plugin.