User Custom Fields
User custom fields let you create your own fields for collecting and storing useful data about your users. Various types of fields are available, and can be required to be filled in or hidden to the user.
Custom Field Types
There are 10 available field types for user custom fields:
- Boolean - Yes and no radio options.
- Checkbox - A single checkbox.
- Checklist - A list of options with a checkbox for each.
- Date - A date picker.
- Multiple options - A multiple select box, allowing the choice of multiple items at once.
- Options - A dropdown box.
- Password - A password field, useful for sensitive information.
- Radio - A list of radio options, only one can be selected.
- Text - A normal text input field.
- Textarea - A larger field allowing more text to be written.
Ordering Custom Fields
You may wish to change the order that the custom fields are shown, it can be done by dragging and dropping rows on the grid to the order you prefer.
Searching for Custom Fields
Filtering the table
It's possible to filter custom fields based on their name and other options:
- Visit Settings -> Users -> User Custom Fields and click "Filter Results".
- Name - It is possible to search for partial names. For example, you could find "Hostname" by searching for "host" or "nam".
- Depends On - If the field depends on another custom field and option to be displayed.
- Type - The field type (see Custom Field Types). The drop-down list is populated based on the contents of the table.
- Required - If the field is required when creating and updating an account.
- Public - If the field is visible in the frontend to users or for operators only.
- Encrypted - If the field value is encrypted in the database after saving, operators will see the unencrypted value.
- Locked - If the field value cannot be changed by the user once it has been set, operators will be free to change it.
- The table will be filtered automatically as you enter search terms.
Creating or Updating a Custom Field
A user, by default, will have fields for collecting first and last name, email, country, language and timezone. These fields cannot be changed, but you can add other fields to collect and store other information.
To create a new custom field, or update an existing custom field, please follow the following steps.
- Visit Settings -> Users -> User Custom Fields. If you're creating a new custom field click "Add User Custom Field", or if you're updating an existing custom field, find the field and click the edit (pencil) icon on the right side of the table row.
Complete the input fields:
- Name - The name of the custom field that may be visible to users in the frontend.
- Description - A description of the custom field that will be appear below to help users in the frontend.
- Type - The custom field type (see Custom Field Types). Please note that the type cannot be changed once values exists in the database for this custom field.
- Depends On - Set the custom field to show only if another custom field is set to a specific option. Only works with Options type custom fields.
- Options - If the type is Checklist, Multiple Options, Options or Radio Buttons, a list of available options must be created.
- Required - If the custom field must be filled out when creating or updating a user account.
- Public - If the custom field is visible to users when creating and updating their account on the frontend. Toggle to show only to operators.
- Encrypted - If the type is Password, Text or Textarea, the custom field value may be encrypted in the database when it is saved. This is useful for sensitive data such as passwords and personal information. The values will show unencrypted to operators, but will not show again to users.
- Locked - If the custom field value cannot be changed once it has been entered by the user. This only applies in the frontend, operators will be free to edit the field.
- Click the "Submit" button.
Deleting a Custom Field
Deleting a custom field is an irreversible action. When deleting a custom field, all associated values will also be permanently removed.
If you prefer not to permanently remove the values associated with a custom field, we recommend to simply toggle the public setting on the custom field.
To delete a custom field, follow the below steps:
- Visit Settings -> Users -> User Custom Fields.
- Search for the custom field you wish to delete (see Searching for Custom Fields).
- Click the delete (cross) icon located on the right of the table.
- Click on the left button, "Yes, Delete User Custom Field", that pops up confirming you would like to delete this custom field and it will now be deleted.