如何重写Laravel Filament的FilamentManager::getUserName方法

问题背景 #

• 使用Laravel + Filament PHP开发项目
• 将用户表迁移文件中的默认name字段改为username
• 登录时触发类型错误，提示Filament\FilamentManager::getUserName()必须返回string类型，但实际返回null
• 直接修改vendor/filament/filament/src/FilamentManager.php中返回字段为username可临时解决，但属于不良实践（修改依赖文件会导致更新时自定义代码丢失）

解决方案 #

方法一：让用户模型实现HasName接口（推荐，最简单） #

Filament原生提供了HasName接口，允许自定义用户名称字段，无需重写核心类：

1. 在你的User模型中引入接口并实现getFilamentName()方法：

<?php

namespace App\Models;

use Filament\Models\Contracts\HasName;
use Illuminate\Foundation\Auth\User as Authenticatable;

class User extends Authenticatable implements HasName
{
    // ... 模型原有代码

    public function getFilamentName(): string
    {
        return $this->username;
    }
}

方法二：重写FilamentManager类并替换服务绑定 #

如果需要更多自定义逻辑，可以通过服务提供者替换核心的FilamentManager：

1. 创建自定义FilamentManager类：

<?php

namespace App\Filament;

use Filament\FilamentManager;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Contracts\Auth\Authenticatable;

class CustomFilamentManager extends FilamentManager
{
    public function getUserName(Model|Authenticatable $user): string
    {
        if ($user instanceof \Filament\Models\Contracts\HasName) {
            return $user->getFilamentName();
        }

        return $user->getAttributeValue('username');
    }
}

2. 创建自定义服务提供者（若已存在则直接修改）：
   运行命令生成提供者：

php artisan make:provider FilamentServiceProvider

编辑app/Providers/FilamentServiceProvider.php：

<?php

namespace App\Providers;

use App\Filament\CustomFilamentManager;
use Filament\FilamentManager;
use Illuminate\Support\ServiceProvider;

class FilamentServiceProvider extends ServiceProvider
{
    public function register()
    {
        // 用自定义类替换原FilamentManager绑定
        $this->app->bind(FilamentManager::class, CustomFilamentManager::class);
    }
}

3. 在config/app.php中注册服务提供者：

'providers' => [
    // ... 其他服务提供者
    App\Providers\FilamentServiceProvider::class,
],

内容的提问来源于stack exchange，提问作者khaled khan