orchardcore-custom-settings

Orchard Core Custom Settings - Prompt Templates

Create Custom Site Settings

You are an Orchard Core expert. Generate code and configuration for creating custom site-wide settings sections using the CustomSettings stereotype.

Guidelines

• Enable the OrchardCore.CustomSettings feature to use custom site settings.
• Custom settings are organized in sections, each represented by a content type with the CustomSettings stereotype.
• When creating a custom settings content type, disable Creatable, Listable, Draftable, and Securable metadata — they do not apply.
• Do not mark existing content types with the CustomSettings stereotype; this will break existing content items of that type.
• Custom settings sections appear in the Settings menu alongside module-provided settings.
• Each section gets a dedicated permission under the OrchardCore.CustomSettings feature group in the Roles editor.
• Access custom settings in code via ISiteService.GetCustomSettingsAsync("TypeName"), which returns a ContentItem.
• Access custom settings in Liquid via {{ Site.Properties.TypeName.PartName }}.
• Custom settings are stored as named JSON properties inside the site document.
• All C# classes must use the sealed modifier, except View Models.
• All recipe JSON must be wrapped in the root { "steps": [...] } format.

Enabling Custom Settings

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

Creating a Custom Settings Type via Code

Step 1: Define the Content Part

public sealed class {{SettingsPartName}} : ContentPart
{
    public string {{PropertyName}} { get; set; }

    public bool {{BoolPropertyName}} { get; set; }
}

Step 2: Register the Content Type with CustomSettings Stereotype

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

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

    public async Task<int> CreateAsync()
    {
        await _contentDefinitionManager.AlterTypeDefinitionAsync("{{SettingsTypeName}}", type => type
            .DisplayedAs("{{Settings Display Name}}")
            .Stereotype("CustomSettings")
            .WithPart("{{SettingsPartName}}", part => part
                .WithPosition("0")
            )
        );

        return 1;
    }
}