Sitecore 9.3 Render MediaUrls by displayname with UseDisplayName from MediaUrlBuilderOptions

Question

I have a multilanguage setup in my sitecore instance and we are using the displayname for default URLs that works great. But we also want that the media Item (images) to show up translated in the HTML.

That was working in 9.0.2 with this Implementation => Render image with display name by default

But after upgrading my current system to Sitecore 9.3 this is not working anymore. I was hoping that the new option

 var options = MediaUrlBuilderOptions.Empty;
 options.UseDisplayName = true;
 var url = MediaManager.GetMediaUrl(imageField.MediaItem, options)

is working as the name says UseDisplayName but this seems not to work. Are there some other options to get this working in sitecore 9.3?

Answer 1

I have tried with a vanilla 9.3 and it seems that UseDisplayName isn't taken into consideration at all. I have looked in the MediaUrlBuilder implementation and it seems that UseDisplayName is referenced only by the ItemUrlBuilder.

While looking at the sitecore 10.1 implementation I can see that the MediaUrlBuilder has UseDisplayName included:

public virtual string Build(MediaItem item, MediaUrlBuilderOptions options)
{
  Assert.ArgumentNotNull((object) item, nameof (item));
  Assert.ArgumentNotNull((object) options, nameof (options));
  options.SetDefaultOptions(this._defaultOptions);
  BaseUrlBuilder<MediaUrlBuilderOptions>.UrlBuildModel model = new BaseUrlBuilder<MediaUrlBuilderOptions>.UrlBuildModel()
  {
     Item = (Item) item
  };
  this.UpdateItemPath((Item) item, model, options);
  return this.BuildUrl(model, options);
}

private void UpdateItemPath(Item item,
      BaseUrlBuilder<MediaUrlBuilderOptions>.UrlBuildModel model,
      MediaUrlBuilderOptions options)
{
   ItemPathBuilder pathBuilder = this.CreatePathBuilder(options);
   model.Path = pathBuilder.Build(item, model.TargetSite);
}

internal virtual ItemPathBuilder CreatePathBuilder(MediaUrlBuilderOptions options) => new ItemPathBuilder(this._itemManager)
{
    UseDisplayName = options.UseDisplayName
};

I would get in touch with sitecore support regarding this as it seems to be a 9.3 bug. You could also try to use the code from above to see if it will fix your issue.

Answer 2

Starting from Sitecore 9.3 Sitecore generates links using a the new ItemUrlBuilder for content items and MediaUrlBuilder for media items: https://doc.sitecore.com/developers/93/sitecore-experience-manager/en/build-item-and-media-urls.html

You should try to initialize a new MediaUrlBuilderOption instead of empty like:

var options =new Sitecore.Resources.Media.MediaUrlOptions();
options.UseDisplayName = true;
var url = MediaManager.GetMediaUrl(imageField.MediaItem, options)

and you can do a sitecore config patch file(recommended solution), or change directly in the default Sitecore.config file the ItemUrlBuilder section:

<links>
  <urlBuilder>
    <useDisplayName>true</useDisplayName>
    ...
  </urlBuilder>
    <itemUrlBuilder type="Sitecore.Links.UrlBuilders.ItemUrlBuilder, Sitecore.Kernel">
            <param desc="defaultOptions" type="Sitecore.Links.UrlBuilders.DefaultItemUrlBuilderOptions, Sitecore.Kernel">
                <useDisplayName ref="links/urlBuilder/useDisplayName" />
                ....

Or create a custom ItemUrlBuilder for these media calls, and then initialize that one. Your choice.

Answer 3

I've talked to the Sitecore Service and this is not a bug that the useDisplayName is not working, its just like it is in 9.3.

But I got a code snipped I am currently trying the following Code to solve my problem:

public class CustomMediaProvider : MediaProvider
{
    public override string GetMediaUrl(MediaItem item, MediaUrlBuilderOptions options)
    {
     
        try
        {
            if (Context.PageMode.IsNormal)
            {
                string url = base.GetMediaUrl(item, options);
                string displayName = options.LowercaseUrls == true
                    ? MainUtil.EncodeName(item.DisplayName.ToLower())
                    : MainUtil.EncodeName(item.DisplayName);
                string itemName = options.LowercaseUrls == true
                    ? MainUtil.EncodeName(item.Name.ToLower())
                    : MainUtil.EncodeName(item.Name);
                string extension = WebUtil.SafeEncode(StringUtil.EnsurePrefix('.',
                    StringUtil.GetString(options.RequestExtension, item.Extension, "ashx")));
                if (!string.IsNullOrEmpty(displayName) && url.Contains(itemName + extension))
                {
                    url = url.Replace(itemName + extension, displayName + extension);
                }

                return url;
            }
        }
        catch (Exception exception)
        {
            Log.Error($"Fehler beim CustomMediaProvider für das Item mit der id: {item.ID}", exception, typeof(Exception));
        }

        return base.GetMediaUrl(item, options);
    }
}

and I've registered this

<mediaLibrary>
  <mediaProvider>
    <patch:attribute name="type">NamespaceTo.CustomMediaProvider, Sales.Test.Feature.Media</patch:attribute>
  </mediaProvider>
</mediaLibrary>