Extends Model

Extend a Sylius entity (plugin)

Sylius base entities like Sylius\Component\Core\Model\Product are declared as MappedSuperclass, not #[ORM\Entity]. They're not real Doctrine entities — every Sylius project (or test app exercising your plugin) is expected to declare a concrete #[ORM\Entity] subclass that inherits the parent columns and adds its own.

A plugin engages with this in two ways:

1. Inside the test app — override a Sylius entity in tests/TestApplication/src/Entity/ to exercise integration paths (forms, grids, migrations) end-to-end.
2. As a reusable contract — ship a plugin-side interface + trait so integrators can attach plugin data to any Sylius entity from their own app.

Both share the override entity pattern. The trait pattern is documented at the end.

Ask the user for the ModelName if not provided (e.g. Product, Taxon, Channel, Customer).

1. Identify the current resource config

vendor/bin/console sylius:debug:resource sylius.{model_snake}

The output's classes.model row is the current model FQCN — that's the class your override must extend. Run without an argument to list all resource aliases.

Also read the reference template used by Sylius-Standard for the exact file structure to mimic:

cat vendor/sylius/sylius-standard/src/Entity/{Subdir}/{ModelName}.php
cat vendor/sylius/sylius-standard/config/packages/_sylius.yaml

{Subdir} is the functional grouping used by Sylius-Standard (Product, Taxonomy, Shipping, Addressing, User, Customer, Channel, Order, Payment, Promotion, Taxation). ls vendor/sylius/sylius-standard/src/Entity/ to see them all.

2. Create the override entity in the test app

tests/TestApplication/src/Entity/{Subdir}/{ModelName}.php:

<?php

declare(strict_types=1);

namespace Tests\$SYLIUS_NAMESPACE\Entity\{Subdir};

use Doctrine\ORM\Mapping as ORM;
use {BaseModelFqcn} as Base{ModelName};  // value from step 1 — typically Sylius\Component\Core\Model\{ModelName}

#[ORM\Entity]
#[ORM\Table(name: 'sylius_{model_snake}')]
class {ModelName} extends Base{ModelName}
{
    // add your fields / implements Xxx + use XxxTrait here
}

Omitting #[ORM\Entity] makes Doctrine ignore the class entirely — the override silently doesn't take effect.

3. Register the override as the resource model

Unlike custom plugin resources (add-model, one file per resource), Sylius core overrides go in a single monolithic file — this is the Sylius official convention. All overrides share the same _sylius.yaml across bundle keys.

Copy the bundle key + resource key pairing from vendor/sylius/sylius-standard/config/packages/_sylius.yaml (read in step 1). Example for Product:

# tests/TestApplication/config/packages/_sylius.yaml
sylius_product:
    resources:
        product:
            classes:
                model: Tests\$SYLIUS_NAMESPACE\Entity\{Subdir}\{ModelName}

Non-obvious pairings to watch for (the bundle key isn't always sylius_{model_snake}):

• Taxon → sylius_taxonomy.resources.taxon
• ShopUser/AdminUser → sylius_user.resources.shop_user / admin_user
• Country/Address/Zone → sylius_addressing.resources.{country|address|zone|zone_member}

If unsure, grep -r "{model_snake}:" vendor/sylius/sylius-standard/config/packages/_sylius.yaml finds the exact placement.

4. Configure Doctrine mapping in the test app

The test app must learn the Tests\$SYLIUS_NAMESPACE\Entity namespace. Add to tests/TestApplication/config/config.yaml:

doctrine:
    orm:
        entity_managers:
            default:
                naming_strategy: doctrine.orm.naming_strategy.underscore_number_aware
                mappings:
                    TestApplication:
                        is_bundle: false
                        type: attribute
                        dir: '%kernel.project_dir%/../../../tests/TestApplication/src/Entity'
                        prefix: Tests\$SYLIUS_NAMESPACE\Entity

The prefix covers all subnamespaces (Tests\...\Entity\Core, Tests\...\Entity\Addressing, etc.) automatically. naming_strategy: underscore_number_aware converts camelCase properties ($metadataTitle) to snake_case columns (metadata_title).

5. Generate and apply the migration

The plugin's DI extension declares the DoctrineMigrations namespace via PrependDoctrineMigrationsTrait, so generate into it:

vendor/bin/console doctrine:migrations:diff --namespace=DoctrineMigrations

Always review the generated migration before applying. It should contain only ALTER TABLE sylius_{model_snake} ADD ... for the new columns. Unrelated SQL (other Sylius core tables, messenger_messages, etc.) means pre-existing schema drift between mapping and DB — manually trim before applying.

vendor/bin/console doctrine:migrations:migrate --no-interaction

6. Clear cache

vendor/bin/console cache:clear

7. Verify

• vendor/bin/console debug:container --parameter=sylius.model.{model_snake}.class outputs the override FQCN — Tests\$SYLIUS_NAMESPACE\Entity\{Subdir}\{ModelName}
• vendor/bin/console doctrine:mapping:describe 'Tests\$SYLIUS_NAMESPACE\Entity\{Subdir}\{ModelName}' lists the inherited columns plus the new ones (no not a mapped entity error)
• vendor/bin/console doctrine:query:sql "DESCRIBE sylius_{model_snake}" shows the new columns persisted in the DB

Shipping a plugin-provided interface + trait

When the plugin ships a contract for integrators to attach plugin data to any Sylius entity (Product, Taxon, Channel, …) without the plugin having to predict which one:

// src/SEO/Adapter/ReferenceableInterface.php
interface ReferenceableInterface
{
    public function getReferenceableContent(): ?SEOContentInterface;
    public function setReferenceableContent(?SEOContentInterface $seoContent): static;
}

// src/SEO/Adapter/ReferenceableTrait.php
trait ReferenceableTrait
{
    #[ORM\OneToOne(targetEntity: SEOContent::class, cascade: ['persist', 'remove'])]
    #[ORM\JoinColumn(name: 'seo_content_id', referencedColumnName: 'id', onDelete: 'SET NULL', nullable: true)]
    protected ?SEOContentInterface $seoContent = null;

    public function getReferenceableContent(): ?SEOContentInterface { /* ... */ }
    public function setReferenceableContent(?SEOContentInterface $seoContent): static { /* ... */ }
}

Unidirectional OneToOne: the host entity holds the FK, the plugin object knows nothing about its host. Works for any current or future Sylius entity without plugin modification.

Document in the plugin README that integrators must use ReferenceableTrait on their App\Entity\… override (the integrator runs /sylius-app:extends-model to set that up).

Next steps

After the migration, the column exists in the database but is not visible in the UI. Depending on what was added: