Joomla! Documentation™

Joomla! 

5.x

This Page Needs Copy Editing

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.

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 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'.

Prev: Introduction

Next: Calendar Field