Orchardcore Url Rewriting

Orchard Core URL Rewriting - Prompt Templates

Configure URL Rewriting and Redirects

You are an Orchard Core expert. Generate URL rewrite rules, redirect configurations, and custom rule sources for Orchard Core.

Guidelines

• Enable OrchardCore.UrlRewriting for URL rewrite and redirect support.
• Rules are processed sequentially based on their position; the first matching rule wins.
• Use Redirect Rules (301/302/307/308) to send users to a new URL (browser address bar changes).
• Use Rewrite Rules to serve content from a different URL without changing the browser address bar.
• Patterns use regular expressions; use ^ and $ for exact matches.
• Use $1, $2, etc. in substitution patterns to reference regex capture groups.
• Set IsCaseInsensitive to true for case-insensitive pattern matching.
• Configure QueryStringPolicy to Append (keep query strings) or Drop (discard them).
• Custom rule sources implement IUrlRewriteRuleSource and are registered with services.AddRewriteRuleSource<T>().
• Use the admin UI drag-and-drop to reorder rules.
• Always seal classes.

Enabling URL Rewriting

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

Available Rule Types

Redirect Rule Properties

Rewrite Rule Properties

Redirect Type Reference

Recipe: Create Redirect and Rewrite Rules

{
  "steps": [
    {
      "name": "UrlRewriting",
      "Rules": [
        {
          "Source": "Redirect",
          "Name": "Redirect old-page to new-page",
          "Pattern": "^/old-page$",
          "SubstitutionPattern": "/new-page",
          "IsCaseInsensitive": true,
          "QueryStringPolicy": "Append",
          "RedirectType": "MovedPermanently"
        },
        {
          "Source": "Redirect",
          "Name": "Redirect legacy blog URLs",
          "Pattern": "^/blog/post/(\\d+)$",
          "SubstitutionPattern": "/articles/$1",
          "IsCaseInsensitive": true,
          "QueryStringPolicy": "Drop",
          "RedirectType": "MovedPermanently"
        },
        {
          "Source": "Rewrite",
          "Name": "Serve media from img path",
          "Pattern": "^/img/(.*)$",
          "SubstitutionPattern": "/media/$1",
          "IsCaseInsensitive": true,
          "QueryStringPolicy": "Drop",
          "SkipFurtherRules": true
        }
      ]
    }
  ]
}

Custom Rule Source Implementation

using Microsoft.AspNetCore.Rewrite;
using Microsoft.Extensions.Localization;
using OrchardCore.UrlRewriting;
using OrchardCore.UrlRewriting.Models;

namespace MyModule.UrlRewriting;

public sealed class CustomRuleSource : IUrlRewriteRuleSource
{
    public const string SourceName = "CustomRule";

    public CustomRuleSource(IStringLocalizer<CustomRuleSource> stringLocalizer)
    {
        DisplayName = stringLocalizer["Custom rule"];
        Description = stringLocalizer["Custom URL rewrite rule"];
    }

    public string TechnicalName => SourceName;

    public LocalizedString DisplayName { get; }

    public LocalizedString Description { get; }

    public void Configure(RewriteOptions options, RewriteRule rule)
    {
        // Read custom metadata from rule.Properties and add the corresponding ASP.NET Core rewrite rules to options.
    }
}

Custom Rule Display Driver

using Microsoft.Extensions.DependencyInjection;
using OrchardCore.DisplayManagement.Handlers;
using OrchardCore.DisplayManagement.Views;
using OrchardCore.UrlRewriting;
using OrchardCore.UrlRewriting.Models;

namespace MyModule.UrlRewriting;

public sealed class CustomRuleDisplayDriver : DisplayDriver<RewriteRule>
{
    public override IDisplayResult Edit(RewriteRule model, BuildEditorContext context)
    {
        return Initialize<CustomRuleViewModel>("CustomRule_Fields_Edit", viewModel =>
        {
            // Populate view model from model properties.
        }).Location("Content");
    }

    public override async Task<IDisplayResult> UpdateAsync(RewriteRule model, UpdateEditorContext context)
    {
        var viewModel = new CustomRuleViewModel();
        await context.Updater.TryUpdateModelAsync(viewModel, Prefix);

        // Apply view model values to the model.

        return Edit(model, context);
    }
}

public class CustomRuleViewModel
{
    public string CustomProperty { get; set; }
}

Registering a Custom Rule Source in Startup

using OrchardCore.DisplayManagement.Handlers;
using OrchardCore.Modules;
using OrchardCore.UrlRewriting.Models;

namespace MyModule;

public sealed class Startup : StartupBase
{
    public override void ConfigureServices(IServiceCollection services)
    {
        services.AddRewriteRuleSource<CustomRuleSource>(CustomRuleSource.SourceName)
            .AddScoped<IDisplayDriver<RewriteRule>, CustomRuleDisplayDriver>();
    }
}

Common Redirect Patterns

Common Rewrite Patterns