Hi All, I am fairly new to discourse and I am attempting to add a customs field but I am not able to, Could someone please help me. My code after_initialize do module ::Foo PLUGIN_NAME ||= -"discourse-myapi" STORE_NAME ||= "replies".freeze class Engine < ::Rails::Engine engine_name PLUGIN_NAME isolate_namespace Foo end end require_dependency "application_controller" class Foo::Example class << self def bump(id) cf_time = Time.zone.now DistributedMutex.synchronize("#{Foo::PLUGIN_NAME}-#{cf_time.iso8601}") do user = User.find(id) user.custom_fields['signature_url'] = cf_time user.save! return user end end end end class Foo::BarController e render_json_error e.message end end end Foo::Engine.routes.draw do' get '/custom_field_test' => 'bar#custom_field_test' end Discourse::Application.routes.append do mount ::Foo::Engine, at: '/myapiclass' end end Thanks

You also want to add a name to your custom field. The importers all use custom fields, so you could look there for examples.

Hi @pfaffman Thanks for feedback, but I am not sure if I am following it, could you please give example. And also on the rails console if I do [10] pry(main)> user = **User** .find( **1** ) [11] pry(main)> pp user.custom_fields (2.5ms) SELECT "user_custom_fields"."name", "user_custom_fields"."value" FROM "user_custom_fields" WHERE "user_custom_fields"."user_id" = 1 ORDER BY id asc {"xxxxxxxxxxxxxxxx"=>"2018-06-16 12:23:39 UTC", "test_two"=>"1234567", "fountain_cake"=>"2018-06-16 13:16:25 UTC"} => **{ **"** xxxxxxxxxxxxxxxx **"** => **"** 2018-06-16 12:23:39 UTC **"** , **"** test_two **"** => **"** 1234567 **"** , **"** fountain_cake **"** => **"** 2018-06-16 13:16:25 UTC **"** }** I can see the custom fields I added, But on the plugin: def custom_field_test begin cf_time = Time.zone.now user = User.find(1) user.custom_fields['fountain_cake'] = cf_time user.save! user_after_update = User.find(1) json = serialize_data(user_after_update, UserSerializer, root: false) render json: { user: json } rescue StandardError => e render_json_error e.message end end It returns the custom_fields as empty object, any thought ?

Look in scripts/import_scripts at any importer to see how they create custom fields.

@pfaffman thanks for let me know about the necessary of adding importers for custom field I am looking into them, On the second part of the question, do you know if Redis caches requests, when you call the DB from rails application ? because at the moment I am two distinct results, calling via the controller and directly to the database via rails console. Thanks

Anybody know how I can make the “custom_fields” on User visible ? at the moment when I fetch user object I am getting the custom_fields property is empty object/hash - {}. But if I do user.custom_fields, I can see all the custom fields, however as part of the User object is empty. Please refer to the code snippet above for more details. Thanks

For that you have to whitelist those custom fields in either public user custom fields or staff user custom fields site setting according to your need.

@vinothkannans Thanks for reply, I am new to discourse and I am not sure, when you say - public user custom fields - if you are referring to the UI part of discourse, on JS or the actual Ruby code. could you please elaborate, or point me to an example. Thanks

I mean you have to add that custom field’s name in admin site setting at the URL /admin/site_settings/category/all_results?filter=public%20user%20custom%20fields like below [Screenshot%20from%202018-06-18%2017-19-35]

@vinothkannansThanks so much, I can see the field returning as part of the API. Although I would like to know the wiring under the hood as to why you need to whitelist it ? Thanks

Custom fields may contain sensitive user data. We shouldn’t expose it by default.

Custom Field not working

Development

pfaffman (Jay Pfaffman) July 8, 2018, 5:47am 14

You probably need the data Explorer plugin to get a report.

Topic		Replies	Views
Add a custom per-user setting in a plugin Developers plugin-guides , how-to	27	5161	December 20, 2023
Creating and Adding Values to `custom_fields` via API Product Support	4	1658	August 6, 2018
Creating and configuring custom user fields Site Management how-to , user-custom-fields , users	26	19226	November 3, 2026
Getting user profile custom field via JS Feature	16	4015	March 16, 2023
How to add custom fields to models Extras pavilion	48	9767	September 30, 2025

Custom Field not working

Related topics