Skip to main content

Custom Fields

The Custom Fields plugin manages Joomla custom fields: fields, groups, types and contexts.


Fields do not have their own permissions: as in Joomla, permissions are checked against the component for the context — com_content for article and category fields, com_users for profile fields, and so on. All tools, including read operations, require access to this component (core.manage); write operations additionally require the permission shown in the “Required permissions” column, checked on the field itself. The context must be a section declared by an installed component. Fields of type sql are restricted to Super Users, as in Joomla.

Fields

Create and manage fields.

ToolFunctionRequired permissions (ACL)
list_fieldsList fieldsNone (read)
get_fieldRead a fieldNone (read)
create_fieldCreate a fieldCreate — core.create on the component for the context
update_fieldModify a fieldModify — core.edit (or core.edit.own) on the field
delete_fieldDelete a fieldDelete — core.delete on the field
set_field_statePublish / unpublishModify state — core.edit.state on the field
reorder_fieldReorderModify state — core.edit.state on the field

Field groups

Group fields together.

ToolFunctionRequired permissions (ACL)
list_field_groupsList groupsNone (read)
get_field_groupRead a groupNone (read)
create_field_groupCreate a groupCreate — core.create on the component for the context
update_field_groupModify a groupModify — core.edit (or core.edit.own) on the group
delete_field_groupDelete a groupDelete — core.delete on the group

Types & parameters

Discover the available types and their parameters.

ToolFunctionRequired permissions (ACL)
list_field_typesList types (text, list, media, subform…)None (read)
get_field_type_paramsParameters expected by a typeNone (read)

Contexts

Find out which contexts allow you to create a field (articles, categories, users, contacts, and so on). The values of fields are populated by the plugin that manages the item: Content for articles and categories (list_article_fields, list_category_fields), Users for accounts (list_user_fields).

ToolFunctionRequired permissions (ACL)
list_field_contextsList contexts (com_content.article, com_content.categories, com_users.user, etc.)None (read)

Prompt examples

“Create a list field called ‘Difficulty’ (Easy/Medium/Difficult) for recipes.”

“Group my SEO fields into a group called ‘Search engine optimisation’.”

“Add an FAQ subform (question, answer) to categories.”