extends-form

Extend a Sylius admin form

Ask the user if not provided:

• TargetModel: the Sylius entity whose admin form receives the new field (e.g. Product, Taxon, Channel, Customer)
• FieldName: the property name, camelCase — must match the column on the entity (e.g. metadataTitle)
• FieldType: the Symfony form type to use — a scalar (TextType, TextareaType, IntegerType, CheckboxType) or a custom type such as {Related}AutocompleteType for a relation
• Whether the field is required (default: false)
• The target section hook (default: general). To list available sections, on Sylius 2.3+:

  bin/console sylius:debug:twig-hooks sylius_admin.{target_model_snake}
  

  On older versions, fall back to bin/console debug:config sylius_twig_hooks.

Prerequisites:

• The field must exist on the entity. Run /sylius-app:extends-model first for a Sylius core entity, or add the column on your own resource.
• For an entity-autocomplete field type, run /sylius-app:add-autocomplete first so {Related}AutocompleteType exists.

1. Identify the target FormType

bin/console sylius:debug:resource sylius.{target_model_snake}

The classes.form row in the output is the FormType FQCN used by the admin. Use it directly as the use statement and as the getExtendedTypes() return. Without an argument, the command lists every resource alias.

2. Create the FormTypeExtension

src/Form/Extension/{TargetModel}/{TargetModel}TypeExtension.php:

<?php

declare(strict_types=1);

namespace App\Form\Extension\{TargetModel};

use {TargetFormFqcn};  // value returned by step 1
use Symfony\Component\Form\AbstractTypeExtension;
use Symfony\Component\Form\Extension\Core\Type\{FieldType};  // or your custom type
use Symfony\Component\Form\FormBuilderInterface;

final class {TargetModel}TypeExtension extends AbstractTypeExtension
{
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder->add('{field_name}', {FieldType}::class, [
            'label' => 'app.form.{target_model_snake}.{field_name}',
            'required' => {required},
        ]);
    }

    public static function getExtendedTypes(): iterable
    {
        return [{TargetModel}Type::class];
    }
}