Joomla! Documentation - User contributions [en]

J5.x:Adding custom fields/Color Field

2023-08-26T13:23:17Z

Crystalenka: Created page with "<noinclude><languages /></noinclude> <noinclude>{{Joomla version|version=5.x}}</noinclude> {{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-col..."

J5.x:Adding custom fields/Checkboxes Field

2023-08-26T13:22:41Z

Crystalenka:

J4.x:Adding custom fields/Color Field

2023-08-26T13:22:06Z

Crystalenka: Created page with "<noinclude><languages /></noinclude> <noinclude>{{Joomla version|version=4.x}}</noinclude> {{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-col..."

J4.x:Adding custom fields/Checkboxes Field

2023-08-26T13:20:07Z

Crystalenka:

J5.x:Adding custom fields/Checkboxes Field

2023-08-26T13:17:30Z

J4.x:Adding custom fields/Checkboxes Field

2023-08-26T13:16:28Z

Crystalenka:

J4.x:Adding custom fields/Checkboxes Field

2023-08-26T13:15:21Z

Crystalenka:

J4.x:Adding custom fields/Checkboxes Field

2023-08-26T13:12:59Z

J5.x:Adding custom fields/Calendar Field

2023-08-26T12:54:48Z

Crystalenka: Copying from the 4.x page as a starting point.

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=5.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
Tutorial<br>Custom Fields - Creating a Calendar Field}}

== Introduction ==

The Calendar Field provides an input box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.

It provides you with a way for Editors to enter dates that will be consistent in position and format, dependent on how you use it.

=== Related Information ===

See:

*[http://php.net/manual/en/datetime.formats.date.php Date Formats]

== Creating the field ==

We will create a Calendar Field for use in our articles.

In this example we will add a visited date on our aircraft pages.

From the Sidebar Menu in the Backend choose '''Content''' then '''Fields'''.

[[File:j4.x_new_article_custom_field.png|Access article fields via the sidebar menu|300px]]

Before clicking the '''New''' button, check the dropdown list below the New button is set to '''Article''' - this is the default setting for use in the Article view.

'''NOTE:''' Although this tutorial covers creating a calendar field for use in an article, the following steps are the same if you were creating one for use in the Contacts Component (remember to set the view before clicking new) or for use in the Users Component.

Click '''New'''.

The Field Editor will open on the '''General''' tab.

[[File:j4.x_new_calendar_field_general.png|Editor General Tab|800px]]

Enter a '''Title''' This should be specific to the purpose of the new field. Avoid generic titles in case you want to use other calendar fields in other places.

On the '''Type''' field choose '''Calendar'''.

The '''Name''' field will be filled in automatically on saving the field but you can enter a different one. It should be lowercase and separated by hyphens.

The '''Label''' field is automatically set to be the same as the Custom Field Title but you can enter whatever you want. The value you enter is output on the Frontend if you choose to show the Label.

Add a '''Description''' if it will be useful. It is not required.

Set the '''Required''' Field to Yes or No with the toggle button. Setting to Yes will make the field a required one that cannot be skipped.

The '''Only Use In Subform''' field can be set to Yes if you only want the field available as a Subform child field.

If you use the '''Default Date''' the value can be an ISO 8601 format (YYYY-MM-DD HH:MM:SS) or NOW, which displays the actual date. '''Caution''': Even if you do not specify the time in the default date, the time is displayed when the option ''Show time'' is active.

Special options within this field are:

* Show time<br />If enabled, the calendar field expects a date and time and will also display the time. The formats are localized using the regular language strings.

== Restricting availability of the Custom Field ==

In the example shown we have set a Field Group of Aircraft. This means the Custom Field will be available via a tab named Aircraft in the Article Editor.

The Custom Field has also been set to use the Aircraft category. This means the Custom Field will only be available in articles set to the Aircraft category.

At this point you have entered sufficient information to create the Custom Field and make it available for use.

== Calendar Custom Field Options ==

=== Form Options ===

Options for using the Custom Field Form.

'''Placeholder''' - You can add a placeholder to guide authors.

'''Field Class''' - You can add a class used in your CSS style sheet to style the field.

'''Label Class (Form)''' - You can add a class used in your CSS style sheet to style the label in the form.

'''Editable In''' - Set for Frontend Editing, Backend Editing or both.

=== Display Options ===

Options for the display of the Custom Field Output on the Frontend.

'''Display Class''' - You can add a class that is used in your style sheet to target the container that holds or wraps the field.

'''Value Class''' - You can add a class that is used in your style sheet to target the styling of the field.

'''Label''' - Show or hide the Custom Field Label.

'''Label Class (Output)''' - You can add a class that is used in your style sheet to target the the styling of the Custom Field Label that is output.

'''Automatic Display''' - This is closely linked to the Component Output.

* ''After Title'' places the field output after the Component Title (after the article title, contact title or user title)

* ''Before Display Content'' (above the article, contact, or user content)

* ''After Display Content'' (below the article, contact, or user contact)

Note that these 3 settings assume default Joomla! output and could look different with other templates or if Custom Overrides are in use.

* ''Do not automatically display'' will only display the output where you choose to display it by using Joomla's Insert Field function or your custom overrides if you use them.

'''Prefix''' You can add a Prefix to be output before the Custom Field output.

'''Suffix''' You can add a Suffix to be output after the Custom Field output.

'''Layout''' If they are used, you can select an alternative layout for the Custom Field

'''Display when Read-Only''' If you need to hide the field - this relates to user access control levels (ACL)

== Save the Custom Field ==

Click '''Save & Close''' and the Custom Field is available to use.

== Using the field in the Backend ==

In the Article Editor select the Custom Fields tab to access the Custom Field. In the this example we have a Field Group named '''Aircraft''' that was assigned to the Category ''Aircraft''. As the Article is assigned to the Aircraft category, the Aircraft tab is available that will contain one or more Custom Fields assigned to that Field Group. If you are not using Field Groups look for a tab named '''Fields'''.

[[File:j4.x_field_group_editor_tab-en.png|Custom Fields Editor Tab in the Backend|800px]]

Once you have selected the tab it will display all the fields you have created. In this example we have only the Date Visited field we created. Note the asterisks symbol - it denotes that it is a required field (this is turned off or on in the field options when you create it).

Click the calendar icon to open the calendar date picker and select the date. When you have done, save and close the article.

[[File:j4.x_backend_use_article_custom_field-en.png|Use Calendar Custom Field in the Backend|800px]]

== Frontend Output of the Calendar Custom Field ==

In the Frontend, you can see the field as you see in the following image. The option in ''Automatic display'' is responsible for the position of the field and your template is responsible for the layout of the field.

Fields are only displayed in the Frontend if you have filled them with data in the article. If it is not a required field, can you forget it?

[[File:j4.x_frontend_calendar_field_output-en.png|Calendar Custom Field Frontend Output|800px]]

'''Note''' that the output is displayed with a bullet point - this is the default layout and may look different dependent on your template.

It is possible to change the layout and date format by creating a template custom override.

<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J5.x:Adding_custom_fields/Parameters for all Custom Fields|
Prev: Parameters for all Custom Fields|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J5.x:Adding_custom_fields/Checkboxes_Field|
Next: Checkboxes Field|class=expand}}</div>
</div>

<noinclude>
[[Category:Tutorials{{#translation:}}]]
[[Category:Custom Fields{{#translation:}}]]
[[Category:Beginners{{#translation:}}]]
[[Category:Joomla! 5.x{{#translation:}}]]
</noinclude>

J4.x:Adding custom fields/Calendar Field

2023-08-26T12:52:55Z

Crystalenka:

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
Tutorial<br>Custom Fields - Creating a Calendar Field}}

== Introduction ==

The Calendar Field provides an input box for entry of a date. An icon next to the text box provides a link to a pop-up calendar, which can also be used to enter the date value.

It provides you with a way for Editors to enter dates that will be consistent in position and format, dependent on how you use it.

=== Related Information ===

See:

*[http://php.net/manual/en/datetime.formats.date.php Date Formats]

== Creating the field ==

We will create a Calendar Field for use in our articles.

In this example we will add a visited date on our aircraft pages.

From the Sidebar Menu in the Backend choose '''Content''' then '''Fields'''.

[[File:j4.x_new_article_custom_field.png|Access article fields via the sidebar menu|300px]]

Before clicking the '''New''' button, check the dropdown list below the New button is set to '''Article''' - this is the default setting for use in the Article view.

'''NOTE:''' Although this tutorial covers creating a calendar field for use in an article, the following steps are the same if you were creating one for use in the Contacts Component (remember to set the view before clicking new) or for use in the Users Component.

Click '''New'''.

The Field Editor will open on the '''General''' tab.

[[File:j4.x_new_calendar_field_general.png|Editor General Tab|800px]]

Enter a '''Title''' This should be specific to the purpose of the new field. Avoid generic titles in case you want to use other calendar fields in other places.

On the '''Type''' field choose '''Calendar'''.

The '''Name''' field will be filled in automatically on saving the field but you can enter a different one. It should be lowercase and separated by hyphens.

The '''Label''' field is automatically set to be the same as the Custom Field Title but you can enter whatever you want. The value you enter is output on the Frontend if you choose to show the Label.

Add a '''Description''' if it will be useful. It is not required.

Set the '''Required''' Field to Yes or No with the toggle button. Setting to Yes will make the field a required one that cannot be skipped.

The '''Only Use In Subform''' field can be set to Yes if you only want the field available as a Subform child field.

If you use the '''Default Date''' the value can be an ISO 8601 format (YYYY-MM-DD HH:MM:SS) or NOW, which displays the actual date. '''Caution''': Even if you do not specify the time in the default date, the time is displayed when the option ''Show time'' is active.

Special options within this field are:

* Show time<br />If enabled, the calendar field expects a date and time and will also display the time. The formats are localized using the regular language strings.

== Restricting availability of the Custom Field ==

In the example shown we have set a Field Group of Aircraft. This means the Custom Field will be available via a tab named Aircraft in the Article Editor.

The Custom Field has also been set to use the Aircraft category. This means the Custom Field will only be available in articles set to the Aircraft category.

At this point you have entered sufficient information to create the Custom Field and make it available for use.

== Calendar Custom Field Options ==

=== Form Options ===

Options for using the Custom Field Form.

'''Placeholder''' - You can add a placeholder to guide authors.

'''Field Class''' - You can add a class used in your CSS style sheet to style the field.

'''Label Class (Form)''' - You can add a class used in your CSS style sheet to style the label in the form.

'''Editable In''' - Set for Frontend Editing, Backend Editing or both.

=== Display Options ===

Options for the display of the Custom Field Output on the Frontend.

'''Display Class''' - You can add a class that is used in your style sheet to target the container that holds or wraps the field.

'''Value Class''' - You can add a class that is used in your style sheet to target the styling of the field.

'''Label''' - Show or hide the Custom Field Label.

'''Label Class (Output)''' - You can add a class that is used in your style sheet to target the the styling of the Custom Field Label that is output.

'''Automatic Display''' - This is closely linked to the Component Output.

* ''After Title'' places the field output after the Component Title (after the article title, contact title or user title)

* ''Before Display Content'' (above the article, contact, or user content)

* ''After Display Content'' (below the article, contact, or user contact)

Note that these 3 settings assume default Joomla! output and could look different with other templates or if Custom Overrides are in use.

* ''Do not automatically display'' will only display the output where you choose to display it by using Joomla's Insert Field function or your custom overrides if you use them.

'''Prefix''' You can add a Prefix to be output before the Custom Field output.

'''Suffix''' You can add a Suffix to be output after the Custom Field output.

'''Layout''' If they are used, you can select an alternative layout for the Custom Field

'''Display when Read-Only''' If you need to hide the field - this relates to user access control levels (ACL)

== Save the Custom Field ==

Click '''Save & Close''' and the Custom Field is available to use.

== Using the field in the Backend ==

In the Article Editor select the Custom Fields tab to access the Custom Field. In the this example we have a Field Group named '''Aircraft''' that was assigned to the Category ''Aircraft''. As the Article is assigned to the Aircraft category, the Aircraft tab is available that will contain one or more Custom Fields assigned to that Field Group. If you are not using Field Groups look for a tab named '''Fields'''.

[[File:j4.x_field_group_editor_tab-en.png|Custom Fields Editor Tab in the Backend|800px]]

Once you have selected the tab it will display all the fields you have created. In this example we have only the Date Visited field we created. Note the asterisks symbol - it denotes that it is a required field (this is turned off or on in the field options when you create it).

Click the calendar icon to open the calendar date picker and select the date. When you have done, save and close the article.

[[File:j4.x_backend_use_article_custom_field-en.png|Use Calendar Custom Field in the Backend|800px]]

== Frontend Output of the Calendar Custom Field ==

In the Frontend, you can see the field as you see in the following image. The option in ''Automatic display'' is responsible for the position of the field and your template is responsible for the layout of the field.

Fields are only displayed in the Frontend if you have filled them with data in the article. If it is not a required field, can you forget it?

[[File:j4.x_frontend_calendar_field_output-en.png|Calendar Custom Field Frontend Output|800px]]

'''Note''' that the output is displayed with a bullet point - this is the default layout and may look different dependent on your template.

It is possible to change the layout and date format by creating a template custom override.

<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields/Parameters for all Custom Fields|
Prev: Parameters for all Custom Fields|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields/Checkboxes_Field|
Next: Checkboxes Field|class=expand}}</div>
</div>

<noinclude>
[[Category:Tutorials{{#translation:}}]]
[[Category:Custom Fields{{#translation:}}]]
[[Category:Beginners{{#translation:}}]]
[[Category:Joomla! 4.x{{#translation:}}]]
</noinclude>

J5.x:Adding custom fields/Parameters for all Custom Fields

2023-08-26T12:49:49Z

Crystalenka:

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=5.x}}</noinclude>
{{Section portal heading|icon=edit|title=Parameters for all Custom Fields}}

== Parameters for all Custom Fields ==

The Custom Fields list will be empty initially. Click on '''New''' to add a field.

[[File:J4x admin fields add new field en.png|600px|frameless]]

=== Tab: General ===

; Mandatory Fields

* '''Title''': The title of the field. The title will display in the field manager page where you can open the field for editing by clicking on the title. The title is not displayed when you create an article or a contact nor in the frontend.
* '''Type''': The field type. There are 16 default field types. '''Please note: The type cannot be changed after saving the field.'''

; Optional Fields

* '''Name''': The name will be used to identify the field and must be unique. Leave this blank and Joomla will fill in a default value from the title.
* '''Label''': Use a descriptive text of the field for the label of the field. This text is not translatable. If you do not enter any text for a label the title text will also used as label text.
* '''Description''': The description of the field. This will be shown below the field while a user is editing the item where this field is displayed. This text is not translatable. You do not see this description in the frontend.
* '''Required''': Is this a mandatory custom field? In this case the field has to be filled before submitting an article or a contact or a third party component that supports custom fields. You can choose the options ''Yes'' or ''No''.
* '''Only Use In Subform''': Will this field be displayed on its own, or should it only show up if it's included in a subform? You can choose the options ''Yes'' or ''No''.
* '''Default Value''': Here you can set a default value for the custom field. This text is not translatable. Note that in some list fields you have to enter the value as default and in others the index.
* '''Status''': You can set a publication state. Is the field Published, Unpublished, Archived or Trashed?
** Published: The field is visible while editing an article or an contact. And it is visible in the Frontend.
** Unpublished: The field is will not be visible to users while editing an article or an contact.
** Archived: The field will no longer show on edition an article or a contact. You can open it in the field manager when you set the filter to archived.
** Trashed: The field is deleted but still in the database. It can be permanently deleted from the database with the Empty Trash function in Field Manager.
* '''Field Group''': You can assign a custom field to one or more field groups, which display as tabs when editing the item the fields are assigned to.
* '''Category''': You can assign a custom field to one or more field categories. Note that the default 'All' does not include 'uncategorised' articles.
* '''Access''': The viewing [[S:MyLanguage/Help4.x:Users:_Viewing_Access_Levels|Access Level]] for this field.
* '''Note''': A place to keep personal notes for the field, visible only when editing the field.

=== Tab: Options ===

; Form Options

These options affect how the field displays when it is shown in an item's edit view.

* '''Placeholder''': A placeholder text which will appear inside the custom field as a hint for the input. The placeholder is active in the Backend while creating an article or a contact or a third party component that supports custom fields. You do do not see it in the Frontend.
* '''Field Class''': The class attributes of the field when the field is editable. If multiple classes are needed, separate them with spaces.
* '''Label Class (Form)''': The class attributes of the label when the field is editable. If multiple classes are needed, separate them with spaces.
* '''Editable In''': Which part of the site should the field be shown for editing? You can choose the option ''Site'' (front end), ''Administrator'' (back end), or ''Both''.
* '''Showon Attribute''': Show or hide the field depending on the value of another field. For more information, check ( ADD LINK ).

; Display Options

This options affect how the field displays when it is shown on the site (in the front end).

* '''Display Class''': The class attribute of the rendered field container. If multiple classes are needed, separate them with spaces.
* '''Value Class''': The class attribute of the rendered field value. If multiple classes are needed, separate them with spaces.
* '''Label''': Should the label be shown with the value when displayed on the site? You can choose either ''Show'' or ''Hide''.
* '''Label Class (Output)''': If the label is set to ''Show'', you may enter the class attributes of the label. If multiple classes are needed, separate them with spaces.
* '''Automatic Display''': Joomla offers some content events which are triggered during the content creation process. This is the place to define how the custom fields should be integrated into content. You can choose 'After Title', 'Before Display Content', 'After Display Content' or 'Do not automatically display'.
* '''Prefix''': Text which will display ''before'' the field value on the site.
* '''Suffix''': Text which will display ''after'' the field value on the site.
* '''Layout''': If you have created a layout override for this field, you can select the layout here.
* '''Display When Read-Only''': If someone is editing an item where this field is assigned, but does not have the permission to edit this field, should the field display? You can choose 'Inherit', 'Yes', or 'No'.

<noinclude>
<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J5.x:Adding_custom_fields|<translate>
Prev: Introduction</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J5.x:Adding_custom_fields/Calendar_Field|<translate>
Next: Calendar Field</translate>|class=expand}}</div>
</div>
</noinclude>
__NOTOC__

<noinclude>

[[Category:Tutorials]]
[[Category:Custom Fields]]
[[Category:Beginners]]
[[Category:Joomla! 5.x]]

</noinclude>
<noinclude>[[Category:Needs to be marked for translation]]</noinclude>

J4.x:Adding custom fields/Parameters for all Custom Fields

2023-08-26T12:49:02Z

Crystalenka:

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{Section portal heading|icon=edit|title=Parameters for all Custom Fields}}

== Parameters for all Custom Fields ==

The Custom Fields list will be empty initially. Click on '''New''' to add a field.

[[File:J4x admin fields add new field en.png|600px|frameless]]

=== Tab: General ===

; Mandatory Fields

* '''Title''': The title of the field. The title will display in the field manager page where you can open the field for editing by clicking on the title. The title is not displayed when you create an article or a contact nor in the frontend.
* '''Type''': The field type. There are 16 default field types. '''Please note: The type cannot be changed after saving the field.'''

; Optional Fields

* '''Name''': The name will be used to identify the field and must be unique. Leave this blank and Joomla will fill in a default value from the title.
* '''Label''': Use a descriptive text of the field for the label of the field. This text is not translatable. If you do not enter any text for a label the title text will also used as label text.
* '''Description''': The description of the field. This will be shown below the field while a user is editing the item where this field is displayed. This text is not translatable. You do not see this description in the frontend.
* '''Required''': Is this a mandatory custom field? In this case the field has to be filled before submitting an article or a contact or a third party component that supports custom fields. You can choose the options ''Yes'' or ''No''.
* '''Only Use In Subform''': Will this field be displayed on its own, or should it only show up if it's included in a subform? You can choose the options ''Yes'' or ''No''.
* '''Default Value''': Here you can set a default value for the custom field. This text is not translatable. Note that in some list fields you have to enter the value as default and in others the index.
* '''Status''': You can set a publication state. Is the field Published, Unpublished, Archived or Trashed?
** Published: The field is visible while editing an article or an contact. And it is visible in the Frontend.
** Unpublished: The field is will not be visible to users while editing an article or an contact.
** Archived: The field will no longer show on edition an article or a contact. You can open it in the field manager when you set the filter to archived.
** Trashed: The field is deleted but still in the database. It can be permanently deleted from the database with the Empty Trash function in Field Manager.
* '''Field Group''': You can assign a custom field to one or more field groups, which display as tabs when editing the item the fields are assigned to.
* '''Category''': You can assign a custom field to one or more field categories. Note that the default 'All' does not include 'uncategorised' articles.
* '''Access''': The viewing [[S:MyLanguage/Help4.x:Users:_Viewing_Access_Levels|Access Level]] for this field.
* '''Note''': A place to keep personal notes for the field, visible only when editing the field.

=== Tab: Options ===

; Form Options

These options affect how the field displays when it is shown in an item's edit view.

* '''Placeholder''': A placeholder text which will appear inside the custom field as a hint for the input. The placeholder is active in the Backend while creating an article or a contact or a third party component that supports custom fields. You do do not see it in the Frontend.
* '''Field Class''': The class attributes of the field when the field is editable. If multiple classes are needed, separate them with spaces.
* '''Label Class (Form)''': The class attributes of the label when the field is editable. If multiple classes are needed, separate them with spaces.
* '''Editable In''': Which part of the site should the field be shown for editing? You can choose the option ''Site'' (front end), ''Administrator'' (back end), or ''Both''.
* '''Showon Attribute''': Show or hide the field depending on the value of another field. For more information, check ( ADD LINK ).

; Display Options

This options affect how the field displays when it is shown on the site (in the front end).

* '''Display Class''': The class attribute of the rendered field container. If multiple classes are needed, separate them with spaces.
* '''Value Class''': The class attribute of the rendered field value. If multiple classes are needed, separate them with spaces.
* '''Label''': Should the label be shown with the value when displayed on the site? You can choose either ''Show'' or ''Hide''.
* '''Label Class (Output)''': If the label is set to ''Show'', you may enter the class attributes of the label. If multiple classes are needed, separate them with spaces.
* '''Automatic Display''': Joomla offers some content events which are triggered during the content creation process. This is the place to define how the custom fields should be integrated into content. You can choose 'After Title', 'Before Display Content', 'After Display Content' or 'Do not automatically display'.
* '''Prefix''': Text which will display ''before'' the field value on the site.
* '''Suffix''': Text which will display ''after'' the field value on the site.
* '''Layout''': If you have created a layout override for this field, you can select the layout here.
* '''Display When Read-Only''': If someone is editing an item where this field is assigned, but does not have the permission to edit this field, should the field display? You can choose 'Inherit', 'Yes', or 'No'.

<noinclude>
<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields|<translate>
Prev: Introduction</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields/Calendar_Field|<translate>
Next: Calendar Field</translate>|class=expand}}</div>
</div>
</noinclude>
__NOTOC__

<noinclude>

[[Category:Tutorials]]
[[Category:Custom Fields]]
[[Category:Beginners]]
[[Category:Joomla! 4.x]]

</noinclude>
<noinclude>[[Category:Needs to be marked for translation]]</noinclude>

J4.x:Adding custom fields/Parameters for all Custom Fields

2023-08-26T12:44:51Z

Crystalenka:

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
Parameters for all Custom Fields}}

== Parameters for all Custom Fields ==

The Custom Fields list will be empty initially. Click on '''New''' to add a field.

[[File:J4x admin fields add new field en.png|600px|frameless]]

=== Tab: General ===

; Mandatory Fields

* '''Title''': The title of the field. The title will display in the field manager page where you can open the field for editing by clicking on the title. The title is not displayed when you create an article or a contact nor in the frontend.
* '''Type''': The field type. There are 16 default field types. '''Please note: The type cannot be changed after saving the field.'''

; Optional Fields

* '''Name''': The name will be used to identify the field and must be unique. Leave this blank and Joomla will fill in a default value from the title.
* '''Label''': Use a descriptive text of the field for the label of the field. This text is not translatable. If you do not enter any text for a label the title text will also used as label text.
* '''Description''': The description of the field. This will be shown below the field while a user is editing the item where this field is displayed. This text is not translatable. You do not see this description in the frontend.
* '''Required''': Is this a mandatory custom field? In this case the field has to be filled before submitting an article or a contact or a third party component that supports custom fields. You can choose the options ''Yes'' or ''No''.
* '''Only Use In Subform''': Will this field be displayed on its own, or should it only show up if it's included in a subform? You can choose the options ''Yes'' or ''No''.
* '''Default Value''': Here you can set a default value for the custom field. This text is not translatable. Note that in some list fields you have to enter the value as default and in others the index.
* '''Status''': You can set a publication state. Is the field Published, Unpublished, Archived or Trashed?
** Published: The field is visible while editing an article or an contact. And it is visible in the Frontend.
** Unpublished: The field is will not be visible to users while editing an article or an contact.
** Archived: The field will no longer show on edition an article or a contact. You can open it in the field manager when you set the filter to archived.
** Trashed: The field is deleted but still in the database. It can be permanently deleted from the database with the Empty Trash function in Field Manager.
* '''Field Group''': You can assign a custom field to one or more field groups, which display as tabs when editing the item the fields are assigned to.
* '''Category''': You can assign a custom field to one or more field categories. Note that the default 'All' does not include 'uncategorised' articles.
* '''Access''': The viewing [[S:MyLanguage/Help4.x:Users:_Viewing_Access_Levels|Access Level]] for this field.
* '''Note''': A place to keep personal notes for the field, visible only when editing the field.

=== Tab: Options ===

; Form Options

These options affect how the field displays when it is shown in an item's edit view.

* '''Placeholder''': A placeholder text which will appear inside the custom field as a hint for the input. The placeholder is active in the Backend while creating an article or a contact or a third party component that supports custom fields. You do do not see it in the Frontend.
* '''Field Class''': The class attributes of the field when the field is editable. If multiple classes are needed, separate them with spaces.
* '''Label Class (Form)''': The class attributes of the label when the field is editable. If multiple classes are needed, separate them with spaces.
* '''Editable In''': Which part of the site should the field be shown for editing? You can choose the option ''Site'' (front end), ''Administrator'' (back end), or ''Both''.
* '''Showon Attribute''': Show or hide the field depending on the value of another field. For more information, check ( ADD LINK ).

; Display Options

This options affect how the field displays when it is shown on the site (in the front end).

* '''Display Class''': The class attribute of the rendered field container. If multiple classes are needed, separate them with spaces.
* '''Value Class''': The class attribute of the rendered field value. If multiple classes are needed, separate them with spaces.
* '''Label''': Should the label be shown with the value when displayed on the site? You can choose either ''Show'' or ''Hide''.
* '''Label Class (Output)''': If the label is set to ''Show'', you may enter the class attributes of the label. If multiple classes are needed, separate them with spaces.
* '''Automatic Display''': Joomla offers some content events which are triggered during the content creation process. This is the place to define how the custom fields should be integrated into content. You can choose 'After Title', 'Before Display Content', 'After Display Content' or 'Do not automatically display'.
* '''Prefix''': Text which will display ''before'' the field value on the site.
* '''Suffix''': Text which will display ''after'' the field value on the site.
* '''Layout''': If you have created a layout override for this field, you can select the layout here.
* '''Display When Read-Only''': If someone is editing an item where this field is assigned, but does not have the permission to edit this field, should the field display? You can choose 'Inherit', 'Yes', or 'No'.

<noinclude>
<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields|<translate>
Prev: Introduction</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields/Calendar_Field|<translate>
Next: Calendar Field</translate>|class=expand}}</div>
</div>
</noinclude>
__NOTOC__

<noinclude>

[[Category:Tutorials]]
[[Category:Custom Fields]]
[[Category:Beginners]]
[[Category:Joomla! 4.x]]

</noinclude>
<noinclude>[[Category:Needs to be marked for translation]]</noinclude>

J4.x:Adding custom fields/Parameters for all Custom Fields

2023-08-26T12:42:26Z

Crystalenka:

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
Parameters for all Custom Fields}}

== Parameters for all Custom Fields ==

The Custom Fields list will be empty initially. Click on '''New''' to add a field.

[[File:J4x admin fields add new field en.png|600px|frameless]]

=== Tab: General ===

; Mandatory Fields

* '''Title''': The title of the field. The title will display in the field manager page where you can open the field for editing by clicking on the title. The title is not displayed when you create an article or a contact nor in the frontend.
* '''Type''': The field type. There are 16 default field types. '''Please note: The type cannot be changed after saving the field.'''

; Optional Fields

* '''Name''': The name will be used to identify the field and must be unique. Leave this blank and Joomla will fill in a default value from the title.
* '''Label''': Use a descriptive text of the field for the label of the field. This text is not translatable. If you do not enter any text for a label the title text will also used as label text.
* '''Description''': The description of the field. This will be shown below the field while a user is editing the item where this field is displayed. This text is not translatable. You do not see this description in the frontend.
* '''Required''': Is this a mandatory custom field? In this case the field has to be filled before submitting an article or a contact or a third party component that supports custom fields. You can choose the options ''Yes'' or ''No''.
* '''Only Use In Subform''': Will this field be displayed on its own, or should it only show up if it's included in a subform? You can choose the options ''Yes'' or ''No''.
* '''Default Value''': Here you can set a default value for the custom field. This text is not translatable. Note that in some list fields you have to enter the value as default and in others the index.
* '''Status''': You can set a publication state. Is the field Published, Unpublished, Archived or Trashed?
** Published: The field is visible while editing an article or an contact. And it is visible in the Frontend.
** Unpublished: The field is will not be visible to users while editing an article or an contact.
** Archived: The field will no longer show on edition an article or a contact. You can open it in the field manager when you set the filter to archived.
** Trashed: The field is deleted but still in the database. It can be permanently deleted from the database with the Empty Trash function in Field Manager.
* '''Field Group''': You can assign a custom field to one or more field groups, which display as tabs when editing the item the fields are assigned to.
* '''Category''': You can assign a custom field to one or more field categories. Note that the default 'All' does not include 'uncategorised' articles.
* '''Access''': The viewing [[S:MyLanguage/Help4.x:Users:_Viewing_Access_Levels|Access Level]] for this field.
* '''Note''': A place to keep personal notes for the field, visible only when editing the field.

=== Tab: Options ===

; Form Options

These options affect how the field displays when it is shown in an item's edit view.

* '''Placeholder''': A placeholder text which will appear inside the custom field as a hint for the input. The placeholder is active in the Backend while creating an article or a contact or a third party component that supports custom fields. You do do not see it in the Frontend.
* '''Field Class''': The class attributes of the field when the field is editable. If multiple classes are needed, separate them with spaces.
* '''Label Class (Form)''': The class attributes of the label when the field is editable. If multiple classes are needed, separate them with spaces.
* '''Editable In''': Which part of the site should the field be shown for editing? You can choose the option ''Site'' (front end), ''Administrator'' (back end), or ''Both''.
* '''Showon Attribute''': Show or hide the field depending on the value of another field. For more information, check ( ADD LINK ).

; Display Options

This options affect how the field displays when it is shown on the site (in the front end).

* '''Display Class''': The class attribute of the rendered field container. If multiple classes are needed, separate them with spaces.
* '''Value Class''': The class attribute of the rendered field value. If multiple classes are needed, separate them with spaces.
* '''Label''': Should the label be shown with the value when displayed on the site? You can choose either ''Show'' or ''Hide''.
* '''Label Class (Output)''': If the label is set to ''Show'', you may enter the class attributes of the label. If multiple classes are needed, separate them with spaces.
* '''Automatic Display''': Joomla offers some content events which are triggered during the content creation process. This is the place to define how the custom fields should be integrated into content. You can choose 'After Title', 'Before Display Content', 'After Display Content' or 'Do not automatically display'.
* '''Prefix''': Text which will display ''before'' the field value on the site.
* '''Suffix''': Text which will display ''after'' the field value on the site.
* '''Layout''': If you have created a layout override for this field, you can select the layout here.
* '''Display When Read-Only''': If someone is editing an item where this field is assigned, but does not have the permission to edit this field, should the field display? You can choose 'Inherit', 'Yes', or 'No'.

<noinclude>
<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields|<translate>
Prev: Introduction</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields/Calendar_Field|<translate>
Next: Calendar Field</translate>|class=expand}}</div>
</div>
</noinclude>
__NOTOC__

<noinclude>

[[Category:Tutorials]]
[[Category:Custom Fields]]
[[Category:Beginners]]
[[Category:Joomla! 4.x]]

</noinclude>
<noinclude>[[Category:Needs to be marked for translation]]</noinclude>

J4.x:Adding custom fields/Parameters for all Custom Fields

2023-08-26T12:20:59Z

Crystalenka:

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
Parameters for all Custom Fields}}

== Parameters for all Custom Fields ==

The Custom Fields list will be empty initially. Click on '''New''' to add a field.

[[File:J4x admin fields add new field en.png|600px|frameless]]

=== Tab: General ===

[[File:J4x admin fields general en.png]]

; Mandatory Fields

* '''Title''': The title of the field. The title will display in the field manager page where you can open the field for editing by clicking on the title. The title is not displayed when you create an article or a contact nor in the frontend.
* '''Type''': The field type. There are 16 default field types. '''Please note: The type cannot be changed after saving the field.'''

; Optional Fields

* '''Name''': The name will be used to identify the field and must be unique. Leave this blank and Joomla will fill in a default value from the title.
* '''Label''': Use a descriptive text of the field for the label of the field. This text is not translatable. If you do not enter any text for a label the title text will also used as label text.
* '''Description''': The description of the field. This will be shown below the field while a user is editing the item where this field is displayed. This text is not translatable. You do not see this description in the frontend.
* '''Required''': Is this a mandatory custom field? In this case the field has to be filled before submitting an article or a contact or a third party component that supports custom fields. You can choose the options ''Yes'' or ''No''.
* '''Only Use In Subform''': Will this field be displayed on its own, or should it only show up if it's included in a subform? You can choose the options ''Yes'' or ''No''.
* '''Default Value''': Here you can set a default value for the custom field. This text is not translatable. Note that in some list fields you have to enter the value as default and in others the index.
* '''Status''': You can set a publication state. Is the field Published, Unpublished, Archived or Trashed?
** Published: The field is visible while editing an article or an contact. And it is visible in the Frontend.
** Unpublished: The field is will not be visible to users while editing an article or an contact.
** Archived: The field will no longer show on edition an article or a contact. You can open it in the field manager when you set the filter to archived.
** Trashed: The field is deleted but still in the database. It can be permanently deleted from the database with the Empty Trash function in Field Manager.
* '''Field Group''': You can assign a custom field to one or more field groups, which display as tabs when editing the item the fields are assigned to.
* '''Category''': You can assign a custom field to one or more field categories. Note that the default 'All' does not include 'uncategorised' articles.
* '''Access''': The viewing [[S:MyLanguage/Help4.x:Users:_Viewing_Access_Levels|Access Level]] for this field.
* '''Note''': A place to keep personal notes for the field, visible only when editing the field.

<noinclude>
<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields|<translate>
Prev: Introduction</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields/Calendar_Field|<translate>
Next: Calendar Field</translate>|class=expand}}</div>
</div>
</noinclude>
__NOTOC__

<noinclude>

[[Category:Tutorials]]
[[Category:Custom Fields]]
[[Category:Beginners]]
[[Category:Joomla! 4.x]]

</noinclude>
<noinclude>[[Category:Needs to be marked for translation]]</noinclude>

File:J4x admin fields general en.png

2023-08-26T12:04:05Z

Crystalenka:

The general tab in the edit field view.

File:J4x admin fields add new field en.png

2023-08-26T12:00:52Z

Crystalenka:

Screenshot of the Joomla Administrator, showing the "Articles - Fields" view. There are no fields listed; the "new" button is highlighted.

J5.x:Adding custom fields/Parameters for all Custom Fields

2023-08-26T10:19:13Z

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=5.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
Parameters for all Custom Fields}}

== Introduction ==

(in progress)

<noinclude>
<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J5.x:Adding_custom_fields|<translate>
Prev: Introduction</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J5.x:Adding_custom_fields/Calendar_Field|<translate>
Next: Calendar Field</translate>|class=expand}}</div>
</div>
</noinclude>
__NOTOC__

<noinclude>

[[Category:Tutorials]]
[[Category:Custom Fields]]
[[Category:Beginners]]
[[Category:Joomla! 5.x]]

</noinclude>
<noinclude>[[Category:Needs to be marked for translation]]</noinclude>

J4.x:Adding custom fields/Parameters for all Custom Fields

2023-08-26T10:18:40Z

Crystalenka:

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
Parameters for all Custom Fields}}

== Introduction ==

(in progress)

<noinclude>
<div class="row">
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields|<translate>
Prev: Introduction</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields/Calendar_Field|<translate>
Next: Calendar Field</translate>|class=expand}}</div>
</div>
</noinclude>
__NOTOC__

<noinclude>

[[Category:Tutorials]]
[[Category:Custom Fields]]
[[Category:Beginners]]
[[Category:Joomla! 4.x]]

</noinclude>
<noinclude>[[Category:Needs to be marked for translation]]</noinclude>

J5.x:Adding custom fields

2023-08-26T10:17:33Z

Crystalenka:

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=5.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
An Introduction to Adding and Managing Custom Fields}}

== Introduction ==

Ever wanted to show additional attributes or information in an article, user form or contact pages? Through custom fields, you have a seamlessly integrated way to create and show a variety of content types on the Frontend of your website.

Custom fields offer 16 different types of output. As well as allowing additional information and attributes, they allow you to control where the content displays and control it's format. They can be used in a most simple way or to provide more complex functionality and layouts.

Joomla allows you to manage your Custom Fields by using Categories and Field Groups to control where and how they are available to use.

When you create Custom Fields they become available in the editor via an extra tab. Dependent on how you set them up they may appear via a '''Fields''' tab or a tab using a '''Field Group''' name. Additionally, the availability of the Custom Fields can be limited to a specific or multiple categories.

This is an introduction to a series of documents that covers adding custom fields for each of the '''core''' field types available.

== How to access Custom Fields ==

You can create and manage Custom Fields through the sidebar menu and the relevant Component Dashboard.

'''For Custom Fields in an Article'''

From the sidebar menu click the '''Content''' down arrow to see the Fields and Field Groups links. Alternatively, clicking the grid icon at the side of the down arrow takes you to the Fields Dashboard where you will see the relevant links.

[[File:j4.x_access_article_fields_en.png|Access article fields via the sidebar menu|300px]]

When adding Custom Fields for use in articles you have to set the view where the field will be used via a dropdown list beneath the '''New''' button.

* Article - for the article view
* Category - for use in a category blog view

'''For Custom Fields in a Contact'''

From the sidebar menu click the '''Component''' down arrow and then the '''Contact''' down arrow to see the Fields and Field Groups links. Alternatively, clicking the grid icon at the side of the down arrow takes you to the Contacts Dashboard where you will see the relevant links.

[[File:j4.x_access_contact_fields_en.png|Access contact fields via the sidebar menu|300px]]

When adding Custom Fields for the Contacts Component you have to set the view where the field will be used via a dropdown list beneath the '''New''' button.

* Contact - for the contact view
* Mail - for use in a contact form
* Category - for use in a category view

'''For Custom Fields in a User'''

From the sidebar menu click the '''Users''' down arrow to see the Fields and Field Groups links. Alternatively, clicking the grid icon at the side of the down arrow takes you to the Fields Dashboard where you will see the relevant links.

[[File:j4.x_access_user_fields_en.png|Access user fields via the sidebar menu|300px]]

== Accessing Fields to use them ==

Once you have set up Custom Fields they are available for use.

How they appear depends on whether you have used Field Groups or not. The following screenshot shows a tab for a Field Group named Accessories.

[[File:j4.x_articles_custom_fields_tab.png|New Article Fields Group Tab|800px]]

The following is an example where no Field Groups have not been used. In this case you will see a Fields tab.

[[File:j4.x_user_custom_fields_tab_en.png|New User Fields Tab|800px]]

== Can you search Custom Fields? ==

Short answer: Yes, you can.

== What else is important? ==

By default, when you create Fields they are available in the relevant component's '''Add New''' interface as a new tab. If they do not appear, make sure you have set the item to the category or categories the Field was set to.

Note that is possible to disable options in article settings so make sure that in Article Options, under Editing Layout, that '''Article Options''' is set to '''Show'''.

Also note that a Custom Field will not show up in an article if it is empty.

If you use versioning for your articles, fields are not stored in different versions.

<noinclude>
<div class="row">
<div class="large-12 columns">{{Basic button|S:MyLanguage/J5.x:Adding_custom_fields/Parameters_for_all_Custom_Fields|
Let's start with the Parameters for all Custom Fields|class=expand}}</div>
</div>
</noinclude>
__NOTOC__

<noinclude>
[[Category:Tutorials]]
[[Category:Custom Fields]]
[[Category:Beginners]]
[[Category:Joomla! 5.x]]

</noinclude>

J4.x:Adding custom fields

2023-08-26T10:16:47Z

Crystalenka:

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
An Introduction to Adding and Managing Custom Fields}}

== Introduction ==

Ever wanted to show additional attributes or information in an article, user form or contact pages? Through custom fields, you have a seamlessly integrated way to create and show a variety of content types on the Frontend of your website.

Custom fields offer 16 different types of output. As well as allowing additional information and attributes, they allow you to control where the content displays and control it's format. They can be used in a most simple way or to provide more complex functionality and layouts.

Joomla allows you to manage your Custom Fields by using Categories and Field Groups to control where and how they are available to use.

When you create Custom Fields they become available in the editor via an extra tab. Dependent on how you set them up they may appear via a '''Fields''' tab or a tab using a '''Field Group''' name. Additionally, the availability of the Custom Fields can be limited to a specific or multiple categories.

This is an introduction to a series of documents that covers adding custom fields for each of the '''core''' field types available.

== How to access Custom Fields ==

You can create and manage Custom Fields through the sidebar menu and the relevant Component Dashboard.

'''For Custom Fields in an Article'''

From the sidebar menu click the '''Content''' down arrow to see the Fields and Field Groups links. Alternatively, clicking the grid icon at the side of the down arrow takes you to the Fields Dashboard where you will see the relevant links.

[[File:j4.x_access_article_fields_en.png|Access article fields via the sidebar menu|300px]]

When adding Custom Fields for use in articles you have to set the view where the field will be used via a dropdown list beneath the '''New''' button.

* Article - for the article view
* Category - for use in a category blog view

'''For Custom Fields in a Contact'''

From the sidebar menu click the '''Component''' down arrow and then the '''Contact''' down arrow to see the Fields and Field Groups links. Alternatively, clicking the grid icon at the side of the down arrow takes you to the Contacts Dashboard where you will see the relevant links.

[[File:j4.x_access_contact_fields_en.png|Access contact fields via the sidebar menu|300px]]

When adding Custom Fields for the Contacts Component you have to set the view where the field will be used via a dropdown list beneath the '''New''' button.

* Contact - for the contact view
* Mail - for use in a contact form
* Category - for use in a category view

'''For Custom Fields in a User'''

From the sidebar menu click the '''Users''' down arrow to see the Fields and Field Groups links. Alternatively, clicking the grid icon at the side of the down arrow takes you to the Fields Dashboard where you will see the relevant links.

[[File:j4.x_access_user_fields_en.png|Access user fields via the sidebar menu|300px]]

== Accessing Fields to use them ==

Once you have set up Custom Fields they are available for use.

How they appear depends on whether you have used Field Groups or not. The following screenshot shows a tab for a Field Group named Accessories.

[[File:j4.x_articles_custom_fields_tab.png|New Article Fields Group Tab|800px]]

The following is an example where no Field Groups have not been used. In this case you will see a Fields tab.

[[File:j4.x_user_custom_fields_tab_en.png|New User Fields Tab|800px]]

== Can you search Custom Fields? ==

Short answer: Yes, you can.

== What else is important? ==

By default, when you create Fields they are available in the relevant component's '''Add New''' interface as a new tab. If they do not appear, make sure you have set the item to the category or categories the Field was set to.

Note that is possible to disable options in article settings so make sure that in Article Options, under Editing Layout, that '''Article Options''' is set to '''Show'''.

Also note that a Custom Field will not show up in an article if it is empty.

If you use versioning for your articles, fields are not stored in different versions.

<noinclude>
<div class="row">
<div class="large-12 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields/Parameters_for_all_Custom_Fields|
Let's start with the Parameters for all Custom Fields|class=expand}}</div>
</div>
</noinclude>
__NOTOC__

<noinclude>
[[Category:Tutorials]]
[[Category:Custom Fields]]
[[Category:Beginners]]
[[Category:Joomla! 4.x]]

</noinclude>

<noinclude>[[Category:Needs to be marked for translation]]</noinclude>

J4.x:Adding custom fields

2023-08-26T10:15:40Z

Crystalenka:

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
An Introduction to Adding and Managing Custom Fields}}

== Introduction ==

Ever wanted to show additional attributes or information in an article, user form or contact pages? Through custom fields, you have a seamlessly integrated way to create and show a variety of content types on the Frontend of your website.

Custom fields offer 16 different types of output. As well as allowing additional information and attributes, they allow you to control where the content displays and control it's format. They can be used in a most simple way or to provide more complex functionality and layouts.

Joomla allows you to manage your Custom Fields by using Categories and Field Groups to control where and how they are available to use.

When you create Custom Fields they become available in the editor via an extra tab. Dependent on how you set them up they may appear via a '''Fields''' tab or a tab using a '''Field Group''' name. Additionally, the availability of the Custom Fields can be limited to a specific or multiple categories.

This is an introduction to a series of documents that covers adding custom fields for each of the '''core''' field types available.

== How to access Custom Fields ==

You can create and manage Custom Fields through the sidebar menu and the relevant Component Dashboard.

'''For Custom Fields in an Article'''

From the sidebar menu click the '''Content''' down arrow to see the Fields and Field Groups links. Alternatively, clicking the grid icon at the side of the down arrow takes you to the Fields Dashboard where you will see the relevant links.

[[File:j4.x_access_article_fields_en.png|Access article fields via the sidebar menu|300px]]

When adding Custom Fields for use in articles you have to set the view where the field will be used via a dropdown list beneath the '''New''' button.

* Article - for the article view
* Category - for use in a category blog view

'''For Custom Fields in a Contact'''

From the sidebar menu click the '''Component''' down arrow and then the '''Contact''' down arrow to see the Fields and Field Groups links. Alternatively, clicking the grid icon at the side of the down arrow takes you to the Contacts Dashboard where you will see the relevant links.

[[File:j4.x_access_contact_fields_en.png|Access contact fields via the sidebar menu|300px]]

When adding Custom Fields for the Contacts Component you have to set the view where the field will be used via a dropdown list beneath the '''New''' button.

* Contact - for the contact view
* Mail - for use in a contact form
* Category - for use in a category view

'''For Custom Fields in a User'''

From the sidebar menu click the '''Users''' down arrow to see the Fields and Field Groups links. Alternatively, clicking the grid icon at the side of the down arrow takes you to the Fields Dashboard where you will see the relevant links.

[[File:j4.x_access_user_fields_en.png|Access user fields via the sidebar menu|300px]]

== Accessing Fields to use them ==

Once you have set up Custom Fields they are available for use.

How they appear depends on whether you have used Field Groups or not. The following screenshot shows a tab for a Field Group named Accessories.

[[File:j4.x_articles_custom_fields_tab.png|New Article Fields Group Tab|800px]]

The following is an example where no Field Groups have not been used. In this case you will see a Fields tab.

[[File:j4.x_user_custom_fields_tab_en.png|New User Fields Tab|800px]]

== Can you search Custom Fields? ==

Short answer: Yes, you can.

== What else is important? ==

By default, when you create Fields they are available in the relevant component's '''Add New''' interface as a new tab. If they do not appear, make sure you have set the item to the category or categories the Field was set to.

Note that is possible to disable options in article settings so make sure that in Article Options, under Editing Layout, that '''Article Options''' is set to '''Show'''.

Also note that a Custom Field will not show up in an article if it is empty.

If you use versioning for your articles, fields are not stored in different versions.

[[Category:Tutorials]]
[[Category:Custom Fields]]
[[Category:Beginners]]
[[Category:Joomla! 4.x]]

</noinclude>

<noinclude>[[Category:Needs to be marked for translation]]</noinclude>

J4.x:Adding custom fields/Parameters for all Custom Fields

2023-08-26T10:02:13Z

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=4.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
Parameters for all Custom Fields}}

== Introduction ==

(in progress)


Prev: Introduction</translate>|class=expand success}}</div>
<div class="large-6 columns">{{Basic button|S:MyLanguage/J4.x:Adding_custom_fields/Calendar_Field|<translate>
Next: Calendar Field</translate>|class=expand}}</div>
</div>
</noinclude>
__NOTOC__

<noinclude>
-->
[[Category:Tutorials]]
[[Category:Custom Fields]]
[[Category:Beginners]]
[[Category:Joomla! 4.x]]

</noinclude>

J5.x:Adding custom fields

2023-08-26T09:50:33Z

Crystalenka: Creating the new page for 5.x, duplicating content from the 4.x page to start.

<noinclude><languages /></noinclude>
<noinclude>{{Joomla version|version=5.x}}</noinclude>
{{Top portal heading|color=white-bkgd|icon=magic|icon-color=#5091cd|size=3x|text-color=#333|title=
An Introduction to Adding and Managing Custom Fields}}

== Introduction ==

Ever wanted to show additional attributes or information in an article, user form or contact pages? Through custom fields, you have a seamlessly integrated way to create and show a variety of content types on the Frontend of your website.

Custom fields offer 16 different types of output. As well as allowing additional information and attributes, they allow you to control where the content displays and control it's format. They can be used in a most simple way or to provide more complex functionality and layouts.

Joomla allows you to manage your Custom Fields by using Categories and Field Groups to control where and how they are available to use.

When you create Custom Fields they become available in the editor via an extra tab. Dependent on how you set them up they may appear via a '''Fields''' tab or a tab using a '''Field Group''' name. Additionally, the availability of the Custom Fields can be limited to a specific or multiple categories.

This is an introduction to a series of documents that covers adding custom fields for each of the '''core''' field types available.

== How to access Custom Fields ==

You can create and manage Custom Fields through the sidebar menu and the relevant Component Dashboard.

'''For Custom Fields in an Article'''

From the sidebar menu click the '''Content''' down arrow to see the Fields and Field Groups links. Alternatively, clicking the grid icon at the side of the down arrow takes you to the Fields Dashboard where you will see the relevant links.

[[File:j4.x_access_article_fields_en.png|Access article fields via the sidebar menu|300px]]

When adding Custom Fields for use in articles you have to set the view where the field will be used via a dropdown list beneath the '''New''' button.

* Article - for the article view
* Category - for use in a category blog view

'''For Custom Fields in a Contact'''

From the sidebar menu click the '''Component''' down arrow and then the '''Contact''' down arrow to see the Fields and Field Groups links. Alternatively, clicking the grid icon at the side of the down arrow takes you to the Contacts Dashboard where you will see the relevant links.

[[File:j4.x_access_contact_fields_en.png|Access contact fields via the sidebar menu|300px]]

When adding Custom Fields for the Contacts Component you have to set the view where the field will be used via a dropdown list beneath the '''New''' button.

* Contact - for the contact view
* Mail - for use in a contact form
* Category - for use in a category view

'''For Custom Fields in a User'''

From the sidebar menu click the '''Users''' down arrow to see the Fields and Field Groups links. Alternatively, clicking the grid icon at the side of the down arrow takes you to the Fields Dashboard where you will see the relevant links.

[[File:j4.x_access_user_fields_en.png|Access user fields via the sidebar menu|300px]]

== Accessing Fields to use them ==

Once you have set up Custom Fields they are available for use.

How they appear depends on whether you have used Field Groups or not. The following screenshot shows a tab for a Field Group named Accessories.

[[File:j4.x_articles_custom_fields_tab.png|New Article Fields Group Tab|800px]]

The following is an example where no Field Groups have not been used. In this case you will see a Fields tab.

[[File:j4.x_user_custom_fields_tab_en.png|New User Fields Tab|800px]]

== Can you search Custom Fields? ==

Short answer: Yes, you can.

== What else is important? ==

By default, when you create Fields they are available in the relevant component's '''Add New''' interface as a new tab. If they do not appear, make sure you have set the item to the category or categories the Field was set to.

Note that is possible to disable options in article settings so make sure that in Article Options, under Editing Layout, that '''Article Options''' is set to '''Show'''.

Also note that a Custom Field will not show up in an article if it is empty.

If you use versioning for your articles, fields are not stored in different versions.

[[Category:Tutorials]]
[[Category:Custom Fields]]
[[Category:Beginners]]
[[Category:Joomla! 5.x]]

</noinclude>