包简介

Laravel package for managing canonical URLs and preventing duplicate content

README 文档

README

A lightweight Laravel package for generating canonical URLs to prevent duplicate content issues and improve SEO. Automatically normalizes URLs by removing trailing slashes while preserving query parameters.

Version Compatibility

Package Version	PHP Version	Laravel Version
1.4.x+	8.4+	12.x, 13.x
1.3.x+	8.4+	11.x, 12.x
1.0.x - 1.2.x	8.3+	11.x, 12.x

Installation

Install via Composer:

composer require fkrzski/laravel-canonical

The package will auto-register via Laravel's package discovery.

Configuration

Publish the configuration file (optional):

php artisan vendor:publish --tag="canonical-config"

Set your canonical domain in .env:

CANONICAL_DOMAIN=https://example.com

If not set, it falls back to APP_URL.

Trailing Slash Configuration

@since 1.1.0

Control whether trailing slashes are removed from canonical URLs:

# Remove trailing slashes (default behavior)
CANONICAL_TRIM_TRAILING_SLASH=true

# Preserve trailing slashes
CANONICAL_TRIM_TRAILING_SLASH=false

When set to true (default), URLs are normalized by removing trailing slashes. When set to false, the original URL format is preserved.

Usage

Blade Components

@since 1.2.0

The package provides three convenient ways to add canonical link tags in your Blade templates:

1. Using Blade Component

<head>
    {{-- Use current request URL --}}
    <x-canonical />

    {{-- Specify custom path --}}
    <x-canonical path="/products/item" />

    {{-- Use dynamic path --}}
    <x-canonical :path="$post->canonical_path" />
</head>

2. Using Helper Function

The canonical() helper provides a hybrid approach - it can return either the generator instance or a URL string:

<head>
    {{-- Direct URL generation --}}
    <link rel="canonical" href="{{ canonical('/products/item') }}" />

    {{-- Fluent usage (without arguments returns generator) --}}
    <link rel="canonical" href="{{ canonical()->generate('/products/item') }}" />

    {{-- Use current request URL --}}
    <link rel="canonical" href="{{ canonical()->generate() }}" />

    {{-- Also works in PHP code --}}
    @php
        $url = canonical('/products/item'); // Returns: "https://example.com/products/item"
        $generator = canonical(); // Returns: CanonicalUrlGeneratorInterface instance
    @endphp
</head>

3. Using Blade Directive

<head>
    {{-- Use current request URL --}}
    @canonical

    {{-- Specify custom path --}}
    @canonical('/products/item')

    {{-- Use variable --}}
    @canonical($canonicalPath)
</head>

All Three Methods Generate:

<link rel="canonical" href="https://example.com/products/item" />

In Blade Templates (Facade)

Generate canonical URLs in your views using the Facade:

<head>
    <link rel="canonical" href="{{ Canonical::generate() }}">
</head>

Generate for Specific Paths

use Fkrzski\LaravelCanonical\Facades\Canonical;

// Current request URI
Canonical::generate(); // https://example.com/blog/post

// Override with a custom path
Canonical::generate('/products/item'); // https://example.com/products/item

// Current request with query parameters (preserved)
// Request: /search?q=laravel&page=2
Canonical::generate(); // https://example.com/search?q=laravel&page=2

// Override path even when on different URL
// Current: /old-url, Generate: /new-canonical-url
Canonical::generate('/new-canonical-url'); // https://example.com/new-canonical-url

URL Normalization

With CANONICAL_TRIM_TRAILING_SLASH=true (default):

Removes trailing slashes: /blog/ → /blog
Preserves query parameters: /search?q=test stays intact
Normalizes root URL: / → https://example.com

With CANONICAL_TRIM_TRAILING_SLASH=false (@since 1.1.0):

Preserves trailing slashes: /blog/ → /blog/
Maintains original URL structure while still normalizing the domain
Useful when your application treats /blog and /blog/ as different routes

Use Cases

Prevent duplicate content penalties:

{{-- Both /blog and /blog/ point to same canonical --}}
<link rel="canonical" href="{{ Canonical::generate() }}">

Multi-domain environments:

// config/canonical.php
return [
    'domain' => env('CANONICAL_DOMAIN', config('app.url')),
];

Preserve URL structure (@since 1.1.0):

# When your app treats /page and /page/ differently
CANONICAL_TRIM_TRAILING_SLASH=false

{{-- /blog/ stays as /blog/ --}}
<link rel="canonical" href="{{ Canonical::generate() }}">

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

fkrzski/laravel-canonical 适用场景与选型建议

fkrzski/laravel-canonical 是一款基于 PHP 开发的 Composer 扩展包，目前已累计 90 次下载、GitHub Stars 达 2，最近一次更新时间为 2025 年 10 月 20 日，在 PHP 生态内属于活跃度较高的组件。

它主要适用于以下技术方向：「php」「seo」「laravel」「canonical」「fkrzski」「laravel-canonical」等业务场景。在实际项目中，围绕这些方向常见需要落地的问题包括：接口对接、性能调优、并发安全、与既有框架（Laravel / ThinkPHP / Yii / Webman 等）的兼容适配，以及生产环境的日志埋点与稳定性保障。

我们在过去多个企业项目中使用过 fkrzski/laravel-canonical 或与其功能相近的方案，如果你在选型或落地过程中遇到问题，例如 版本兼容、二次改造、私有化封装、与内部系统对接、生产 BUG 排查，欢迎联系我们协助评估。

围绕 fkrzski/laravel-canonical 我们能提供哪些服务？

定制开发 / 二次开发

基于 fkrzski/laravel-canonical 在你已有业务上做功能扩展、字段裁剪、UI 适配、与内部账号 / 权限 / 日志系统的深度对接。

BUG 修复 & 性能优化

线上偶发问题、内存泄漏、慢查询、并发异常等排查修复；针对高流量场景做缓存、队列、索引层面的调优。

项目外包 & 长期维护

承接完整的项目从需求 → 设计 → 开发 → 上线 → 长期运维；也可按月提供技术保姆服务。

yvsm@zunyunkeji.com QQ：316430983 微信：yvsm316 西安尊云信息科技 · 专注 PHP / Go / 分布式系统研发

与 fkrzski/laravel-canonical 相关的其它包

同方向 / 同关键字的高下载量 PHP Composer 包推荐，方便对比选型：

novius/laravel-meta 0

Help to manage meta data on Laravel Eloquent model

ali-awwad/fine-seo 5

Statamic Fine Seo addon

foxtes/alfabank-rest 1

Alfabank REST API integration

aurmil/magento-force-store-code 4

Magento - Force store code extension

srg/laranx-seo 12

LaraNx SEO, meta tag management for Laravel websites

newtxt/newtxt-translate 0

Laravel integration package for NewTXT Translate widget rendering, server-side localization, translated HTML cache, and prewarm workflows.

fkrzski/laravel-canonical

包简介

关键字：