andrekelling / kirby-block-finder
Block Finder
Package info
github.com/AndreKelling/kirby-block-finder
Type:kirby-plugin
pkg:composer/andrekelling/kirby-block-finder
Requires
Requires (Dev)
- getkirby/cms: ^5.1
This package is auto-updated.
Last update: 2026-06-29 14:51:45 UTC
README
A Kirby 5 Panel plugin that finds where a given block type is used across your site.
It adds a Block Finder entry to the Panel menu. Pick a block type and the plugin scans every page (in every language) for that block in a configurable blocks field, listing each page, the language, the number of occurrences, and a direct link into the Panel.
Features
- Panel view listing all available block types from your blueprints
- Searches every page returned by
site()->index() - Multi-language aware — reports occurrences per language
- Shows occurrence count and a deep link to the page in the Panel
- Configurable blocks field name
Requirements
- Kirby 5.1+ (just tested with 5.1 probably works on previous versions too)
Installation
Download
Download and copy this repository to /site/plugins/kirby-block-finder.
Composer
composer require andrekelling/kirby-block-finder
Usage
- Open the Panel and choose Block Finder from the menu.
- Select a block type from the dropdown.
- The matching pages are listed with their language, occurrence count, and a link to open the page in the Panel.
Options
By default the plugin looks in a blocks field named blocks. Override the field
name in site/config/config.php:
return [ 'andrekelling.kirby-block-finder.fieldName' => 'myBlocksField', ];
| Option | Default | Description |
|---|---|---|
fieldName |
blocks |
Name of the blocks field to search on a page. |
Development
The Panel view is built from src/index.js with kirbyup.
# watch and rebuild on change npm run dev # production build npm run build
The build output is written to index.js, which is loaded by the plugin.
License
MIT © André Kelling
