Skip to main content

Code reviews rule: Use of deprecated: SiteSettings

Written by David Martin
Updated this week

Use of deprecated: SiteSettings

Why is this an issue?

The enableExperienceFriendlyUrls field on the SiteSettings metadata type has been deprecated. Continuing to use deprecated fields may cause deployment issues and creates technical debt.

Examples

Example of incorrect metadata (using deprecated field):

<SiteSettings>
<enableExperienceFriendlyUrls>true</enableExperienceFriendlyUrls>
</SiteSettings>

Example of correct metadata:

<SiteSettings>
<!-- Remove the deprecated enableExperienceFriendlyUrls field -->
</SiteSettings>

How can I fix violations?

  1. Remove the deprecated field: Edit your SiteSettings metadata file and remove the enableExperienceFriendlyUrls element.

  2. Use alternative configuration: If you need to configure friendly URLs, use the current recommended approach in Experience Cloud settings.

Resources

Did this answer your question?