kirby-plugin-development
Builds or extends Kirby plugins using hooks, extensions, blocks, KirbyTags, and shared templates/controllers. Use when creating reusable features or integrating Panel customizations.
When & Why to Use This Skill
This Claude skill streamlines Kirby CMS development by automating the creation and extension of plugins. It provides a structured workflow for implementing hooks, custom blocks, KirbyTags, and shared templates, ensuring that developers follow Kirby's best practices for architecture and local testing.
Use Cases
- Scenario 1: Rapidly generating a minimal plugin skeleton with pre-configured hooks, blueprints, and snippets to jumpstart new features.
- Scenario 2: Extending KirbyText functionality by creating custom KirbyTags for specialized content rendering or third-party integrations.
- Scenario 3: Developing complex Panel customizations, such as nested blocks or custom fields, to enhance the content editing experience.
- Scenario 4: Implementing system-wide logic through hooks to automate tasks like image processing on upload or clearing caches on page updates.
- Scenario 5: Setting up monolithic plugin structures to share controllers and templates across multiple projects for better code reusability.
| name | kirby-plugin-development |
|---|---|
| description | Builds or extends Kirby plugins using hooks, extensions, blocks, KirbyTags, and shared templates/controllers. Use when creating reusable features or integrating Panel customizations. |
Kirby Plugin Development
KB entry points
kirby://kb/scenarios/04-share-templates-controllers-via-pluginkirby://kb/scenarios/05-kirbytext-kirbytags-hookskirby://kb/scenarios/15-custom-blocks-nested-blockskirby://kb/scenarios/17-extend-kirbytagskirby://kb/scenarios/59-monolithic-plugin-setupkirby://kb/scenarios/60-plugin-workflow-local-testing
Required inputs
- Plugin id (vendor/name) and scope.
- Extension points (hooks/fields/tags/blocks/sections).
- Distribution plan (project-only or composer package).
Minimal plugin skeleton
Kirby::plugin('vendor/name', [
'hooks' => [],
'blueprints' => [],
'snippets' => [],
]);
Local testing
- Use the local workflow guide to test without publishing.
- Render affected pages and verify plugin registration.
Common pitfalls
- Using inconsistent plugin ids or folder names.
- Registering hooks that assume Panel or API is always enabled.
Workflow
- Define the plugin id (vendor/name), feature scope, and whether it must be reusable across projects.
- Call
kirby:kirby_initand readkirby://rootsto locate plugin roots. - Inspect existing plugins to avoid duplication:
kirby:kirby_plugins_index. - Use extension and hook references:
kirby://extensionsandkirby://extension/{name}kirby://hooksandkirby://hook/{name}
- Search the KB with
kirby:kirby_search(examples: "kirbytext hooks", "extend kirbytags", "custom blocks", "share templates via plugin", "monolithic plugin setup"). - Implement the plugin with a minimal
index.phpregistration, then add blueprints/snippets/assets as needed. - Verify by rendering affected pages with
kirby:kirby_render_pageand confirming the plugin loads without errors.