orchardcore-custom-user-settings

Orchard Core Custom User Settings - Prompt Templates

Create Custom User Settings

You are an Orchard Core expert. Generate code and configuration for creating custom per-user settings sections using the CustomUserSettings stereotype.

Guidelines

• Enable the OrchardCore.Users.CustomUserSettings feature to use custom user settings.
• Custom user settings are organized in sections, each represented by a content type with the CustomUserSettings stereotype.
• When creating a custom user settings content type, disable Creatable, Listable, Draftable, and Securable metadata — they do not apply.
• Do not mark existing content types with the CustomUserSettings stereotype; this will break existing content items of that type.
• Each section appears as a separate tab in the user editor (Access Control → Users → Edit).
• Custom user settings are composed of parts and fields like any other content type.
• Access user settings in Liquid by loading the user and accessing user.Properties.
• Placement can be customized to move sections out of tabs using the CustomUserSettings-PartDefinitionName differentiator.
• Extend user properties programmatically using SectionDisplayDriver<User, TSection>.
• All C# classes must use the sealed modifier, except View Models.
• All recipe JSON must be wrapped in the root { "steps": [...] } format.

Enabling Custom User Settings

{
  "steps": [
    {
      "name": "Feature",
      "enable": [
        "OrchardCore.Users",
        "OrchardCore.Users.CustomUserSettings"
      ],
      "disable": []
    }
  ]
}

Creating a Custom User Settings Type

Step 1: Define the Content Type with CustomUserSettings Stereotype

Use a data migration to create the content type:

public sealed class Migrations : DataMigration
{
    private readonly IContentDefinitionManager _contentDefinitionManager;

    public Migrations(IContentDefinitionManager contentDefinitionManager)
    {
        _contentDefinitionManager = contentDefinitionManager;
    }

    public async Task<int> CreateAsync()
    {
        await _contentDefinitionManager.AlterTypeDefinitionAsync("UserProfile", type => type
            .DisplayedAs("User Profile")
            .Stereotype("CustomUserSettings")
            .WithPart("UserProfile", part => part
                .WithPosition("0")
            )
        );

        await _contentDefinitionManager.AlterPartDefinitionAsync("UserProfile", part => part
            .WithField("FirstName", field => field
                .OfType("TextField")
                .WithDisplayName("First Name")
                .WithPosition("0")
            )
            .WithField("LastName", field => field
                .OfType("TextField")
                .WithDisplayName("Last Name")
                .WithPosition("1")
            )
            .WithField("Bio", field => field
                .OfType("TextField")
                .WithDisplayName("Biography")
                .WithPosition("2")
                .WithEditor("TextArea")
            )
            .WithField("Avatar", field => field
                .OfType("MediaField")
                .WithDisplayName("Profile Picture")
                .WithPosition("3")
            )
        );

        return 1;
    }
}