Kirby 3 Redirects
Setup HTTP Status Code Redirects from within the Kirby Panel.
Kirby 3 Redirects can handle Request-URIs like
project/cool.html and send Response-URIs like
https://exter.nal. This makes it the ideal choice when porting a non Kirby project.
- kirby-retour but it can only handle Kirby Routes. It is the better choice when updating a Kirby 2 project or creating a brand new Kirby 3 project.
Works well with
- CSV Plugin to help you import and export data to the redirects structure.
This plugin is free but if you use it in a commercial project please consider to
- unzip master.zip as folder
git submodule add https://github.com/bnomei/kirby3-redirects.git site/plugins/kirby3-redirectsor
composer require bnomei/kirby3-redirects
plugin-redirects section to your
site.yml and add redirects in the panel.
sections: # ...other sections redirects: extends: plugin-redirects3xx
If you need all http codes you can use
extends: plugin-redirectsinstead which calls the api to retrieve them (once for each redirect). This is not advised if you have a lot of redirects.
Since v1.1.0 the plugin will register itself with a
route:before-hook and take care of the redirecting automatically. Many thanks to Sebastian Aschenbach for suggesting this solution.
The site methods
removeRedirects allow you to programmatically change the redirects table (if stored in a Page/Site-Object).
// add single item $success = site()->appendRedirects( ['fromuri'=>'/posts?id=1', 'touri'=>'/blog/1', 'code'=>301] ); // add multiple items with nested array $success = site()->appendRedirects([ ['fromuri'=>'/posts?id=2', 'touri'=>'/blog/2', 'code'=>301], // ... ['fromuri'=>'/posts?id=999', 'touri'=>'/blog/999', 'code'=>301], ]); // remove single item $success = site()->removeRedirects( ['fromuri'=>'/posts?id=1', 'touri'=>'/blog/1'] ); // remove multiple items with nested array $success = site()->removeRedirects([ ['fromuri'=>'/posts?id=3', 'touri'=>'/blog/3'], ['fromuri'=>'/posts?id=5', 'touri'=>'/blog/5'], ['fromuri'=>'/posts?id=7', 'touri'=>'/blog/7'], ]);
||do keep querystring in request URI. example:
||A closure to get the structure from
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.
This plugins is similar yet way less powerful than K2 version of