如何覆写SonataUserBundle的UserAdmin表单并添加自定义字段

我基于SonataAdminBundle（v4.22）和SonataUserBundle（v5.4）搭建了Sonata项目用于用户管理，未使用FosUserBundle。尝试覆写UserAdmin类的configureFormFields方法，添加一个布尔类型的notification字段，但该字段未显示。

已创建自定义的UserAdmin类继承自SonataUserBundle的UserAdmin类，重写代码如下：

<?php

namespace App\Admin;

use Sonata\AdminBundle\Form\FormMapper;

class UserAdmin extends \Sonata\UserBundle\Admin\Model\UserAdmin
{
    protected function configureFormFields(FormMapper $form): void
    {
        parent::configureFormFields($form);
        $form
            ->with('general', ['class' => 'col-md-4'])
                ->add('notification')
            ->end();
    }
}

要让自定义的UserAdmin生效并显示字段，需完成以下操作：

1. 确保用户实体包含notification字段及对应方法 #

首先要在你的用户实体类中添加notification字段，同时实现对应的getter和setter方法，还要配置Doctrine映射：

// src/Entity/User.php
namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;
use Sonata\UserBundle\Model\User as BaseUser;

#[ORM\Entity]
#[ORM\Table(name: 'user')]
class User extends BaseUser
{
    #[ORM\Id]
    #[ORM\GeneratedValue]
    #[ORM\Column(type: 'integer')]
    protected $id;

    // 添加notification字段
    #[ORM\Column(type: 'boolean', options: ['default' => false])]
    private bool $notification = false;

    public function isNotification(): bool
    {
        return $this->notification;
    }

    public function setNotification(bool $notification): self
    {
        $this->notification = $notification;
        return $this;
    }
}

2. 配置Symfony服务，替换默认的UserAdmin #

在config/services.yaml中注册自定义的UserAdmin服务，并覆盖SonataUserBundle默认的服务：

services:
    app.admin.user:
        class: App\Admin\UserAdmin
        arguments: [~, App\Entity\User, ~]
        tags:
            - { name: sonata.admin, manager_type: orm, label: '用户' }
        public: true

    # 覆盖Sonata默认的UserAdmin服务
    sonata.user.admin.user:
        alias: app.admin.user
        public: true

注意替换App\Entity\User为你实际的用户实体类路径。

3. 显式指定表单字段类型（可选但推荐） #

在configureFormFields方法中显式指定布尔字段的类型，避免自动推断错误：

protected function configureFormFields(FormMapper $form): void
{
    parent::configureFormFields($form);
    $form
        ->with('general', ['class' => 'col-md-4'])
            ->add('notification', \Symfony\Component\Form\Extension\Core\Type\CheckboxType::class, [
                'label' => '接收通知',
                'required' => false,
            ])
        ->end();
}

4. 清除Symfony缓存 #

执行缓存清除命令，确保服务配置和实体映射生效：

php bin/console cache:clear

完成以上步骤后，刷新Sonata Admin的用户编辑页面，notification字段应该会正常显示在"general"分组中。

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