Joomla! Documentation™

Description

This is where you can

• Add a new Field.

• Edit an existing Field.

How to Access

Add a new Field

• Select from the dropdown menu at the top Articles or Category

• Click the New button in the toolbar.

Edit an existing Field

• Click on an Fields Title.

• Check the Fields Checkbox
• Click the Edit button in the toolbar.

In the same way you can add or edit Fields for Contacts and for Users.

Screenshot

Form Fields

General

This section allows you to enter parameters for this Field.

• Title. The name or title of the custom field. Make it as descriptive as possible.

• Type. The Type of the custom field.
  1. Calendar: calendar field.
  2. Checkboxes: checkboxes field.
  3. Colour: color field.
  4. Editor: editor field.
  5. Integer: integer field.
  6. List: list field.
  7. List of images: imagelist field.
  8. Media: media field.
  9. Radio: radio field.
  10. Repeatable: repeatable field.
  11. SQL: sql field.
  12. Text: text field.
  13. Text Area: textarea field.
  14. URL: url field.
  15. User: user field.
  16. User Groups: usergrouplist field.

These entries are optional. Joomla automatically creates default values for these entries.

• Name. The Name will be used to identify the custom field. Leave this blank and Joomla will fill in a default value from the title.

• Label. The label of the field to display. If blank auto-generated from title.

• Description. A description of the custom field that will be displayed in the label tooltip.

• Required. (Yes/No) Is this a mandatory field.

Depending on the Type:

Type: Calendar:

• Default Date. The default date of the field. The value can be an ISO 8601 format (YYYY-MM-DD HH:MM:SS) or NOW, which displays the actual date.

• Show Time. (Yes/No) If enabled, the calendar field expects a date and time and will also display the time. The formats are localised using the regular language strings.

Type: Checkboxes:

• Default Value. The default value of the field.

• Checkbox Values. The values of the checkbox. Enter the label and the value. Through the images at the end you can add, delete or move values.
  

Type: Colour:

• Default Value. The default value of the field.

Type: Editor:

• Default Value. The default value of the field.

• Show Buttons. (Use settings from Plugin/Yes/No) Should the editor-xtd plugin buttons be shown.

• Hide Buttons. Select some options.

• Width. Defines the width (in pixels) of the WYSIWYG editor and defaults to 100%.

• Height. Defines the height (in pixels) of the WYSIWYG editor and defaults to 250px.

• Filter. (Use settings from Plugin/No/Raw/Safe HTML/Text) Allow the system to save certain html tags or raw data.

Type: Integer:

• Default Value. The default value of the field.

• Multiple. (Use settings from Plugin/Yes/No) Allow multiple values to be selected.

• First. This value is the lowest on the list.

• Last. This value is the highest on the list.

• Step. Each option will be the previous option incremented by this integer, starting with the first value until the last value is reached.

Type: List:

• Default Value. The default value of the field.

• Multiple. (Use settings from Plugin/Yes/No) Allow multiple values to be selected.

• List Values. The values of the list. Enter the label and the value. Through the images at the end you can add, delete or move values.
  

Type: List of Images:

• Default Value. The default value of the field.

• Directory. (Use settings from Plugin/...) The filesystem path to the directory containing the image files to be listed relative to the default image folder.

• Multiple. (Use settings from Plugin/Yes/No) Allow multiple values to be selected.

• Image Class. The class which is added to the image (src tag).

Type: Media:

• Default Value. The default value of the field.

• Directory. (Use settings from Plugin/...) The filesystem path to the directory containing the image files to be listed relative to the default image folder.

• Preview. (Use settings from Plugin/Tooltip/Inline/No) Shows or Hides the preview of the selected image.

• Image Class. The class which is added to the image (src tag).

Type: Radio:

• Default Value. The default value of the field.

• Radio Values. The values of the radio list. Enter the label and the value. Through the images at the end you can add, delete or move values.
  

Type: Repeatable:

• Default Value. The default value of the field.

• Form Fields. Add one or more form fields.
  

Type: SQL:

• Default Value. The default value of the field.

• Query. The SQL query which will provide the data for the dropdown list. The query must return 2 columns:
  1. one called 'value' which will hold the values of the list items,
  2. the other called 'text' containing the text in the dropdown list.

• Multiple. (Use settings from Plugin/Yes/No) Allow multiple values to be selected.

Type: Text:

• Default Value. The default value of the field.

• Filter. (Use settings from Plugin/No/Raw/Safe HTML/Text/Alpha Numeric/Integer/Float/Telephone) Allow the system to save certain html tags or raw data.

• Maximum Length. The maximum number of characters that can be entered.

Type: Text Area:

• Default Value. The default value of the field.

• Rows. The height of the visible text area in lines. If omitted the height is determined by the browser. The value does not limit the number of lines that may be entered.

• Columns. The width of the visible text area in characters. If omitted the width is determined by the browser. The value does not limit the number of characters that may be entered.

• Maximum Length. The maximum number of characters that can be entered.

• Filter. (Use settings from Plugin/No/Raw/Safe HTML/Text/Alpha Numeric/Integer/Float/Telephone) Allow the system to save certain html tags or raw data.

Type: URL:

• Default Value. The default value of the field.

• Schemes. (HTTP/HTTPS/FTP/FTPS/FILE/MAILTO) The allowed schemes.

• Relative. (Use settings from Plugin/Yes/No) Are relative URLs allowed.

Type: User:

• Default User. The default user.

Type: User Groups:

• Default User Groups. A comma separated list of user group IDs.

• Multiple. (Use settings from Plugin/Yes/No) Allow multiple values to be selected.

Options

Form Options

• Placeholder. Placeholder text which will appear inside the field as a hint to the user for the required input.

• Field Class. The class attributes of the field in the edit form. If multiple classes are needed, list them with spaces.

• Label Class. The class of the label in the form. If multiple classes are needed, list them with spaces.

• Show On. (Site/Administrator/Both) On which part of the site should the field be editable. Note: Only the type 'User' does not have 'Show On'.

Render Options

• Render Class. The class attributes of the field when the field is rendered. If multiple classes are needed, list them with spaces.

• Show Label. (Show/Hide) Show or Hide the label when the field renders.

• Label Class. The class of the label in the output.

• Automatic Display. (After Title/Before Display/After Display/Do not automatically display) Joomla offers some content events which are tiggered during the content creation process. This is the place to define how the custom fields should be integrated into content.

• Layout. (- Use Default -) Choose an alternate layout.

• Display When Read-Only. (Inherit/Yes/No) Whether to display the field on forms when read-only. Inherit defaults to value set in field group.

Publishing

• Created Date. This field defaults to the current time when the field was created. You can enter in a different date and time or click on the calendar icon to find the desired date.

• Created By. Name of the user who created the field. This will default to the currently logged-in user. If you want to change this to a different user, click the 'Select User' button .

• Modified Date. (Informative only) Date of last modification.

• Modified By. (Informative only) Username who performed the last modification.

• ID. (Informative only) This is a unique identification number for this field.

Permissions

Joomla lets you set permissions for fields at 4 levels, as follows.

1. Globally, using Global Configuration.
2. For all articles, using Article Manager→Options.
3. For all articles in a category, using Category Manager.
4. For an individual article, using Article Edit.

Manage the permission settings for user groups.

To change the permissions for this field, do the following.

1. Select the Group by clicking its title located on the left.

2. Find the desired Action. Possible Actions are:

• Delete. Users can delete content of this field.

• Edit. Users can edit content of this field.

• Edit State. Users can change the published state and related information for content of this field.

• Edit Custom Field Value. Allows users in the group to edit any value of custom fields submitted in this field.

3. Select the desired Permission for the action you wish to change. Possible settings are:

• Inherited: Inherited for users in this Group from the article permissions of this field.

• Allowed: Allowed for users in this Group. Note that, if this action is Denied at one of the higher levels, the Allowed permission here will not take effect. A Denied setting cannot be overridden.

• Denied: Denied for users in this Group.

4. Click Save in Toolbar at top. When the screen refreshes, the Calculated Setting column will show the effective permission for this Group and Action.

Toolbar

At the top left you will see the toolbar.

The functions are:

• Save. Saves the field and stays in the current screen.

• Save & Close. Saves the field and closes the current screen.

• Save & New. Saves the field and keeps the editing screen open and ready to create another field.

• Save as Copy. Saves your changes to a copy of the current field. Does not affect the current field.
  Note: This toolbar icon is only shown if you edit an existing field.

• Close. Closes the current screen and returns to the previous screen without saving any modifications you may have made.

• Help. Opens this help screen.

Quick Tips

If you want to know how to use Custom Fields, click Adding Custom Fields

Related Information

• To add or edit Articles: Article: New/Edit

• To manage Categories: Category

• To manage Fields: Article Fields

• To manage Featured Articles: Article: Featured Articles