Add a custom per-user setting in a plugin

[Falco]

I’m testing this here

Use correct method signature

and it builds fine. Not sure about functionality as I have never used the plugin and I have no idea what to test for.

The register_editable_user_custom_field method signature is a field name and an optional flag to mark it as staff_only, so as far as I can tell, passing an array to it is unexpected?

[merefield (Robert)]

Yeah, it’s unusual?

But apparently David’s solution seems to resolve the issue.

This:

  register_editable_user_custom_field :geo_location if defined? register_editable_user_custom_field
  register_editable_user_custom_field geo_location: {} if defined? register_editable_user_custom_field

breaks. this doesn’t:

 register_editable_user_custom_field [:geo_location,  geo_location: {}] if defined? register_editable_user_custom_field

Does look like the Ruby version forced this change though?

In any case I believe we have a solution and should update the OP?

I’ll need to make a change on one more plugin, and will update the wiki above if happy.

[merefield (Robert)]

FYI seems to be working both building and functioning

Thanks for your help.

[RGJ (Richard - Communiteq)]

@david

could this be Ruby 3.x related?

I think it’s this, Separation of positional and keyword arguments in Ruby 3.0

[pirhoo (Pierre Romera)]

Hello

I’m trying to create a custom user field from a plugin but I’m not sure I fully understand what you’re describing here. In my plugin if I do:

register_editable_user_custom_field 'foo'

Should I still use plugin outlets connectors to display it on the user profile and the user card?

Or is there a mechanism like the custom field in the admin that can add it automatically (including in the users directory)? I want to avoid adding connector and serializer field if there is already a way to do this.

Thanks for your help!

[merefield (Robert)]

See?:

Adding non-visible User Custom Fields to the API

This is a quick walkthrough on how to use the public user custom fields or staff user custom fields admin setting to expose User Custom Field data through the API without displaying it on a user card. [public/staff user custom field settings] First, create your User Custom Field. You can find out more detail about that in Create and configure custom user fields Here’s mine: [test user custom field] Once you have that set up and saved, you can now visit the user fields json at /admin/custo…

[pirhoo (Pierre Romera)]

Hello @merefield, thanks for the link but it’s not what I’m asking. Looks like it’s to make custom field created in the admin non-visible except with a staff API key.

If I am unclear, let me reformulate: is there a way to register a custom user field with a plugin, just like we can do within the admins “User Fields” (editable, searchable, shown on user profile, on user card, etc)?

[merefield (Robert)]

Apologies, I wonder if this might be more helpful then?:

How to add custom fields to models

This is a collection of education plugins that demonstrate how to add a custom field to different models in Discourse. They are intended as learning tools for those looking to learn how to build discourse plugins. [GitHub-Mark] How to add a custom field to a topic [GitHub-Mark] How to add a custom field to a category Who they’re for These plugins are for people looking to learn more about creating Discourse plugins. Before you start working with these plugins, you should complete the beginne…

The main models all have a Custom Field capability.