Also, you may want to add translatable custom fields, which is also covered in very short here.<\/p>\n
<\/span>Add custom field to entity definition<\/span><\/h3>\n<plugin root>\/src\/Core\/Content\/Example\/ExampleDefinition.php\n\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Field\\CustomFields; \n\u200b\n[...]\nclass ExampleDefinition extends EntityDefinition\n{\n [...]\n protected function defineFields(): FieldCollection\n {\n return new FieldCollection([\n (new IdField('id', 'id'))->addFlags(new Required(), new PrimaryKey()),\n (new StringField('name', 'name')),\n (new StringField('description', 'description')),\n (new BoolField('active', 'active')),\n new CustomFields()\n ]);\n }\n}\n<\/pre>\nNote the new field that was added in the FieldCollection. That’s already it for your custom entity definition. Now go ahead and add the column to the database.<\/p>\n
<\/span>Add column in database table<\/span><\/h3>\nIf you want to support custom fields now, you have to add a new column custom_fields of type JSON to your migration.<\/p>\n
<plugin root>\/src\/Migration\/Migration1611664789Example.php\npublic function update(Connection $connection): void\n{\n $sql = <<<SQL\n CREATE TABLE IF NOT EXISTS `swag_example` (\n `id` BINARY(16) NOT NULL,\n `name` VARCHAR(255) COLLATE utf8mb4_unicode_ci,\n `description` VARCHAR(255) COLLATE utf8mb4_unicode_ci,\n `active` TINYINT(1) COLLATE utf8mb4_unicode_ci,\n\u200b\n `custom_fields` json DEFAULT NULL,\n\u200b\n `created_at` DATETIME(3) NOT NULL,\n `updated_at` DATETIME(3),\n PRIMARY KEY (`id`)\n )\n ENGINE = InnoDB\n DEFAULT CHARSET = utf8mb4\n COLLATE = utf8mb4_unicode_ci;\n SQL;\n $connection->executeStatement($sql);\n}\n<\/pre>\nCustom field always must be json field and it should default to null, since it doesn’t have to contain values.<\/p>\n
<\/span>Add translatable custom field to entity definition<\/span><\/h3>\nMake sure to understand entity translations in general first, which is explained here Add data translations. If you want your custom fields to be translatable, you can simply work with a TranslatedField here as well.<\/p>\n
<plugin root>\/src\/Core\/Content\/Example\/ExampleDefinition.php\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Field\\TranslatedField; \n\u200b\n[...]\n\u200b\nclass ExampleDefinition extends EntityDefinition\n{\n [...]\n\u200b\n protected function defineFields(): FieldCollection\n {\n return new FieldCollection([\n (new IdField('id', 'id'))->addFlags(new Required(), new PrimaryKey()),\n (new StringField('name', 'name')),\n (new StringField('description', 'description')),\n (new BoolField('active', 'active')),\n\u200b\n new TranslatedField('customFields'),\n ]);\n }\n}\n<\/pre>\nJust add the TranslatedField and apply customFields as a parameter.
\nIn your translated entity definition, you then add the CustomFields field instead.<\/p>\n
<plugin root>\/src\/Core\/Content\/Example\/Aggregate\/ExampleTranslation\/ExampleTranslationDefinition.php\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Field\\CustomFields; \n[...]\nclass ExampleTranslationDefinition extends EntityTranslationDefinition\n{\n [...]\n\u200b\n protected function defineFields(): FieldCollection\n {\n return new FieldCollection([\n (new StringField('name', 'name'))->addFlags(new Required()),\n\u200b\n new CustomFields()\n ]);\n }\n}\n<\/pre>\n<\/span>Add custom fields to an entity<\/span><\/h3>\nDefining a custom field set is not necessary it is only necessary, if you want it to be editable in the administration or if you need validation when writing your custom field.<\/p>\n
Because of that, we’ll start with filling data to an actual entities’ custom field, before actually defining it.<\/p>\n
Filling data into custom fields<\/h4>\n$this->swagExampleRepository->upsert([[\n 'id' => '<your ID here>',\n 'customFields' => ['swag_example_size' => 15]\n]], $context);\n<\/pre>\nYou can write any valid json you want to write in custom Field. Example:<\/p>\n
$this->swagExampleRepository->upsert([[\n 'id' => '<your ID here>',\n 'customFields' => [ 'foo' => 'bar', 'baz' => [] ]\n]], $context);\n<\/pre>\nAdding an actual custom field<\/h4>\n
You can skip this section if you do not want your new custom field to be editable in the administration.<\/p>\n
use Shopware\\Core\\System\\CustomField\\CustomFieldTypes;<\/p>\n
[...]\n\n$this->customFieldSetRepository->create([\n [\n 'name' => 'swag_example_set',\n 'config' => [\n 'label' => [\n 'en-GB' => 'English custom field set label',\n 'de-DE' => 'German custom field set label'\n ]\n ],\n 'customFields' => [\n [\n 'name' => 'swag_example_size',\n 'type' => CustomFieldTypes::INT,\n 'config' => [\n 'label' => [\n 'en-GB' => 'English custom field label',\n 'de-DE' => 'German custom field label'\n ],\n 'customFieldPosition' => 1\n ]\n ]\n ]\n ]\n], $context);\n<\/pre>\n<\/span>Here is the example of removing some categories from navigation menu.<\/span><\/h3>\nI am adding a custom field which will hide menu from sidebar.<\/p>\n
custom\/plugin\/pluginRoot\/src\/pluginName.php<\/p>\n
Have a look on the screenshot:
\n![\"shopware](\"\/blog\/wp-content\/uploads\/sites\/2\/2021\/09\/shopware-remove-categories-1.png\")
<\/p>\n
Here my plugin name is SidebarNavigation<\/p>\n
This class will perform operation on custom_field_set<\/strong><\/p>\n<?php declare(strict_types=1);\n\nnamespace SidebarNavigation;\n\nuse Doctrine\\DBAL\\Connection;\nuse Shopware\\Core\\Framework\\Plugin;\nuse Shopware\\Core\\Framework\\Plugin\\Context\\UninstallContext;\nuse Shopware\\Core\\Framework\\Plugin\\Context\\InstallContext;\nuse Shopware\\Core\\Framework\\Context;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\IdSearchResult;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Criteria;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Filter\\EqualsAnyFilter;\nuse SidebarNavigation\\Services\\SidebarNavigationCustomFieldSetService;\n\nclass SidebarNavigation extends Plugin\n{\n public function install(InstallContext $installContext): void\n {\n parent::install($installContext);\n\n $SidebarNavigationCustomFieldSetService = new SidebarNavigationCustomFieldSetService(\n $this->container->get('custom_field_set.repository')\n );\n\n \/** @var Context $context *\/\n $context = $installContext->getContext();\n\n $SidebarNavigationCustomFieldSetService->createCategoryCustomFieldSet($context);\n }\n\n public function uninstall(UninstallContext $context): void\n {\n parent::uninstall($context);\n if ($context->keepUserData()) {\n return;\n }\n\n $this->removeCustomFields($context);\n }\n\n private function removeCustomFields(UninstallContext $uninstallContext)\n {\n $customFieldSetRepository = $this->container->get('custom_field_set.repository');\n\n \/** @var Context $context *\/\n $context = $uninstallContext->getContext();\n\n \/\/ Delete custom field set\n\n $this->deleteCustomFieldSet(\n $context,\n $customFieldSetRepository,\n SidebarNavigationCustomFieldSetService::SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET\n );\n }\n\n private function deleteCustomFieldSet(Context $context, $customFieldSetRepository, string $customFieldSet): void\n {\n $customFieldIds = $this->getCustomFieldSetIds($context, $customFieldSet);\n\n if ($customFieldIds) {\n $customFieldSetRepository->delete(array_values($customFieldIds->getData()), $context);\n }\n }\n\n private function getCustomFieldSetIds(Context $context, string $customFieldSet): ?IdSearchResult\n {\n $customFieldSetRepository = $this->container->get('custom_field_set.repository');\n\n $criteria = new Criteria();\n $criteria->addFilter(new EqualsAnyFilter('name', [$customFieldSet]));\n\n $customFieldIds = $customFieldSetRepository->searchIds($criteria, $context);\n\n return $customFieldIds->getTotal() > 0 ? $customFieldIds : null;\n }\n}\n<\/pre>\nThen create a service on the given location which will create custom field:<\/p>\n
\/custom\/plugins\/PluginRoot\/src\/Services<\/p>\n
<?php declare(strict_types=1);\n\nnamespace SidebarNavigation\\Services;\n\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\EntityRepositoryInterface;\nuse Shopware\\Core\\System\\CustomField\\CustomFieldTypes;\nuse Shopware\\Core\\Framework\\Context;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Criteria;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Filter\\EqualsFilter;\nuse Shopware\\Core\\System\\CustomField\\Aggregate\\CustomFieldSet\\CustomFieldSetCollection;\nuse Shopware\\Core\\Framework\\Uuid\\Uuid;\n\nclass SidebarNavigationCustomFieldSetService {\n \/\/custom field set\n public const SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET = 'sidebar_category_navigation_custom_field_set';\n\n public const SIDEBAR_CATEGORY_ACTIVE_CUSTOM_FIELD = 'sidebar_category_active_custom_field';\n \/**\n * @var EntityRepositoryInterface\n *\/\n private $customFieldSetRepository;\n\n public function __construct(EntityRepositoryInterface $customFieldSetRepository)\n {\n $this->customFieldSetRepository = $customFieldSetRepository;\n }\n\n public function createCategoryCustomFieldSet(Context $context): void\n {\n $criteria = new Criteria();\n $criteria->addFilter(new EqualsFilter('name', self::SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET));\n\n \/** @var CustomFieldSetCollection $customFieldSets *\/\n $customFieldSets = $this->customFieldSetRepository->search($criteria, $context)->getEntities();\n\n if (!count($customFieldSets)) {\n $this->customFieldSetRepository->create([\n [\n 'name' => self::SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET,\n 'global' => true,\n 'config' => [\n 'label' => [\n 'de-DE' => 'Sidebar (Navigation)',\n 'en-GB' => 'Sidebar (Navigation)'\n ]\n ],\n 'customFields' => [\n [\n 'name' => self::SIDEBAR_CATEGORY_ACTIVE_CUSTOM_FIELD,\n 'type' => CustomFieldTypes::SWITCH,\n 'config' => [\n 'label' => [\n 'de-DE' => 'Hide in sidebar navigation',\n 'en-GB' => 'Hide in sidebar navigation'\n ],\n\/\/Here I am creating SWITCH type field, we can create any field you want.\n 'componentName' => 'sw-field',\n 'type' => CustomFieldTypes::SWITCH,\n 'customFieldType' => CustomFieldTypes::SWITCH,\n 'customFieldPosition' => 1\n ]\n ]\n ],\n 'relations' => [\n [\n 'id' => Uuid::randomHex(),\n 'entityName' => 'category' \/\/ You can use any entity where you want to create custom field.\n ]\n ]\n ]\n ], $context);\n\n \n }\n }\n}\n<\/pre>\nHere are some more types of custom fields:<\/p>\n
\n\n- 1) CustomFieldTypes::TEXT<\/li>\n
- 2) CustomFieldTypes::JSON<\/li>\n
- 3) CustomFieldTypes::INT<\/li>\n
- 4) CustomFieldTypes::BOOL<\/li>\n<\/ul>\n<\/div>\n
I have removed the categories from storefront for this I have extended the category navigation file. Follow the given location
\ncustom\/plugins\/PluginRoot\/src\/Resources\/views\/storefront\/layout\/sidebar<\/p>\n
{% sw_extends '@Storefront\/storefront\/layout\/sidebar\/category-navigation.html.twig' %}\n\n{% block layout_navigation_categories_list_entry %}\n{% if not item.category.customFields.sidebar_category_active_custom_field is defined %}\n <li class=\"category-navigation-entry\">\n {% block layout_navigation_categories_link_children %}\n {{parent()}}\n {% endblock %}\n {% block layout_navigation_categories_recoursion %}\n {{parent()}}\n {% endblock %}\n <\/li>\n{% endif %}\n{% endblock %}\n<\/pre>\nLook into Screenshot on Category for new Custom Field:<\/p>\n
![\"Shopware](\"\/blog\/wp-content\/uploads\/sites\/2\/2021\/09\/Shopware-custom-field-2-1.png\")
\nHere is the screenshot of the categories with removed menus:
\n![\"shopware](\"\/blog\/wp-content\/uploads\/sites\/2\/2021\/09\/shopware-removed-menus.png\")
<\/p>\n\n","protected":false},"excerpt":{"rendered":"
Shopware’s custom field system allows you to extend entities, without writing a complete entity extension.This is possible by storing the additional data in a JSON-Field. Custom fields therefore can only be used to store scalar values. If you’d like to create associations between entities, you’ll need to use an Entity extension. Supporting custom fields with<\/p>\n","protected":false},"author":36,"featured_media":12334,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"MSN_Categories":"Uncategorized","MSN_Publish_Option":false,"MSN_Is_Local_News":false,"MSN_Is_AIAC_Included":"Empty","MSN_Location":"[]","MSN_Add_Feature_Img_On_Top_Of_Post":false,"MSN_Has_Custom_Author":false,"MSN_Custom_Author":"","MSN_Has_Custom_Canonical_Url":false,"MSN_Custom_Canonical_Url":"","_lmt_disableupdate":"","_lmt_disable":"","footnotes":""},"categories":[85],"tags":[84],"class_list":{"0":"post-12920","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-shopware","8":"tag-shopware"},"modified_by":"Marketing EmizenTech","featured_image_src":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-content\/uploads\/sites\/2\/2021\/09\/How-To-Override-A-Controller-In-Shopware-6-1.png","featured_image_src_square":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-content\/uploads\/sites\/2\/2021\/09\/How-To-Override-A-Controller-In-Shopware-6-1.png","author_info":{"display_name":"Vivek Khatri","author_link":"https:\/\/multisitelocal.ezxdemo.com\/blog\/author\/vivek"},"_links":{"self":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/posts\/12920","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/users\/36"}],"replies":[{"embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/comments?post=12920"}],"version-history":[{"count":0,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/posts\/12920\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/media\/12334"}],"wp:attachment":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/media?parent=12920"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/categories?post=12920"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/tags?post=12920"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
Note the new field that was added in the FieldCollection. That’s already it for your custom entity definition. Now go ahead and add the column to the database.<\/p>\n
<\/span>Add column in database table<\/span><\/h3>\nIf you want to support custom fields now, you have to add a new column custom_fields of type JSON to your migration.<\/p>\n
<plugin root>\/src\/Migration\/Migration1611664789Example.php\npublic function update(Connection $connection): void\n{\n $sql = <<<SQL\n CREATE TABLE IF NOT EXISTS `swag_example` (\n `id` BINARY(16) NOT NULL,\n `name` VARCHAR(255) COLLATE utf8mb4_unicode_ci,\n `description` VARCHAR(255) COLLATE utf8mb4_unicode_ci,\n `active` TINYINT(1) COLLATE utf8mb4_unicode_ci,\n\u200b\n `custom_fields` json DEFAULT NULL,\n\u200b\n `created_at` DATETIME(3) NOT NULL,\n `updated_at` DATETIME(3),\n PRIMARY KEY (`id`)\n )\n ENGINE = InnoDB\n DEFAULT CHARSET = utf8mb4\n COLLATE = utf8mb4_unicode_ci;\n SQL;\n $connection->executeStatement($sql);\n}\n<\/pre>\nCustom field always must be json field and it should default to null, since it doesn’t have to contain values.<\/p>\n
<\/span>Add translatable custom field to entity definition<\/span><\/h3>\nMake sure to understand entity translations in general first, which is explained here Add data translations. If you want your custom fields to be translatable, you can simply work with a TranslatedField here as well.<\/p>\n
<plugin root>\/src\/Core\/Content\/Example\/ExampleDefinition.php\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Field\\TranslatedField; \n\u200b\n[...]\n\u200b\nclass ExampleDefinition extends EntityDefinition\n{\n [...]\n\u200b\n protected function defineFields(): FieldCollection\n {\n return new FieldCollection([\n (new IdField('id', 'id'))->addFlags(new Required(), new PrimaryKey()),\n (new StringField('name', 'name')),\n (new StringField('description', 'description')),\n (new BoolField('active', 'active')),\n\u200b\n new TranslatedField('customFields'),\n ]);\n }\n}\n<\/pre>\nJust add the TranslatedField and apply customFields as a parameter.
\nIn your translated entity definition, you then add the CustomFields field instead.<\/p>\n
<plugin root>\/src\/Core\/Content\/Example\/Aggregate\/ExampleTranslation\/ExampleTranslationDefinition.php\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Field\\CustomFields; \n[...]\nclass ExampleTranslationDefinition extends EntityTranslationDefinition\n{\n [...]\n\u200b\n protected function defineFields(): FieldCollection\n {\n return new FieldCollection([\n (new StringField('name', 'name'))->addFlags(new Required()),\n\u200b\n new CustomFields()\n ]);\n }\n}\n<\/pre>\n<\/span>Add custom fields to an entity<\/span><\/h3>\nDefining a custom field set is not necessary it is only necessary, if you want it to be editable in the administration or if you need validation when writing your custom field.<\/p>\n
Because of that, we’ll start with filling data to an actual entities’ custom field, before actually defining it.<\/p>\n
Filling data into custom fields<\/h4>\n$this->swagExampleRepository->upsert([[\n 'id' => '<your ID here>',\n 'customFields' => ['swag_example_size' => 15]\n]], $context);\n<\/pre>\nYou can write any valid json you want to write in custom Field. Example:<\/p>\n
$this->swagExampleRepository->upsert([[\n 'id' => '<your ID here>',\n 'customFields' => [ 'foo' => 'bar', 'baz' => [] ]\n]], $context);\n<\/pre>\nAdding an actual custom field<\/h4>\n
You can skip this section if you do not want your new custom field to be editable in the administration.<\/p>\n
use Shopware\\Core\\System\\CustomField\\CustomFieldTypes;<\/p>\n
[...]\n\n$this->customFieldSetRepository->create([\n [\n 'name' => 'swag_example_set',\n 'config' => [\n 'label' => [\n 'en-GB' => 'English custom field set label',\n 'de-DE' => 'German custom field set label'\n ]\n ],\n 'customFields' => [\n [\n 'name' => 'swag_example_size',\n 'type' => CustomFieldTypes::INT,\n 'config' => [\n 'label' => [\n 'en-GB' => 'English custom field label',\n 'de-DE' => 'German custom field label'\n ],\n 'customFieldPosition' => 1\n ]\n ]\n ]\n ]\n], $context);\n<\/pre>\n<\/span>Here is the example of removing some categories from navigation menu.<\/span><\/h3>\nI am adding a custom field which will hide menu from sidebar.<\/p>\n
custom\/plugin\/pluginRoot\/src\/pluginName.php<\/p>\n
Have a look on the screenshot:
\n<\/p>\n
Here my plugin name is SidebarNavigation<\/p>\n
This class will perform operation on custom_field_set<\/strong><\/p>\n<?php declare(strict_types=1);\n\nnamespace SidebarNavigation;\n\nuse Doctrine\\DBAL\\Connection;\nuse Shopware\\Core\\Framework\\Plugin;\nuse Shopware\\Core\\Framework\\Plugin\\Context\\UninstallContext;\nuse Shopware\\Core\\Framework\\Plugin\\Context\\InstallContext;\nuse Shopware\\Core\\Framework\\Context;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\IdSearchResult;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Criteria;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Filter\\EqualsAnyFilter;\nuse SidebarNavigation\\Services\\SidebarNavigationCustomFieldSetService;\n\nclass SidebarNavigation extends Plugin\n{\n public function install(InstallContext $installContext): void\n {\n parent::install($installContext);\n\n $SidebarNavigationCustomFieldSetService = new SidebarNavigationCustomFieldSetService(\n $this->container->get('custom_field_set.repository')\n );\n\n \/** @var Context $context *\/\n $context = $installContext->getContext();\n\n $SidebarNavigationCustomFieldSetService->createCategoryCustomFieldSet($context);\n }\n\n public function uninstall(UninstallContext $context): void\n {\n parent::uninstall($context);\n if ($context->keepUserData()) {\n return;\n }\n\n $this->removeCustomFields($context);\n }\n\n private function removeCustomFields(UninstallContext $uninstallContext)\n {\n $customFieldSetRepository = $this->container->get('custom_field_set.repository');\n\n \/** @var Context $context *\/\n $context = $uninstallContext->getContext();\n\n \/\/ Delete custom field set\n\n $this->deleteCustomFieldSet(\n $context,\n $customFieldSetRepository,\n SidebarNavigationCustomFieldSetService::SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET\n );\n }\n\n private function deleteCustomFieldSet(Context $context, $customFieldSetRepository, string $customFieldSet): void\n {\n $customFieldIds = $this->getCustomFieldSetIds($context, $customFieldSet);\n\n if ($customFieldIds) {\n $customFieldSetRepository->delete(array_values($customFieldIds->getData()), $context);\n }\n }\n\n private function getCustomFieldSetIds(Context $context, string $customFieldSet): ?IdSearchResult\n {\n $customFieldSetRepository = $this->container->get('custom_field_set.repository');\n\n $criteria = new Criteria();\n $criteria->addFilter(new EqualsAnyFilter('name', [$customFieldSet]));\n\n $customFieldIds = $customFieldSetRepository->searchIds($criteria, $context);\n\n return $customFieldIds->getTotal() > 0 ? $customFieldIds : null;\n }\n}\n<\/pre>\nThen create a service on the given location which will create custom field:<\/p>\n
\/custom\/plugins\/PluginRoot\/src\/Services<\/p>\n
<?php declare(strict_types=1);\n\nnamespace SidebarNavigation\\Services;\n\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\EntityRepositoryInterface;\nuse Shopware\\Core\\System\\CustomField\\CustomFieldTypes;\nuse Shopware\\Core\\Framework\\Context;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Criteria;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Filter\\EqualsFilter;\nuse Shopware\\Core\\System\\CustomField\\Aggregate\\CustomFieldSet\\CustomFieldSetCollection;\nuse Shopware\\Core\\Framework\\Uuid\\Uuid;\n\nclass SidebarNavigationCustomFieldSetService {\n \/\/custom field set\n public const SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET = 'sidebar_category_navigation_custom_field_set';\n\n public const SIDEBAR_CATEGORY_ACTIVE_CUSTOM_FIELD = 'sidebar_category_active_custom_field';\n \/**\n * @var EntityRepositoryInterface\n *\/\n private $customFieldSetRepository;\n\n public function __construct(EntityRepositoryInterface $customFieldSetRepository)\n {\n $this->customFieldSetRepository = $customFieldSetRepository;\n }\n\n public function createCategoryCustomFieldSet(Context $context): void\n {\n $criteria = new Criteria();\n $criteria->addFilter(new EqualsFilter('name', self::SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET));\n\n \/** @var CustomFieldSetCollection $customFieldSets *\/\n $customFieldSets = $this->customFieldSetRepository->search($criteria, $context)->getEntities();\n\n if (!count($customFieldSets)) {\n $this->customFieldSetRepository->create([\n [\n 'name' => self::SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET,\n 'global' => true,\n 'config' => [\n 'label' => [\n 'de-DE' => 'Sidebar (Navigation)',\n 'en-GB' => 'Sidebar (Navigation)'\n ]\n ],\n 'customFields' => [\n [\n 'name' => self::SIDEBAR_CATEGORY_ACTIVE_CUSTOM_FIELD,\n 'type' => CustomFieldTypes::SWITCH,\n 'config' => [\n 'label' => [\n 'de-DE' => 'Hide in sidebar navigation',\n 'en-GB' => 'Hide in sidebar navigation'\n ],\n\/\/Here I am creating SWITCH type field, we can create any field you want.\n 'componentName' => 'sw-field',\n 'type' => CustomFieldTypes::SWITCH,\n 'customFieldType' => CustomFieldTypes::SWITCH,\n 'customFieldPosition' => 1\n ]\n ]\n ],\n 'relations' => [\n [\n 'id' => Uuid::randomHex(),\n 'entityName' => 'category' \/\/ You can use any entity where you want to create custom field.\n ]\n ]\n ]\n ], $context);\n\n \n }\n }\n}\n<\/pre>\nHere are some more types of custom fields:<\/p>\n
\n\n- 1) CustomFieldTypes::TEXT<\/li>\n
- 2) CustomFieldTypes::JSON<\/li>\n
- 3) CustomFieldTypes::INT<\/li>\n
- 4) CustomFieldTypes::BOOL<\/li>\n<\/ul>\n<\/div>\n
I have removed the categories from storefront for this I have extended the category navigation file. Follow the given location
\ncustom\/plugins\/PluginRoot\/src\/Resources\/views\/storefront\/layout\/sidebar<\/p>\n
{% sw_extends '@Storefront\/storefront\/layout\/sidebar\/category-navigation.html.twig' %}\n\n{% block layout_navigation_categories_list_entry %}\n{% if not item.category.customFields.sidebar_category_active_custom_field is defined %}\n <li class=\"category-navigation-entry\">\n {% block layout_navigation_categories_link_children %}\n {{parent()}}\n {% endblock %}\n {% block layout_navigation_categories_recoursion %}\n {{parent()}}\n {% endblock %}\n <\/li>\n{% endif %}\n{% endblock %}\n<\/pre>\nLook into Screenshot on Category for new Custom Field:<\/p>\n
\nHere is the screenshot of the categories with removed menus:
\n<\/p>\n\n","protected":false},"excerpt":{"rendered":"
Shopware’s custom field system allows you to extend entities, without writing a complete entity extension.This is possible by storing the additional data in a JSON-Field. Custom fields therefore can only be used to store scalar values. If you’d like to create associations between entities, you’ll need to use an Entity extension. Supporting custom fields with<\/p>\n","protected":false},"author":36,"featured_media":12334,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"MSN_Categories":"Uncategorized","MSN_Publish_Option":false,"MSN_Is_Local_News":false,"MSN_Is_AIAC_Included":"Empty","MSN_Location":"[]","MSN_Add_Feature_Img_On_Top_Of_Post":false,"MSN_Has_Custom_Author":false,"MSN_Custom_Author":"","MSN_Has_Custom_Canonical_Url":false,"MSN_Custom_Canonical_Url":"","_lmt_disableupdate":"","_lmt_disable":"","footnotes":""},"categories":[85],"tags":[84],"class_list":{"0":"post-12920","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-shopware","8":"tag-shopware"},"modified_by":"Marketing EmizenTech","featured_image_src":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-content\/uploads\/sites\/2\/2021\/09\/How-To-Override-A-Controller-In-Shopware-6-1.png","featured_image_src_square":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-content\/uploads\/sites\/2\/2021\/09\/How-To-Override-A-Controller-In-Shopware-6-1.png","author_info":{"display_name":"Vivek Khatri","author_link":"https:\/\/multisitelocal.ezxdemo.com\/blog\/author\/vivek"},"_links":{"self":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/posts\/12920","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/users\/36"}],"replies":[{"embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/comments?post=12920"}],"version-history":[{"count":0,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/posts\/12920\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/media\/12334"}],"wp:attachment":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/media?parent=12920"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/categories?post=12920"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/tags?post=12920"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
Custom field always must be json field and it should default to null, since it doesn’t have to contain values.<\/p>\n
<\/span>Add translatable custom field to entity definition<\/span><\/h3>\nMake sure to understand entity translations in general first, which is explained here Add data translations. If you want your custom fields to be translatable, you can simply work with a TranslatedField here as well.<\/p>\n
<plugin root>\/src\/Core\/Content\/Example\/ExampleDefinition.php\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Field\\TranslatedField; \n\u200b\n[...]\n\u200b\nclass ExampleDefinition extends EntityDefinition\n{\n [...]\n\u200b\n protected function defineFields(): FieldCollection\n {\n return new FieldCollection([\n (new IdField('id', 'id'))->addFlags(new Required(), new PrimaryKey()),\n (new StringField('name', 'name')),\n (new StringField('description', 'description')),\n (new BoolField('active', 'active')),\n\u200b\n new TranslatedField('customFields'),\n ]);\n }\n}\n<\/pre>\nJust add the TranslatedField and apply customFields as a parameter.
\nIn your translated entity definition, you then add the CustomFields field instead.<\/p>\n
<plugin root>\/src\/Core\/Content\/Example\/Aggregate\/ExampleTranslation\/ExampleTranslationDefinition.php\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Field\\CustomFields; \n[...]\nclass ExampleTranslationDefinition extends EntityTranslationDefinition\n{\n [...]\n\u200b\n protected function defineFields(): FieldCollection\n {\n return new FieldCollection([\n (new StringField('name', 'name'))->addFlags(new Required()),\n\u200b\n new CustomFields()\n ]);\n }\n}\n<\/pre>\n<\/span>Add custom fields to an entity<\/span><\/h3>\nDefining a custom field set is not necessary it is only necessary, if you want it to be editable in the administration or if you need validation when writing your custom field.<\/p>\n
Because of that, we’ll start with filling data to an actual entities’ custom field, before actually defining it.<\/p>\n
Filling data into custom fields<\/h4>\n$this->swagExampleRepository->upsert([[\n 'id' => '<your ID here>',\n 'customFields' => ['swag_example_size' => 15]\n]], $context);\n<\/pre>\nYou can write any valid json you want to write in custom Field. Example:<\/p>\n
$this->swagExampleRepository->upsert([[\n 'id' => '<your ID here>',\n 'customFields' => [ 'foo' => 'bar', 'baz' => [] ]\n]], $context);\n<\/pre>\nAdding an actual custom field<\/h4>\n
You can skip this section if you do not want your new custom field to be editable in the administration.<\/p>\n
use Shopware\\Core\\System\\CustomField\\CustomFieldTypes;<\/p>\n
[...]\n\n$this->customFieldSetRepository->create([\n [\n 'name' => 'swag_example_set',\n 'config' => [\n 'label' => [\n 'en-GB' => 'English custom field set label',\n 'de-DE' => 'German custom field set label'\n ]\n ],\n 'customFields' => [\n [\n 'name' => 'swag_example_size',\n 'type' => CustomFieldTypes::INT,\n 'config' => [\n 'label' => [\n 'en-GB' => 'English custom field label',\n 'de-DE' => 'German custom field label'\n ],\n 'customFieldPosition' => 1\n ]\n ]\n ]\n ]\n], $context);\n<\/pre>\n<\/span>Here is the example of removing some categories from navigation menu.<\/span><\/h3>\nI am adding a custom field which will hide menu from sidebar.<\/p>\n
custom\/plugin\/pluginRoot\/src\/pluginName.php<\/p>\n
Have a look on the screenshot:
\n<\/p>\n
Here my plugin name is SidebarNavigation<\/p>\n
This class will perform operation on custom_field_set<\/strong><\/p>\n<?php declare(strict_types=1);\n\nnamespace SidebarNavigation;\n\nuse Doctrine\\DBAL\\Connection;\nuse Shopware\\Core\\Framework\\Plugin;\nuse Shopware\\Core\\Framework\\Plugin\\Context\\UninstallContext;\nuse Shopware\\Core\\Framework\\Plugin\\Context\\InstallContext;\nuse Shopware\\Core\\Framework\\Context;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\IdSearchResult;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Criteria;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Filter\\EqualsAnyFilter;\nuse SidebarNavigation\\Services\\SidebarNavigationCustomFieldSetService;\n\nclass SidebarNavigation extends Plugin\n{\n public function install(InstallContext $installContext): void\n {\n parent::install($installContext);\n\n $SidebarNavigationCustomFieldSetService = new SidebarNavigationCustomFieldSetService(\n $this->container->get('custom_field_set.repository')\n );\n\n \/** @var Context $context *\/\n $context = $installContext->getContext();\n\n $SidebarNavigationCustomFieldSetService->createCategoryCustomFieldSet($context);\n }\n\n public function uninstall(UninstallContext $context): void\n {\n parent::uninstall($context);\n if ($context->keepUserData()) {\n return;\n }\n\n $this->removeCustomFields($context);\n }\n\n private function removeCustomFields(UninstallContext $uninstallContext)\n {\n $customFieldSetRepository = $this->container->get('custom_field_set.repository');\n\n \/** @var Context $context *\/\n $context = $uninstallContext->getContext();\n\n \/\/ Delete custom field set\n\n $this->deleteCustomFieldSet(\n $context,\n $customFieldSetRepository,\n SidebarNavigationCustomFieldSetService::SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET\n );\n }\n\n private function deleteCustomFieldSet(Context $context, $customFieldSetRepository, string $customFieldSet): void\n {\n $customFieldIds = $this->getCustomFieldSetIds($context, $customFieldSet);\n\n if ($customFieldIds) {\n $customFieldSetRepository->delete(array_values($customFieldIds->getData()), $context);\n }\n }\n\n private function getCustomFieldSetIds(Context $context, string $customFieldSet): ?IdSearchResult\n {\n $customFieldSetRepository = $this->container->get('custom_field_set.repository');\n\n $criteria = new Criteria();\n $criteria->addFilter(new EqualsAnyFilter('name', [$customFieldSet]));\n\n $customFieldIds = $customFieldSetRepository->searchIds($criteria, $context);\n\n return $customFieldIds->getTotal() > 0 ? $customFieldIds : null;\n }\n}\n<\/pre>\nThen create a service on the given location which will create custom field:<\/p>\n
\/custom\/plugins\/PluginRoot\/src\/Services<\/p>\n
<?php declare(strict_types=1);\n\nnamespace SidebarNavigation\\Services;\n\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\EntityRepositoryInterface;\nuse Shopware\\Core\\System\\CustomField\\CustomFieldTypes;\nuse Shopware\\Core\\Framework\\Context;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Criteria;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Filter\\EqualsFilter;\nuse Shopware\\Core\\System\\CustomField\\Aggregate\\CustomFieldSet\\CustomFieldSetCollection;\nuse Shopware\\Core\\Framework\\Uuid\\Uuid;\n\nclass SidebarNavigationCustomFieldSetService {\n \/\/custom field set\n public const SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET = 'sidebar_category_navigation_custom_field_set';\n\n public const SIDEBAR_CATEGORY_ACTIVE_CUSTOM_FIELD = 'sidebar_category_active_custom_field';\n \/**\n * @var EntityRepositoryInterface\n *\/\n private $customFieldSetRepository;\n\n public function __construct(EntityRepositoryInterface $customFieldSetRepository)\n {\n $this->customFieldSetRepository = $customFieldSetRepository;\n }\n\n public function createCategoryCustomFieldSet(Context $context): void\n {\n $criteria = new Criteria();\n $criteria->addFilter(new EqualsFilter('name', self::SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET));\n\n \/** @var CustomFieldSetCollection $customFieldSets *\/\n $customFieldSets = $this->customFieldSetRepository->search($criteria, $context)->getEntities();\n\n if (!count($customFieldSets)) {\n $this->customFieldSetRepository->create([\n [\n 'name' => self::SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET,\n 'global' => true,\n 'config' => [\n 'label' => [\n 'de-DE' => 'Sidebar (Navigation)',\n 'en-GB' => 'Sidebar (Navigation)'\n ]\n ],\n 'customFields' => [\n [\n 'name' => self::SIDEBAR_CATEGORY_ACTIVE_CUSTOM_FIELD,\n 'type' => CustomFieldTypes::SWITCH,\n 'config' => [\n 'label' => [\n 'de-DE' => 'Hide in sidebar navigation',\n 'en-GB' => 'Hide in sidebar navigation'\n ],\n\/\/Here I am creating SWITCH type field, we can create any field you want.\n 'componentName' => 'sw-field',\n 'type' => CustomFieldTypes::SWITCH,\n 'customFieldType' => CustomFieldTypes::SWITCH,\n 'customFieldPosition' => 1\n ]\n ]\n ],\n 'relations' => [\n [\n 'id' => Uuid::randomHex(),\n 'entityName' => 'category' \/\/ You can use any entity where you want to create custom field.\n ]\n ]\n ]\n ], $context);\n\n \n }\n }\n}\n<\/pre>\nHere are some more types of custom fields:<\/p>\n
\n\n- 1) CustomFieldTypes::TEXT<\/li>\n
- 2) CustomFieldTypes::JSON<\/li>\n
- 3) CustomFieldTypes::INT<\/li>\n
- 4) CustomFieldTypes::BOOL<\/li>\n<\/ul>\n<\/div>\n
I have removed the categories from storefront for this I have extended the category navigation file. Follow the given location
\ncustom\/plugins\/PluginRoot\/src\/Resources\/views\/storefront\/layout\/sidebar<\/p>\n
{% sw_extends '@Storefront\/storefront\/layout\/sidebar\/category-navigation.html.twig' %}\n\n{% block layout_navigation_categories_list_entry %}\n{% if not item.category.customFields.sidebar_category_active_custom_field is defined %}\n <li class=\"category-navigation-entry\">\n {% block layout_navigation_categories_link_children %}\n {{parent()}}\n {% endblock %}\n {% block layout_navigation_categories_recoursion %}\n {{parent()}}\n {% endblock %}\n <\/li>\n{% endif %}\n{% endblock %}\n<\/pre>\nLook into Screenshot on Category for new Custom Field:<\/p>\n
\nHere is the screenshot of the categories with removed menus:
\n<\/p>\n\n","protected":false},"excerpt":{"rendered":"
Shopware’s custom field system allows you to extend entities, without writing a complete entity extension.This is possible by storing the additional data in a JSON-Field. Custom fields therefore can only be used to store scalar values. If you’d like to create associations between entities, you’ll need to use an Entity extension. Supporting custom fields with<\/p>\n","protected":false},"author":36,"featured_media":12334,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"MSN_Categories":"Uncategorized","MSN_Publish_Option":false,"MSN_Is_Local_News":false,"MSN_Is_AIAC_Included":"Empty","MSN_Location":"[]","MSN_Add_Feature_Img_On_Top_Of_Post":false,"MSN_Has_Custom_Author":false,"MSN_Custom_Author":"","MSN_Has_Custom_Canonical_Url":false,"MSN_Custom_Canonical_Url":"","_lmt_disableupdate":"","_lmt_disable":"","footnotes":""},"categories":[85],"tags":[84],"class_list":{"0":"post-12920","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-shopware","8":"tag-shopware"},"modified_by":"Marketing EmizenTech","featured_image_src":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-content\/uploads\/sites\/2\/2021\/09\/How-To-Override-A-Controller-In-Shopware-6-1.png","featured_image_src_square":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-content\/uploads\/sites\/2\/2021\/09\/How-To-Override-A-Controller-In-Shopware-6-1.png","author_info":{"display_name":"Vivek Khatri","author_link":"https:\/\/multisitelocal.ezxdemo.com\/blog\/author\/vivek"},"_links":{"self":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/posts\/12920","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/users\/36"}],"replies":[{"embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/comments?post=12920"}],"version-history":[{"count":0,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/posts\/12920\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/media\/12334"}],"wp:attachment":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/media?parent=12920"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/categories?post=12920"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/tags?post=12920"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
Just add the TranslatedField and apply customFields as a parameter.
\nIn your translated entity definition, you then add the CustomFields field instead.<\/p>\n
<plugin root>\/src\/Core\/Content\/Example\/Aggregate\/ExampleTranslation\/ExampleTranslationDefinition.php\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Field\\CustomFields; \n[...]\nclass ExampleTranslationDefinition extends EntityTranslationDefinition\n{\n [...]\n\u200b\n protected function defineFields(): FieldCollection\n {\n return new FieldCollection([\n (new StringField('name', 'name'))->addFlags(new Required()),\n\u200b\n new CustomFields()\n ]);\n }\n}\n<\/pre>\n<\/span>Add custom fields to an entity<\/span><\/h3>\nDefining a custom field set is not necessary it is only necessary, if you want it to be editable in the administration or if you need validation when writing your custom field.<\/p>\n
Because of that, we’ll start with filling data to an actual entities’ custom field, before actually defining it.<\/p>\n
Filling data into custom fields<\/h4>\n$this->swagExampleRepository->upsert([[\n 'id' => '<your ID here>',\n 'customFields' => ['swag_example_size' => 15]\n]], $context);\n<\/pre>\nYou can write any valid json you want to write in custom Field. Example:<\/p>\n
$this->swagExampleRepository->upsert([[\n 'id' => '<your ID here>',\n 'customFields' => [ 'foo' => 'bar', 'baz' => [] ]\n]], $context);\n<\/pre>\nAdding an actual custom field<\/h4>\n
You can skip this section if you do not want your new custom field to be editable in the administration.<\/p>\n
use Shopware\\Core\\System\\CustomField\\CustomFieldTypes;<\/p>\n
[...]\n\n$this->customFieldSetRepository->create([\n [\n 'name' => 'swag_example_set',\n 'config' => [\n 'label' => [\n 'en-GB' => 'English custom field set label',\n 'de-DE' => 'German custom field set label'\n ]\n ],\n 'customFields' => [\n [\n 'name' => 'swag_example_size',\n 'type' => CustomFieldTypes::INT,\n 'config' => [\n 'label' => [\n 'en-GB' => 'English custom field label',\n 'de-DE' => 'German custom field label'\n ],\n 'customFieldPosition' => 1\n ]\n ]\n ]\n ]\n], $context);\n<\/pre>\n<\/span>Here is the example of removing some categories from navigation menu.<\/span><\/h3>\nI am adding a custom field which will hide menu from sidebar.<\/p>\n
custom\/plugin\/pluginRoot\/src\/pluginName.php<\/p>\n
Have a look on the screenshot:
\n<\/p>\n
Here my plugin name is SidebarNavigation<\/p>\n
This class will perform operation on custom_field_set<\/strong><\/p>\n<?php declare(strict_types=1);\n\nnamespace SidebarNavigation;\n\nuse Doctrine\\DBAL\\Connection;\nuse Shopware\\Core\\Framework\\Plugin;\nuse Shopware\\Core\\Framework\\Plugin\\Context\\UninstallContext;\nuse Shopware\\Core\\Framework\\Plugin\\Context\\InstallContext;\nuse Shopware\\Core\\Framework\\Context;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\IdSearchResult;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Criteria;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Filter\\EqualsAnyFilter;\nuse SidebarNavigation\\Services\\SidebarNavigationCustomFieldSetService;\n\nclass SidebarNavigation extends Plugin\n{\n public function install(InstallContext $installContext): void\n {\n parent::install($installContext);\n\n $SidebarNavigationCustomFieldSetService = new SidebarNavigationCustomFieldSetService(\n $this->container->get('custom_field_set.repository')\n );\n\n \/** @var Context $context *\/\n $context = $installContext->getContext();\n\n $SidebarNavigationCustomFieldSetService->createCategoryCustomFieldSet($context);\n }\n\n public function uninstall(UninstallContext $context): void\n {\n parent::uninstall($context);\n if ($context->keepUserData()) {\n return;\n }\n\n $this->removeCustomFields($context);\n }\n\n private function removeCustomFields(UninstallContext $uninstallContext)\n {\n $customFieldSetRepository = $this->container->get('custom_field_set.repository');\n\n \/** @var Context $context *\/\n $context = $uninstallContext->getContext();\n\n \/\/ Delete custom field set\n\n $this->deleteCustomFieldSet(\n $context,\n $customFieldSetRepository,\n SidebarNavigationCustomFieldSetService::SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET\n );\n }\n\n private function deleteCustomFieldSet(Context $context, $customFieldSetRepository, string $customFieldSet): void\n {\n $customFieldIds = $this->getCustomFieldSetIds($context, $customFieldSet);\n\n if ($customFieldIds) {\n $customFieldSetRepository->delete(array_values($customFieldIds->getData()), $context);\n }\n }\n\n private function getCustomFieldSetIds(Context $context, string $customFieldSet): ?IdSearchResult\n {\n $customFieldSetRepository = $this->container->get('custom_field_set.repository');\n\n $criteria = new Criteria();\n $criteria->addFilter(new EqualsAnyFilter('name', [$customFieldSet]));\n\n $customFieldIds = $customFieldSetRepository->searchIds($criteria, $context);\n\n return $customFieldIds->getTotal() > 0 ? $customFieldIds : null;\n }\n}\n<\/pre>\nThen create a service on the given location which will create custom field:<\/p>\n
\/custom\/plugins\/PluginRoot\/src\/Services<\/p>\n
<?php declare(strict_types=1);\n\nnamespace SidebarNavigation\\Services;\n\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\EntityRepositoryInterface;\nuse Shopware\\Core\\System\\CustomField\\CustomFieldTypes;\nuse Shopware\\Core\\Framework\\Context;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Criteria;\nuse Shopware\\Core\\Framework\\DataAbstractionLayer\\Search\\Filter\\EqualsFilter;\nuse Shopware\\Core\\System\\CustomField\\Aggregate\\CustomFieldSet\\CustomFieldSetCollection;\nuse Shopware\\Core\\Framework\\Uuid\\Uuid;\n\nclass SidebarNavigationCustomFieldSetService {\n \/\/custom field set\n public const SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET = 'sidebar_category_navigation_custom_field_set';\n\n public const SIDEBAR_CATEGORY_ACTIVE_CUSTOM_FIELD = 'sidebar_category_active_custom_field';\n \/**\n * @var EntityRepositoryInterface\n *\/\n private $customFieldSetRepository;\n\n public function __construct(EntityRepositoryInterface $customFieldSetRepository)\n {\n $this->customFieldSetRepository = $customFieldSetRepository;\n }\n\n public function createCategoryCustomFieldSet(Context $context): void\n {\n $criteria = new Criteria();\n $criteria->addFilter(new EqualsFilter('name', self::SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET));\n\n \/** @var CustomFieldSetCollection $customFieldSets *\/\n $customFieldSets = $this->customFieldSetRepository->search($criteria, $context)->getEntities();\n\n if (!count($customFieldSets)) {\n $this->customFieldSetRepository->create([\n [\n 'name' => self::SIDEBAR_CATEGORY_NAVIGATION_CUSTOM_FIELD_SET,\n 'global' => true,\n 'config' => [\n 'label' => [\n 'de-DE' => 'Sidebar (Navigation)',\n 'en-GB' => 'Sidebar (Navigation)'\n ]\n ],\n 'customFields' => [\n [\n 'name' => self::SIDEBAR_CATEGORY_ACTIVE_CUSTOM_FIELD,\n 'type' => CustomFieldTypes::SWITCH,\n 'config' => [\n 'label' => [\n 'de-DE' => 'Hide in sidebar navigation',\n 'en-GB' => 'Hide in sidebar navigation'\n ],\n\/\/Here I am creating SWITCH type field, we can create any field you want.\n 'componentName' => 'sw-field',\n 'type' => CustomFieldTypes::SWITCH,\n 'customFieldType' => CustomFieldTypes::SWITCH,\n 'customFieldPosition' => 1\n ]\n ]\n ],\n 'relations' => [\n [\n 'id' => Uuid::randomHex(),\n 'entityName' => 'category' \/\/ You can use any entity where you want to create custom field.\n ]\n ]\n ]\n ], $context);\n\n \n }\n }\n}\n<\/pre>\nHere are some more types of custom fields:<\/p>\n
\n\n- 1) CustomFieldTypes::TEXT<\/li>\n
- 2) CustomFieldTypes::JSON<\/li>\n
- 3) CustomFieldTypes::INT<\/li>\n
- 4) CustomFieldTypes::BOOL<\/li>\n<\/ul>\n<\/div>\n
I have removed the categories from storefront for this I have extended the category navigation file. Follow the given location
\ncustom\/plugins\/PluginRoot\/src\/Resources\/views\/storefront\/layout\/sidebar<\/p>\n
{% sw_extends '@Storefront\/storefront\/layout\/sidebar\/category-navigation.html.twig' %}\n\n{% block layout_navigation_categories_list_entry %}\n{% if not item.category.customFields.sidebar_category_active_custom_field is defined %}\n <li class=\"category-navigation-entry\">\n {% block layout_navigation_categories_link_children %}\n {{parent()}}\n {% endblock %}\n {% block layout_navigation_categories_recoursion %}\n {{parent()}}\n {% endblock %}\n <\/li>\n{% endif %}\n{% endblock %}\n<\/pre>\nLook into Screenshot on Category for new Custom Field:<\/p>\n
\nHere is the screenshot of the categories with removed menus:
\n<\/p>\n\n","protected":false},"excerpt":{"rendered":"
Shopware’s custom field system allows you to extend entities, without writing a complete entity extension.This is possible by storing the additional data in a JSON-Field. Custom fields therefore can only be used to store scalar values. If you’d like to create associations between entities, you’ll need to use an Entity extension. Supporting custom fields with<\/p>\n","protected":false},"author":36,"featured_media":12334,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"MSN_Categories":"Uncategorized","MSN_Publish_Option":false,"MSN_Is_Local_News":false,"MSN_Is_AIAC_Included":"Empty","MSN_Location":"[]","MSN_Add_Feature_Img_On_Top_Of_Post":false,"MSN_Has_Custom_Author":false,"MSN_Custom_Author":"","MSN_Has_Custom_Canonical_Url":false,"MSN_Custom_Canonical_Url":"","_lmt_disableupdate":"","_lmt_disable":"","footnotes":""},"categories":[85],"tags":[84],"class_list":{"0":"post-12920","1":"post","2":"type-post","3":"status-publish","4":"format-standard","5":"has-post-thumbnail","7":"category-shopware","8":"tag-shopware"},"modified_by":"Marketing EmizenTech","featured_image_src":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-content\/uploads\/sites\/2\/2021\/09\/How-To-Override-A-Controller-In-Shopware-6-1.png","featured_image_src_square":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-content\/uploads\/sites\/2\/2021\/09\/How-To-Override-A-Controller-In-Shopware-6-1.png","author_info":{"display_name":"Vivek Khatri","author_link":"https:\/\/multisitelocal.ezxdemo.com\/blog\/author\/vivek"},"_links":{"self":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/posts\/12920","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/users\/36"}],"replies":[{"embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/comments?post=12920"}],"version-history":[{"count":0,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/posts\/12920\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/media\/12334"}],"wp:attachment":[{"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/media?parent=12920"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/categories?post=12920"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/multisitelocal.ezxdemo.com\/blog\/wp-json\/wp\/v2\/tags?post=12920"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}