# Creating and configuring custom user fields
**URL:** https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192
**Category:** Site Management
**Tags:** how-to, user-custom-fields, users
**Created:** [April 2, 2019, 1:42am UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192 "2019-04-02T01:42:35Z")
**Posts on this page:** 20
**Page:** 1
### Author:  [@Discourse](https://meta.discourse.org/u/Discourse)
#### Post date: [April 2, 2019, 1:42am UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/1 "2019-04-02T01:42:35Z")
> š This guide explains how to create and configure custom user fields in Discourse, including how to add them to the signup form, user profiles, and user directory.
>
> š Required user level: Administrator
Custom user fields allow you to collect additional information from your users beyond the standard profile fields. These fields can be displayed on user cards, user summary pages, and even retrieved using the [Data Explorer](https://meta.discourse.org/t/32566?silent=true) plugin. This guide will walk you through the process of creating and configuring custom user fields.
## Adding a user field
1. Go to Admin \> Community \> User Fields (`discourse.example.com/admin/config/user-fields`).
2. If you havenāt created any user fields yet, youāll see this screen:
3. Click the āAdd user fieldā button to add a new field.
## Choosing a field type
The field type determines the input field users will see on the signup form. Choose based on the kind of information youāre collecting:
### Text field
- Use for short questions with many possible answers (e.g., āWhat company do you work for?ā)
- Displays as a single-line HTML text input
### Textarea
- Use for questions that may require longer, multi-line answers (e.g., āTell us about yourselfā)
- Displays as a multi-line HTML textarea input
### Date
- Use for collecting date values (e.g., āWhat is your date of birth?ā)
- Displays as a date picker input
### Confirmation
- Use for yes/no questions (e.g., āWould you like to sign up for our newsletter?ā)
- Displays as an HTML checkbox
### Dropdown
- Use for questions with a set number of possible answers (e.g., āWhat is your gender?ā)
- Displays as an HTML select input
To add options for a dropdown field:
1. Click on the option input
2. Type an answer and click āCreateā
3. Repeat for additional options
The completed options should look similar to this:
### Multiselect
- Use for questions where users can choose multiple answers from a set of options (e.g., āWhich topics interest you?ā)
- Displays as a multi-select input
- Options are configured the same way as dropdown fields
## Setting the field name and description
- **Field Name** : Appears before the input on the signup form and user profile
- **Field Description** : Appears after the input to help users complete the field
> ā¹ Both the field name and description are required to save a field.
Hereās how custom fields appear on the signup form:
## Configuring user field options
### Field Requirements
- **Optional** - Optional fields may be left empty by users
- **For all users** - When a field is required by all users, every account, including logged on users will be forced to fill it. This is very useful for cases such as a terms-of-service (ToS) requirement.
- **On signup** - All new account will be required to fill the field.
Additionally, at the bottom of the creation form, youāll find these preference checkboxes:
- **Editable after signup** : Allows users to update the field from their profile page
- **Show on public profile** : Displays the field value on the userās summary page
- **Show on user card** : Shows the field value on the user card
- **Searchable** : Enables searching for users based on this fieldās value in the user directory
- **Show on signup form** : Controls whether the field appears on the signup form. This is automatically enabled (and cannot be disabled) when the field requirement is āFor all usersā or āOn signupā, or when the field is not editable after signup.
### Show on public profile
When enabled, the field value will be shown on the userās profile page:
### Show on user card
When enabled, the field value will be displayed on the user card:
### Searchable
When enabled, you can search for users based on their custom field values:
## Saving and editing fields
1. Click āSaveā to add the field to your siteās list of user fields
2. To edit a field, click the āEditā button next to it in the list
3. To delete a field, click the ellipsis menu (ā®) next to it and select āDeleteā
## Adding custom fields to the user directory
1. Go to the user directory
2. Click the wrench icon:
1. Check the custom user fields you want to display
2. Click āSaveā
The selected custom fields will now appear in the user directory table:
> Last edited by @fzngagan 2025-07-17T09:12:38Z
>
> Last checked by @hugh 2024-08-27T04:45:20Z
>
> > **Check document**
> >
> > Perform check on document:
---
### Author:  [@traceymoko](https://meta.discourse.org/u/traceymoko)
#### Post date: [April 15, 2024, 11:29am UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/61 "2024-04-15T11:29:04Z")
I think two images are missing under these headings:
- **[Adding a User Field](https://meta.discourse.org/t/create-and-configure-custom-user-fields/113192#adding-a-user-field-1)**
- **[Show on user card](https://meta.discourse.org/t/create-and-configure-custom-user-fields/113192#show-on-user-card-11)**
Not sure if itās related to [Missing images at Meta.discourse.org](https://meta.discourse.org/t/missing-images-at-meta-discourse-org/302963) ā will post there too.
---
### Author:  [@JammyDodger](https://meta.discourse.org/u/JammyDodger)
#### Post date: [April 15, 2024, 11:56am UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/62 "2024-04-15T11:56:35Z")
I can see those images? (also in an anon window)
---
### Author:  [@Moin](https://meta.discourse.org/u/Moin)
#### Post date: [April 15, 2024, 11:59am UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/63 "2024-04-15T11:59:25Z")
I cannot see theose
> [@simon](#):
>
> like this:
>
> 
> [@simon](#):
>
> ### Show on user card
>
> Select this option to show the field on the user card. The value of the field will be displayed next to the Field Name.
>
> 
>
> ### Searchable
But the second one works in my quote.
Edit
---
### Author:  [@traceymoko](https://meta.discourse.org/u/traceymoko)
#### Post date: [April 15, 2024, 12:05pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/64 "2024-04-15T12:05:24Z")
Interestingly I can see the second picture in the quote, but not in the original post^^
---
### Author:  [@JammyDodger](https://meta.discourse.org/u/JammyDodger)
#### Post date: [April 15, 2024, 12:21pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/65 "2024-04-15T12:21:33Z")
Hmm. Thatās interesting. I think there is a fix coming for the [Missing images at Meta.discourse.org](https://meta.discourse.org/t/missing-images-at-meta-discourse-org/302963) issue, so hopefully it will be resolved by that. š¤
---
### Author:  [@Hifihedgehog](https://meta.discourse.org/u/Hifihedgehog)
#### Post date: [May 12, 2024, 2:41am UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/66 "2024-05-12T02:41:07Z")
Is there a setting I have to modify to specify the maximum length of a custom user field? Right now, in this āTestā field that I created as a test user field, I cannot enter even a single character on my user profile (or even āTestā, as shown).
---
### Author:  [@Vaping\_Community](https://meta.discourse.org/u/Vaping_Community)
#### Post date: [July 30, 2024, 6:55pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/67 "2024-07-30T18:55:14Z")
I would love a field type: link / URL is that possible?
---
### Author:  [@maiki](https://meta.discourse.org/u/maiki)
#### Post date: [July 30, 2024, 7:21pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/68 "2024-07-30T19:21:32Z")
As URLs are text, the text field technically works, @Vaping_Community. However, you may be asking for additional details such as value validation or similar.
You might search or create a #Contribute > Feature topic with what you have in mind. š
---
### Author:  [@MachineScholar](https://meta.discourse.org/u/MachineScholar)
#### Post date: [July 14, 2025, 7:34am UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/70 "2025-07-14T07:34:40Z")
Are there any plans to allow multiline/composer for custom user fields? š
> [@Is it possible to have a multi-line/longer text field in the signup form?](https://meta.discourse.org/t/is-it-possible-to-have-a-multi-line-longer-text-field-in-the-signup-form/257642):
>
> Sorry I donāt have a current installation to see for myself. I am planning to create a community that requires approval from a moderator to join. Iād like to have a custom field in the signup form where people can write a short note about themselves. Is this currently possible? If not please consider this as a feature request. Thank you!
---
### Author:  [@langstonb](https://meta.discourse.org/u/langstonb)
#### Post date: [July 22, 2025, 5:30pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/71 "2025-07-22T17:30:14Z")
Note that if you want to embed a link into one of the custom user fields, you need to use HTML syntax!
`link text`
For example, to acknowledge [community guidelines](https://meta.discourse.org/guidelines) / policies:
---
### Author:  [@rey.riel](https://meta.discourse.org/u/rey.riel)
#### Post date: [October 6, 2025, 4:56pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/75 "2025-10-06T16:56:27Z")
Am I able to tie in a custom claim from my Auth0 SSO to a custom field? Currently the user enters field information in auth0, then has to enter it a second time when signing up. Iād like the value to be mapped over if possible
---
### Author:  [@dax](https://meta.discourse.org/u/dax)
#### Post date: [October 7, 2025, 2:12pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/76 "2025-10-07T14:12:10Z")
Itās possible, yes:
>
Within your SSO endpoint, you have the capability to map the claim to the payload, e.g.:
```plaintext
const ssoPayload = {
nonce: nonce,
email: user.email,
external_id: user.sub,
username: user.nickname,
name: user.name,
add_groups: a_custom_group,
'custom.user_field_1': user['https://yourdomain.com/company_id'],
'custom.user_field_2': [etc...]
```
---
### Author:  [@rey.riel](https://meta.discourse.org/u/rey.riel)
#### Post date: [October 7, 2025, 2:44pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/77 "2025-10-07T14:44:52Z")
Thanks @dax
Is there a way to verify the field name in the db? For example, we have a first name field, I tried `custom.firstname`, `custom.first_name` and `custom.firstName`, none of which resulted in the fields being populated in the sign up screen.
Iāve checked the error logs to confirm the token fields are coming in as shown above.
---
### Author:  [@rey.riel](https://meta.discourse.org/u/rey.riel)
#### Post date: [October 7, 2025, 3:10pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/78 "2025-10-07T15:10:43Z")
digging more into the code here, is this only for a [Discourse Connect](https://meta.discourse.org/t/13045?silent=true) SSO? Weāre using the Auth0 plugin
---
### Author:  [@dax](https://meta.discourse.org/u/dax)
#### Post date: [October 7, 2025, 4:51pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/79 "2025-10-07T16:51:41Z")
> [@rey.riel](#):
>
> we have a first name field, I tried `custom.firstname`, `custom.first_name` and `custom.firstName`
The syntax needs to be `custom.user_field_x`, where `x` is the numeric field ID shown in `/admin/config/user-fields/{x}/edit`.
> [@rey.riel](#):
>
> Weāre using the Auth0 plugin
That mapping feature is not available in the Auth0 plugin directly.
That said, there are still options to achieve what youāre describing:
- creating a theme component. You can add a small front-end script that automatically syncs a Discourse custom user field with a value already stored in Auth0. For example, when a user logs in and the field is empty, the script can call a secure endpoint (a small cloud function) that fetches the field value from Auth0 and updates the Discourse profile via API.
- using automation tools. You could also use external automation services like Zapier or Make to perform that sync outside of Discourse. The advantage is that you donāt have to write/maintain code but only pay for the third-party service
- custom development. We can extend the Auth0 plugin itself to natively support mapping custom claims into user fields on login, or build a custom plugin that works in pair with the Auth0 plugin.
A clear drawback of the theme component approach is that youād need to write and maintain custom code yourself, while also being careful from a security standpoint to avoid introducing potential bugs or vulnerabilities. Honestly, itās not a solution Iād recommend for a production site like yours.
If I were in your position, Iād lean more toward the second option, using third-party tools, or consider submitting a feature request or custom work request (depending on our project managersā evaluation) to enhance the Auth0 plugin itself.
If youāre interested in exploring the last option, we can continue the discussion privately.
---
### Author:  [@stephtara](https://meta.discourse.org/u/stephtara)
#### Post date: [February 8, 2026, 2:30pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/80 "2026-02-08T14:30:20Z")
Iām wondering if there is a less fiddly way to reorganise a long list of user fields than single-clicking on the little arrows to move them up or down one step at a timeā¦? š«£
---
### Author:  [@stephtara](https://meta.discourse.org/u/stephtara)
#### Post date: [February 8, 2026, 2:39pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/81 "2026-02-08T14:39:30Z")
In the user field listing overview, I canāt see how to distinguish fields that are on the signup from and are compulsory (Je suisā¦ Pays for example) and those that are on the signup form but optional (Mes attentes). Am I missing something or is this an oversight? Itās quite cumbersome to have to edit the field to see if itās optional or not. (Not sure if this is the right place for this, wasnāt sure where to put it.)
---
### Author:  [@Moin](https://meta.discourse.org/u/Moin)
#### Post date: [February 8, 2026, 2:54pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/82 "2026-02-08T14:54:42Z")
Maybe the json which provides the data can be a little help. Itās not beautiful but you can look at `/admin/config/user-fields.json` and get something like
```plaintext
{
"id": 18,
"name": "Age",
"description": "How old are you?",
"field_type": "text",
"editable": true,
"required": false,
"requirement": "optional",
"show_on_profile": false,
"show_on_user_card": false,
"show_on_signup": false,
"searchable": false,
"position": 9
},
{
"id": 17,
"name": "pets",
"description": "choose your favourite",
"field_type": "dropdown",
"editable": true,
"required": false,
"requirement": "optional",
"show_on_profile": false,
"show_on_user_card": false,
"show_on_signup": false,
"searchable": false,
"position": 10,
"options": [
"cat",
"mouse",
"dog"
]
},
```
But of course thatās not as beautiful as information in the interface
---
### Author:  [@stephtara](https://meta.discourse.org/u/stephtara)
#### Post date: [February 8, 2026, 2:57pm UTC](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192/83 "2026-02-08T14:57:14Z")
oh that is honestly much more easy for me to work with!
Does that mean I can just edit that file and be done with it? Does it exist somewhere as such on my server, and where do I find it? ššš
[Next page](https://meta.discourse.org/t/creating-and-configuring-custom-user-fields/113192.md?page=2)