What does api.addSaveableUserOptionField do?

NateDhaliwal · February 9, 2026, 8:16am

Coming back to this, there seems to be more info on this.

frontend/discourse/app/lib/plugin-api.gjs

main


      
           *
           **/
          addAdvancedSearchOptions(options) {
            addAdvancedSearchOptions(options);
          }
          
          /**
           * Registers a user field that can be saved via the user preferences API.
           * User fields are admin-defined profile fields stored in the user_fields table.
           *
           * @param {string} fieldName - The name of the user field to save
           * @param {Object} [options] - Optional configuration
           * @param {string} [options.page] - The preferences page where this field should be saved.
           *   Valid pages: "account", "emails", "interface", "navigation-menu", "notifications",
           *   "profile", "tags", "tracking", "users"
           *
           * @example
           * // Register a user field that will be saved on the emails preferences page
           * api.addSaveableUserField("newsletter_subscribe", { page: "emails" });
           */

This file has been truncated. show original

This now lists 3 functions: addSaveableUserField(), addSaveableUserOption(), and addSaveableCustomFields().

It seems like the 1st refers to adding and saving admin-defined custom user fields. However, the next 2 aren’t so clear. Do they require a plugin to use register_custom_user_field :... in the backend? Does more need to be done, or can it work in a TC?

Thanks.

Topic		Replies	Views
Add a custom per-user setting in a plugin Developers plugin-guides , how-to	27	5085	December 20, 2023
Creating and configuring custom user fields Site Management how-to , user-custom-fields , users	25	18973	April 8, 2026
Adding Custom Fields via Plugin Outlet Development	4	1264	December 19, 2019
User preference on theme components Development	1	1061	May 22, 2021
How to add custom fields to models Extras pavilion	48	9614	September 30, 2025

What does api.addSaveableUserOptionField do?

Related topics