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.
| Tool | Function | Required permissions (ACL) |
|---|---|---|
list_fields | List fields | None (read) |
get_field | Read a field | None (read) |
create_field | Create a field | Create — core.create on the component for the context |
update_field | Modify a field | Modify — core.edit (or core.edit.own) on the field |
delete_field | Delete a field | Delete — core.delete on the field |
set_field_state | Publish / unpublish | Modify state — core.edit.state on the field |
reorder_field | Reorder | Modify state — core.edit.state on the field |
Field groups
Group fields together.
| Tool | Function | Required permissions (ACL) |
|---|---|---|
list_field_groups | List groups | None (read) |
get_field_group | Read a group | None (read) |
create_field_group | Create a group | Create — core.create on the component for the context |
update_field_group | Modify a group | Modify — core.edit (or core.edit.own) on the group |
delete_field_group | Delete a group | Delete — core.delete on the group |
Types & parameters
Discover the available types and their parameters.
| Tool | Function | Required permissions (ACL) |
|---|---|---|
list_field_types | List types (text, list, media, subform…) | None (read) |
get_field_type_params | Parameters expected by a type | None (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).
| Tool | Function | Required permissions (ACL) |
|---|---|---|
list_field_contexts | List 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.”