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

Parameters for all Custom Fields

Articles in this Series

1. Introduction
2. Parameters for all Custom Fields
3. Calendar Field
4. Checkboxes Field
5. Color Field
6. Editor Field
7. Integer Field
8. List Field
9. List of Images Field
10. Media Field
11. Radio Field
12. Repeatable Field
13. Sql Field
14. Text Field
15. Textarea Field
16. Url Field
17. User Field
18. Usergroup Field
19. How can you group custom fields
20. What components are supporting custom fields
21. Implementation into your component
22. Use custom fields in your overrides

Parameters for all Custom Fields

In the register General you have to fill the mandatory data:

• 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 an contact nor in the frontend.
• Name
  The name will be used to identify the field. Leave this blank and Joomla will fill in a default value from the title.
• Type
  If you create a field you can choose one of the 15 field types. When you save the field this type is fix. You can not change it later on.

For every field, you can use these parameters:

• 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. A text that will be shown as a tool tip when the user moves the mouse over the text box while he use it in the backend creating an article or a contact or a third party component that supports custom fields. 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.
• Default
  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.
• State
  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 an 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.
• Category
  You can assign a custom field to one or more field categories.
• Access
  The viewing Access Level for this item.
• Language
  Select the language for this custom field. If you are not using the multi-language feature of Joomla, keep the default of All.
• Note
  An optional field to make your personal notes for the field.

In the register Options you can use the options:

• 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.
• Render Class
  The class attributes of the field when the field is rendered. If different classes are needed, list them with spaces.
• Edit Class
  The class attributes of the field in the edit form. If different classes are needed, list them with spaces.
• Show Label
  Show or Hide the label when the field renders.
• Disabled
  Should the field be disabled in the edit form.
• Read only
  Should the field be read-only in the edit form.
• Show on
  On which part of the site should the field be shown. In the backend, in the frontend or both?
• 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 Display", "Before Display" or "After title".

Prev: Introduction

Next: Calendar Field