Reference

Guide

URLs

Modify all URLs

/site/plugins/urls/index.php
Kirby::plugin('my/urls', [
  'components' => [
    'url' => function (Kirby $kirby, string $path, array $options = [], Closure $originalHandler): string {
        return $originalHandler($path, $options);
    }
  ]
]);

Parameters

Name Type Default Description
$kirby Kirby\Cms\App

Kirby instance

$path string null

URL path

$options array|string|null null

Array of options for the Uri class

$originalHandler Closure null

Deprecated: Callback function to the original URL handler with $path and $options as parameters
Use $kirby->nativeComponent('url') inside your URL component instead.

Return type

string

Source code

kirby/config/components.php#L334