Custom fields

The custom fields replace the free text fields known from Shopware 5 and offer you the possibility to add your own fields for the different program areas to use them for example in the products.
You can find the administration module under Settings > System > Custom fields
 

Create Set

The custom fields are no longer created directly for a program area such as products or customers, as known from Shopware 5, but are sorted into sets. The sets can then be assigned to one or more program areas.
To create a set click on the New set button, the following window will open
 

A unique technical name is required to create a new set.

Please note that the technical name cannot be changed later.

In addition, you can assign a label, which is used, among other things, for the display in the administration. The label can optionally be defined in all administration languages.

It is also necessary to make the set available for the individual program areas.

If no range is selected, this does not mean that the set is available for all ranges!

Create custom field

To open the window for creating an additional field, click on the New custom field button. 
 

The view of the modal varies depending on the type selected, as different specifications are required.
The only mandatory field for creating an additional field is the technical name. Please note, however, that for some additional field types (e.g. selection) additional fields should be filled in, as otherwise the user cannot select any useful data.

Select

A selection custom field offers you the possibility to define different options directly during the creation, from which one or more options can be selected later when using the custom field.

These configuration options are available for creating an custom selection field:

• Technical name (required): Unique name for the custom field. It can only be used once in the system and cannot be changed later.
• Position: You can use the item to sort the custom fields within the set. The lower the value, the further up the custom field is displayed.
• Required: Use this to define whether a selection is mandatory.
• Label: The label is used to assign a name that can be easily understood by the user. This name is displayed in the administration modules, for example, if the additional field is included there.
• Placeholder: Displayed in the dropdown menu as long as no selection has been made.
• Help text: The help text can be displayed by mouse over a blue question mark symbol.
• Multi select: Use the switch to define whether only one option or several can be selected.
  • Technical name: Also, each of the options for selection requires a unique technical name
  • Label: A label describing the option can be assigned for better presentation. This label is then also displayed in the selection list instead of the technical name.
• add option: This button allows you to add the input fields for another option.

Exemplary view in the administration
 
   

Text field

These configuration options are available for creating a text field:

• Technical name (required): Unique name for the custom field. It can only be used once in the system and cannot be changed later.
• Position: You can use the item to sort the custom fields within the set. The lower the value, the further up the custom field is displayed.
• Required: Use this to define whether a selection is mandatory.
• Label: The label is used to assign a name that can be easily understood by the user. This name is displayed in the administration modules, for example, if the additional field is included there.
• Placeholder: Displayed as long as no entry has been made.
• Help text: The help text can be displayed by mouse over a blue question mark symbol.

Exemplary view in the administration
 

Media

Offers the option of adding a media file to display it on the product details page, for example, with a template adjustment in the frontend.

The following configuration options are available for creating an custom media field:

• Technical name (required): Unique name for the custom field. It can only be used once in the system and cannot be changed later.
• Position: You can use the item to sort the custom fields within the set. The lower the value, the further up the custom field is displayed.
• Required: Use this to define whether a selection is mandatory.
• Label: The label is used to assign a name that can be easily understood by the user. This name is displayed in the administration modules, for example, if the additional field is included there.

Exemplary view in the administration

   

Number

Provides a field for entering numbers.

The following configuration options are available for creating an custom number field:

• Technical name (required): Unique name for the custom field. It can only be used once in the system and cannot be changed later.
• Position: You can use the item to sort the custom fields within the set. The lower the value, the further up the custom field is displayed.
• Required: Use this to define whether a selection is mandatory.
• Label: The label is used to assign a name that can be easily understood by the user. This name is displayed in the administration modules, for example, if the additional field is included there.
• Placeholder: Displayed as long as no entry has been made.
• Help text: The help text can be displayed by mouse over a blue question mark symbol.
• Number type: Here you can choose whether the possible entries are an integer or a float.
• Steps: Defines the steps that are possible to enter the number. This allows you, for example, to ensure that a certain scale is always adhered to.
• Min: Specify the smallest possible input
• Maximum: Specify the largest input possible

Exemplary view in the administration
 

Date / Time

Provides a selection mask for selecting a date and time.

The following configuration options are available for creating a date/time selection:

• Technical name (required): Unique name for the custom field. It can only be used once in the system and cannot be changed later.
• Position: You can use the item to sort the custom fields within the set. The lower the value, the further up the custom field is displayed.
• Required: Use this to define whether a selection is mandatory.
• Label: The label is used to assign a name that can be easily understood by the user. This name is displayed in the administration modules, for example, if the additional field is included there.
• Help text: The help text can be displayed by mouse over a blue question mark symbol.

Exemplary view in the administration
 

Checkbox

This gives you the simple option of including a checkbox that provides a boolean data set ("0"/"1") in the background.

The following configuration options are available for creating a checkbox:

• Technical name (required): Unique name for the custom field. It can only be used once in the system and cannot be changed later.
• Position: You can use the item to sort the custom fields within the set. The lower the value, the further up the custom field is displayed.
• Required: Use this to define whether a selection is mandatory.
• Label: The label is used to assign a name that can be easily understood by the user. This name is displayed in the administration modules, for example, if the additional field is included there.
• Help text: The help text can be displayed by mouse over a blue question mark symbol.

Exemplary view in the administration
 

Active/Inactive switch

Includes a switch that provides a boolean data set ("0"/"1") in the background.

The following configuration options are available for creating an active/inactive switch:

• Technical name (required): Unique name for the custom field. It can only be used once in the system and cannot be changed later.
• Position: You can use the item to sort the custom fields within the set. The lower the value, the further up the custom field is displayed.
• Required: Use this to define whether a selection is mandatory.
• Label: The label is used to assign a name that can be easily understood by the user. This name is displayed in the administration modules, for example, if the additional field is included there.
• Help text: The help text can be displayed by mouse over a blue question mark symbol.

Exemplary view in the administration
 

Text Editor

Provides a text editor that allows you to easily enter styled text and include it in the template, e.g. using variables.

The following configuration options are available for creating a text editor:

• Technical name (required): Unique name for the custom field. It can only be used once in the system and cannot be changed later.
• Position: You can use the item to sort the custom fields within the set. The lower the value, the further up the custom field is displayed.
• Required: Use this to define whether a selection is mandatory.
• Label: The label is used to assign a name that can be easily understood by the user. This name is displayed in the administration modules, for example, if the additional field is included there.
• Placeholder: Displayed as long as no entry has been made.

Exemplary view in the administration
 

Color picker

Allows you to select a color by selecting from a color palette or entering the HEX color code.

The following configuration options are available for creating a color picker:

• Technical name (required): Unique name for the custom field. It can only be used once in the system and cannot be changed later.
• Position: You can use the item to sort the custom fields within the set. The lower the value, the further up the custom field is displayed.
• Required: Use this to define whether a selection is mandatory.
• Label: The label is used to assign a name that can be easily understood by the user. This name is displayed in the administration modules, for example, if the additional field is included there.

Exemplary view in the administration
 

 

Include custom field in the storefront

If you want to display the content of an custom field in the storefront, a template adjustment is necessary.
This is explained in detail in the article changing  a template.