Wat doet api.addSaveableUserOptionField?

Er is vrijwel geen documentatie over dit onderwerp en het plugin API-bestand bevat geen commentaar dat het gebruik van deze functie uitlegt. Bovendien is de enige plek waar ik het kan zien gebruikt in plugins, niet in de kern. Dus wat doet api.addSaveableUserOptionField() precies? Is er aanvullende configuratie nodig om het te gebruiken?

I don’t know, but here’s what I think I found out.

But first–My question is why do you care? Is there something you’re trying to do? But maybe if you’re trying to create a plugin that has user options, this is how to to do it. It’s not used in core since it’s a hook especially for plugins to be able to have their own user options.

Looks like it’s used in the Chat plugin like here:

Looks like if your plugin has user options then you use this to establish that it’s a user option with the UserUpdater.

1 like

Ja, ik ben van plan om een gebruikersinstelling in een plugin te hebben. Ik zag eerder dat Chat en ik meen me te herinneren dat AI deze functie gebruikten om gebruikersinstellingen toe te voegen, dus ik vroeg me af of er een gedocumenteerde manier was om dit te doen.

1 like

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

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.

1 like

It looks like it works for both custom fields added in the UX and via a plugin. For custom fields, they get names like user_field_1, I’m pretty sure. You can look in the table with data explorer, for example. Or maybe it means only fields added by the UX (“admin-defined profile fields”), in which case you’d use the name you gave it when you created it. I’d just try it both ways.

And github is down, so I can’t look at the code there.

1 like