Creating and configuring custom user fields

[Discourse]

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 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:

3. Check the custom user fields you want to display
4. 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:

[traceymoko (Tracey)]

По-моему, под этими заголовками отсутствуют два изображения:

• Добавление пользовательского поля
• Отображение на карточке пользователя

Не уверен, связано ли это с темой Отсутствующие изображения на Meta.discourse.org — опубликую там тоже.

[JammyDodger]

Я вижу эти изображения? (также в окне инкогнито)

[Moin]

Я не вижу эти

@simon

вот так:

@simon

Отображать на карточке пользователя

Выберите эту опцию, чтобы отображать поле на карточке пользователя. Значение поля будет показано рядом с именем поля.

Ищется

Но второе работает в моём цитировании.

Изменить

[traceymoko (Tracey)]

Любопытно, я вижу вторую картинку в цитате, но не в оригинальном посте ^^

[JammyDodger]

Хм, это интересно. Думаю, скоро выйдет исправление для проблемы Missing images at Meta.discourse.org, так что, надеюсь, всё уладится.

[Hifihedgehog]

Есть ли настройка, которую мне нужно изменить, чтобы указать максимальную длину пользовательского поля? Сейчас в этом поле «Test», которое я создал как тестовое пользовательское поле, я не могу ввести даже один символ в своём профиле (даже слово «Test», как показано на скриншоте).

[Vaping_Community]

Мне бы очень понравился тип поля: ссылка / URL. Это возможно?

[maiki]

Так как URL — это текст, текстовое поле технически работает, @Vaping_Community. Однако, возможно, вы ищете дополнительные возможности, такие как валидация значений или что-то подобное.

Вы можете поискать или создать тему с тегом #feature с описанием вашей идеи.

[MachineScholar]

Есть ли планы разрешить многострочный ввод/компоновку для пользовательских полей?

Is it possible to have a multi-line/longer text field in the signup form?

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!

[langstonb (Brittany Langston)]

Обратите внимание: если вы хотите вставить ссылку в одно из пользовательских полей, необходимо использовать HTML-синтаксис!
<a href="url">текст ссылки</a>

Например, для указания на правила/политики сообщества:

[rey.riel (Rey)]

Могу ли я сопоставить пользовательское утверждение из моего SSO в Auth0 с пользовательским полем? Сейчас пользователь вводит информацию о поле в Auth0, а затем должен ввести её повторно при регистрации. Я хотел бы, чтобы значение было перенесено автоматически, если это возможно.

[dax (Daniela)]

Это возможно, да:

spec/requests/session_controller_spec.rb

В вашей конечной точке SSO вы можете сопоставить утверждение с полезной нагрузкой, например:

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':  [и так далее...]

[rey.riel (Rey)]

Спасибо @dax

Есть ли способ проверить имя поля в базе данных? Например, у нас есть поле «имя», я пробовал custom.firstname, custom.first_name и custom.firstName, но ни один из них не привел к заполнению полей на экране регистрации.

Я проверил логи ошибок, чтобы подтвердить, что токены полей приходят так, как показано выше.

[rey.riel (Rey)]

Разбираясь в коде глубже, это только для SSO Discourse Connect? Мы используем плагин Auth0

[dax (Daniela)]

@rey.riel

У нас есть поле «Имя», я пробовал custom.firstname, custom.first_name и custom.firstName

Синтаксис должен быть custom.user_field_x, где x — числовой идентификатор поля, отображаемый в /admin/config/user-fields/{x}/edit.

@rey.riel

Мы используем плагин Auth0

Функция сопоставления недоступна напрямую в плагине Auth0.

Тем не менее, есть варианты реализации того, что вы описываете:

• создание компонента темы. Вы можете добавить небольшой фронтенд-скрипт, который автоматически синхронизирует пользовательское поле в Discourse со значением, уже сохранённым в Auth0. Например, когда пользователь входит в систему, а поле пустое, скрипт может вызвать защищённую конечную точку (небольшую облачную функцию), которая получит значение поля из Auth0 и обновит профиль в Discourse через API.
• использование инструментов автоматизации. Вы также можете использовать внешние сервисы автоматизации, такие как Zapier или Make, для выполнения этой синхронизации вне Discourse. Преимущество в том, что вам не нужно писать или поддерживать код, достаточно только платить за сторонний сервис.
• кастомная разработка. Мы можем расширить сам плагин Auth0, чтобы он нативно поддерживал сопоставление пользовательских утверждений (custom claims) с пользовательскими полями при входе, либо создать собственный плагин, работающий в паре с плагином Auth0.

Явный недостаток подхода с компонентом темы заключается в том, что вам придётся самостоятельно писать и поддерживать кастомный код, а также проявлять осторожность с точки зрения безопасности, чтобы не допустить потенциальных ошибок или уязвимостей. Честно говоря, это не решение, которое я бы рекомендовал для продакшн-сайта, подобного вашему.

Если бы я был на вашем месте, я бы склонился ко второму варианту — использованию сторонних инструментов, или рассмотрел бы возможность подачи запроса на новую функцию или запроса на кастомную разработку (в зависимости от оценки нашими менеджерами проектов) для расширения самого плагина Auth0.

Если вы заинтересованы в рассмотрении последнего варианта, мы можем продолжить обсуждение в личном порядке.

[stephtara (Stephanie Booth)]

Интересует, есть ли более удобный способ реорганизовать длинный список полей пользователя, чем по одному кликать на маленькие стрелочки, чтобы перемещать их вверх или вниз по одному шагу за раз…?

[stephtara (Stephanie Booth)]

В общем списке полей пользователя я не вижу, как отличить обязательные поля (например, «Je suis… Pays»), которые отображаются в форме регистрации, от необязательных (например, «Mes attentes»). Я что-то упускаю, или это упущение? Очень неудобно редактировать поле, чтобы узнать, является ли оно необязательным. (Не уверен, что это правильное место для такого вопроса, не знал, куда его разместить.)

[Moin]

Возможно, JSON, предоставляющий данные, может немного помочь. Это не совсем красиво, но вы можете посмотреть на /admin/config/user-fields.json и увидеть что-то вроде

    {
      "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"
      ]
    },

Но, конечно, это не так красиво, как информация в интерфейсе.

[stephtara (Stephanie Booth)]

Ого, это действительно гораздо удобнее для работы!
Значит, я могу просто отредактировать этот файл и всё готово? Существует ли он в таком виде на моём сервере и где его найти?