SEO for Kirby CMS – done right.
- All-in-one SEO and meta solution
- The Meta Cascade: Intelligently merge meta data from multiple sources
- Schema.org support with fluent classes
- to be extended
- Kirby 3.9+
- PHP 8.1+
Kirby SEO is built with a cascading approach in mind. This means that you can define meta tags on multiple levels, and they will be merged together based on their priority:
- Page fields: The default page blueprint that allows you to specify most options
- Programmatic content: With Page models you can programmatically set meta tags like you want
- Inherited fields from parent page: Most fields can be configured to inherit to child pages
- Site globals: The site blueprint allows you to set global defaults for all pages
- Options: The last fallback is defined in the plugin options
If any setting is left empty, it will fallback to the next level. In this way, the plugin provides cascades to form the final meta data.
Add the blueprint tabs to your blueprints.
# site/blueprints/site.yml
tabs:
content:
fields:
# your fields
seo: seo/site# site/blueprints/pages/default.yml (or any other template)
tabs:
content:
fields:
# your fields
seo: seo/pageAdd the meta snippet to your templates.
// site/templates/default.php
<head>
<?php snippet('seo/head'); ?>
</head>..and start defining your meta data in panel.
If you're using a single-language setup, it's important to define the language code of your website in the config file:
// config.php
return [
'tobimori.seo.lang' => 'en_US',
];It's used for the og:locale meta tag, and can be applied to the lang attribute of your <html> tag using the $site->lang() site method.
The plugin exposes the spatie/schema-org package as site & page methods, with a global store you can access anywhere.
By default, the $pages WebSite schema will be pre-filled with data from fields. You can override the data with the methods listed below.
Returns the existing Schema Object of the given type, or a new Schema Object if it hasn't been created yet for the current context.
Returns all schemas for a given context as array.
Generates a new Schema Object of the given type, without storing in the context.
This example shows an FAQ page with multiple blocks, each containing a question and an answer.
// site/snippets/blocks/faq.php
<?php $page->schema('FAQPage')->url('https://moeritz.io')->mainEntity(
[
...($page->schema('FAQPage')->getProperty('mainEntity') ?? []),
schema('Question')->name($block->question())->acceptedAnswer(
schema('Answer')->text($block->title())
)
]
);// At the end of `site/templates/default.php`
<?php snippet('seo/schemas') ?>// Output
{
"@context": "https://schema.org",
"@type": "FAQPage",
"url": "https://moeritz.io",
"mainEntity": [
{
"@type": "Question",
"name": "How does it work?",
"acceptedAnswer": { "@type": "Answer", "text": "It works like this." }
},
{
"@type": "Question",
"name": "Woah, it can handle multiple blocks?",
"acceptedAnswer": { "@type": "Answer", "text": "Yes, it can." }
}
]
}| Option | Default | Description |
|---|---|---|
default.* |
see index.php | Sets several defaults for meta tags where necessary, see Meta Cascade |
socialMedia.* |
see index.php | Customize the social media accounts field for the site blueprint (Format: 'id' => 'placeholder') |
generateSchema |
true |
Whether to generate Schema.org JSON-LD with the default 'website' type |
canonicalIncludesWWW |
false |
Whether to include the www. subdomain in the automatically generated canonical URL |
dateFormat |
%Y-%m-%d |
Date format for generation of page modified meta tags |
lang |
en_US |
Language code to be used in meta tags for single language setups |
Options allow you to fine tune the behaviour of the plugin. You can set them in your config.php file:
return [
'tobimori.seo' => [
'generateSchema' => true,
'canonicalIncludesWWW' => false,
'dateFormat' => '%Y-%m-%d'
],
];- Robots page status as section
- Google pixel length calculation for preview
-
seo/inheritablespage blueprint, containing only inheritable fields for use with pages that don't have a frontend representation - Toolkit for programmatic image generation with Puppeteer/BrowserShot (might be separate plugin)
- Social Media Links handling in sameAs schema.org property, and
og:see_alsometa tag - Keywords/Tags field
-
robots.txtgeneration -
sitemap.xmlgeneration - Favicon and webmanifest generation
- SEO Overview page/dashboard
- Site Verification fields
- Robots field section, for per-page overrides
This roadmap is a courtesy and subject to change at any time. New features will be added as soon as I need them for my own projects.
- kirby-meta by Fabian Michael
- kirby-meta-knight by diesdas.digital (unmaintained, but have a look at forks!)
MIT License Copyright © 2023 Tobias Möritz
