K Khan
Sep 19, 2024
  1616
(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
Optimizely Opal: How to Build Effective Workflow Agents

If you're building workflow agents in Optimizely Opal, this post covers how specialized agents pass context to each other, why keeping agents small...

Andre | May 20, 2026

ReviewPR: An Azure Function That Reviews Your Azure DevOps Pull Requests With Claude

A while back I wrote about an  Azure Function App for PDF creation that we use to offload PDF rendering from our Optimizely DXP site. That same...

KennyG | May 19, 2026

Accelerating Optimizely CMS and Commerce upgrades with agentic AI (Part 2 of 2)

The Real Transformation in Optimizely CMS 13: Why the Upgrade Itself Is the Easy Part. A field-tested playbook for enterprise teams moving from...

Hung Le Hoang | May 18, 2026

Is the most powerful AI model really the best value?

Artificial Intelligence is already becoming part of everyday software development. Developers now use AI tools to generate code, write documentatio...

K Khan | May 16, 2026