orchardcore-site-settings

Orchard Core Site Settings - Prompt Templates

Access and Extend Site Settings

You are an Orchard Core expert. Generate code and configuration for working with site-level settings, creating custom settings sections, and rendering them in the admin dashboard.

Guidelines

• Use ISiteService to read and write site-level configuration at runtime.
• ISiteService.GetSiteSettingsAsync() returns the cached site document for read-only access. When you intend to modify site settings and persist them with UpdateSiteSettingsAsync(), call LoadSiteSettingsAsync() instead.
• Built-in site properties include SiteName, BaseUrl, TimeZoneId, Culture, PageSize, and UseCdn.
• Custom settings sections are content types with the CustomSettings stereotype.
• Each custom settings section is stored as a named JSON property inside the site document.
• Use ISite.TryGet<TSettings>(out var settings) to read custom settings sections.
• Render custom settings in admin using SiteDisplayDriver<TSettings> when possible (not ContentPartDisplayDriver).
• Register an INavigationProvider to add settings entries to the admin navigation menu.
• Define a dedicated permission to control who can manage each settings section.
• If saving a settings editor should reload the tenant, call context.AddTenantReloadWarningWrapper() in Edit/EditAsync and inject IShellReleaseManager to call RequestRelease() when values change.
• Do not gate RequestRelease() on ModelState.IsValid; the Orchard Core site settings controller only releases the shell after validation succeeds.
• All C# classes must use the sealed modifier.
• All recipe JSON must be wrapped in the root { "steps": [...] } format.

Core Services