K Khan
Sep 19, 2024
  1475
(1 votes)

keep special characters in URL

When creating a page, the default URL segment validation automatically replaces special characters with their standard equivalents (e.g., "ä" is replaced with "a"). However, some clients may require these special characters to remain intact in URLs for non-English versions of their website.

var validChars = "ü ö ä ß ó ñ á á é í ó ő ú ü ñ"; 

For CMS 12

//Startup.cs
services.Configure<UrlSegmentOptions>(config => {
    config.SupportIriCharacters = true;
    config.ValidCharacters = @"A-Za-z0-9\-_~\.\$" + validChars;
}); 

For CMS 11

[InitializableModule]
[ModuleDependency(typeof(EPiServer.Web.InitializationModule))]
public class UrlSegmentConfigurationModule : IConfigurableModule
{
    public void ConfigureContainer(ServiceConfigurationContext context)
    {
        var validChars = "ü ö ä ß ó ñ á á é í ó ő ú ü ñ"; 
        context.Services.RemoveAll<UrlSegmentOptions>();
        context.Services.AddSingleton<UrlSegmentOptions>(s => new UrlSegmentOptions
        {
            SupportIriCharacters = true,
            ValidCharacters = @"\p{L}0-9\-_~\.\$" + validChars
        });
    }

    public void Initialize(InitializationEngine context){}

    public void Uninitialize(InitializationEngine context) { }
}

References:

Sep 19, 2024

Comments

Mark Stott
Mark Stott Sep 20, 2024 08:18 AM

Hello Khan,

It's worth noting that the builtin Optimizely behaviour is in alignment with the current RFC 3986 URI (Uniform Resource Identifier) specification.  I've had issues before with non-compliant characters within URLs and iterpretation by the browser and documentation platforms with confusion of encoding.  In these cases I would personally recommend against this.

K Khan
K Khan Sep 20, 2024 08:25 AM

Make sense, thanks for sharing.

Please login to comment.
Latest blogs
Missing Properties tool for Optimizely CMS

If you have been working with Optimizely CMS for a while you have probably accumulated some technical debt in your property definitions. When you...

Per Nergård (MVP) | Mar 10, 2026

AI Generated Optimizely Developer Newsletter

Updates in the Optimizely ecosystem are everywhere: blog posts, forums, release notes, NuGet packages, and documentation changes. This newsletter...

Allan Thraen | Mar 10, 2026 |

Lessons from Building Production-Ready Opal Tools

AI tools are becoming a normal part of modern digital platforms. With  Optimizely Opal , teams can build tools that automate real tasks across the...

Praful Jangid | Mar 7, 2026

My Takeaway from Optimizely Opal Agents in Action 2026 - What Agentic AI Means for the Future of Digital Marketing

I would like to share with you what stayed in my head after this amazing virtual event organized by Optimizely. Agents in Action 2026 , a live...

Augusto Davalos | Mar 6, 2026