Kirby 3 Plugin to use

1.4.1 2022-04-26 14:31 UTC

This package is auto-updated.

Last update: 2023-03-26 16:36:01 UTC


Release Downloads Build Status Coverage Status Maintainability Twitter

Kirby 3 Plugin to use

Commercial Usage


Unless you enter a paid API key this plugin will scrape the web based tools of They know about this, did send me a really nice email and decided for now not to block the scrapping. Go signup for an account with API access to support them! The api is also a tiny bit faster than the scrapper.

Support open source!

This plugin is free but if you use it in a commercial project please consider to sponsor me or make a donation.
If my work helped you to make some cash it seems fair to me that I might get a little reward as well, right?

Be kind. Share a little. Thanks.

‐ Bruno
Github sponsor Patreon Buy Me a Coffee Paypal dontation Hire me


  • unzip as folder site/plugins/kirby3-seobility or
  • git submodule add site/plugins/kirby3-seobility or
  • composer require bnomei/kirby3-seobility



  • keyword check (scrapper for web based tool, not a free api)

Paid API

  • keyword check
  • real time SERP ranking
  • term suggestion
  • add more features of paid api


Keyword check (scrapper, paid)

Add the field to your blueprint.


  keywordcheck: # the field id must be exactly like this
    label: Keywordcheck
    type: keywordcheck

Enter keywords(s) in the panel. Save and get a score. Clicking on the score will take you to new browser tab with the full report.


You can also read the score with a pagemethod if you need it in you business logic.

any template

echo $page->keywordcheckScore();

To show the score of the keywordcheck field the plugin will scrape the web based tools of or query your paid API account and cache the results until the content page is modified or cache expires (see settings below).

⚠️ EVERY time you press the save button in the panel for a page with this field a request to the API will be made. This might delay saving by a second or two. The paid API is a tiny bit faster.

Real time SERP Ranking (paid)

This field is a button to trigger a real time, synchronous (direct) API. The average response time is up to 30 seconds and it will return the rank, title and description as listed on the specified search engine (see settings).

⚠️ You need to have a keywordcheck field on the same blueprint and at least one keyword set to get a SERP ranking.


    headline: SERP Ranking
    label: Fetch Rank
    progress: Fetching Rank...
    # notranked: Page is not ranked.
    type: ranking


Term Suggestion (paid)

This field is a button to trigger a term suggestion (more, less, ok) for the specified search engine (see settings).

⚠️ You need to have a keywordcheck field on the same blueprint and at least one keyword set to get further term suggestions.


    headline: Term Suggestion
    label: Fetch Term Suggestions
    progress: Fetching Term Suggestions...
    type: termsuggestion



If you have a custom robots.txt-file or use my plugin make sure the bot can crawl the website. My Robots.txt plugin must be in non debug mode.

In a custom robots.txt-file add something like this:

User-Agent: seobility
Allow: /

Localhost = No Score

The plugin will not query the API on localhost since the API would not be able to read the HTML content of your page.

No cache when debugging

When Kirbys global debug config is set to true the complete plugin cache will be flushed BUT caches will be created. This will make you live easier – trust me.

Setup paid API

You can set the apikey in the config if you want to use features from the paid api.


return [
    // other config settings ...
    'bnomei.seobility.apikey' => 'YOUR-KEY-HERE',

You can also set a callback if you use the dotenv Plugin.


return [
    // other config settings ...
    'bnomei.seobility.apikey' => function() { return env('SEOBILITY_APIKEY'); },


bnomei.seobility. Default Description
enabled true but disabled on localhost by default
expire 0 will expire on modified or after n-minutes
apikey null string or callback
searchengine the target searchengine domain


This plugin is provided "as is" with no guarantee. Use it at your own risk and always test it yourself before using it in a production environment. If you find any issues, please create a new issue.



It is discouraged to use this plugin in any project that promotes racism, sexism, homophobia, animal abuse, violence or any other form of hate speech.