API reference

Every entry point routes through CanonicalUrlGeneratorInterface, resolved from the container. The facade, helper, component, and directive are thin wrappers over its single generate() method.

Fkrzski\LaravelCanonical\Facades\Canonical.

Canonical::generate(?string $path = null): string

Builds the canonical URL for $path, joined onto the configured canonical domain. With no argument it canonicalises the current request URI, query string included.

use Fkrzski\LaravelCanonical\Facades\Canonical;

Canonical::generate();                 // current request
Canonical::generate('/products/item'); // https://example.com/products/item
Canonical::generate('/');              // https://example.com

canonical(?string $path = null): CanonicalUrlGeneratorInterface|string

Called with a path it returns the URL string; called without arguments it returns the generator for fluent use.

$url       = canonical('/products/item'); // "https://example.com/products/item"
$generator = canonical();                 // fluent generator
$url       = canonical()->generate('/products/item');

Fkrzski\LaravelCanonical\View\Components\Canonical, registered as x-canonical.

Renders a complete, HTML-escaped <link rel="canonical" href="…" /> tag.

<x-canonical />
<x-canonical path="/products/item" />
<x-canonical :path="$post->canonical_path" />

@canonical(?string $expression = null)

Echoes the same tag as the component, escaping the URL with e(). The optional expression is a path string or variable.

@canonical
@canonical('/products/item')
@canonical($canonicalPath)

Fkrzski\LaravelCanonical\Exceptions\CanonicalConfigurationException extends Exception. Thrown when the generator is first resolved from the container — in practice the first time you ask for a URL, including a bare canonical(). Raised when the domain is:

See domain validation for the accepted forms.

The deferred provider binds these contracts as singletons:

Rebind any of them to swap in your own implementation:

$this->app->singleton(CanonicalUrlBuilderInterface::class, MyUrlBuilder::class);

Or resolve the generator directly instead of going through the facade:

$url = app(CanonicalUrlGeneratorInterface::class)->generate('/products/item');