--- schema_version: "1" id: b95c2947cebed9566970e406647177c1d9ac0df2a04ba030514c7b882b61c0d4 title: Salesforce Sites-Related Apex Methods and Expressions collection: admin version: current locale: en-us portal_url: https://docs.salesforce.com/admin/current/en-us/platform/264-0-0/sites_apex_methods_and_merge_fields.md canonical_url: https://help.salesforce.com/s/articleView?id=platform.sites_apex_methods_and_merge_fields.htm&release=264.0.0&type=5 source_site: help.salesforce.com content_type: documentation content_hash: 8597fe312d5df2fd6bd0747cde4b2556842962b1f7bf45c45076ed2209502ab5 description: Lightning Platform provides Apex methods and Salesforce Sites-related expressions to help execute flow and transaction control statements. products: - Salesforce Platform - Security release: "264" --- # Salesforce Sites-Related Apex Methods and Expressions Lightning Platform provides Apex methods and Salesforce Sites-related expressions to help execute flow and transaction control statements. ### Required Editions
Available in: both Salesforce Classic and Lightning Experience
Available in: Developer, Enterprise, Performance, and Unlimited Editions
User Permissions Needed
To create and edit Salesforce Sites:

Customize Application

OR

Create and Set Up Experiences
## Lightning Platform Apex Methods Apex methods for Salesforce Sites are contained in the `site` class, `cookie` class, and `urlRewriter` class. See the [Lightning Platform Apex Code Developer's Guide](https://developer.salesforce.com/docs/atlas.en-us.apexcode.meta/apexcode/). ## Salesforce Sites-Related Expressions Salesforce Sites-related expressions can be used on Visualforce pages, email templates, and s-controls.
Merge Field Description
$Site.Name Returns the API name of the current site.
$Site.Domain Returns your Salesforce Sites based URL.
$Site.CustomWebAddress Returns the request's custom URL if it doesn't end in force.com or returns the site's primary custom URL. If neither exist, $Site.CustomWebAddress returns an empty string. The URL's path is always the root, even if the request's custom URL has a path prefix. If the current request isn’t a site request, then this field returns an empty string. This field's value always ends with a / character. Use of $Site.CustomWebAddress is discouraged and we recommend using $Site.BaseCustomUrl instead.
$Site.OriginalUrl Returns the original URL for this page if it's a designated error page for the site; otherwise, returns null.
$Site.CurrentSiteUrl Returns the base URL of the current site that references and links use. This field can return the referring page's URL instead of the current request's URL. This field's value includes a path prefix and always ends with a / character. If the current request isn’t a site request, then this field returns an empty string. Use of $Site.CurrentSiteUrl is discouraged. Use $Site.BaseUrl instead.
$Site.LoginEnabled Returns true if the current site is associated with an active login-enabled portal; otherwise returns false.
$Site.RegistrationEnabled Returns true if the current site is associated with an active self-registration-enabled Customer Portal; otherwise returns false.
$Site.IsPasswordExpired For authenticated users, returns true if the currently logged-in user's password is expired. For non-authenticated users, returns false.
$Site.AdminEmailAddress Returns an empty string. This merge field is deprecated.
$Site.Prefix Returns the URL path prefix of the current site. For example, if your site URL is MyDomainName.my.salesforce-sites.com/partners, /partners is the path prefix. Returns null if the prefix isn’t defined. If the current request isn’t a site request, then this field returns an empty string.
$Site.Template Returns the template name associated with the current site; returns the default template if no template has been designated.
$Site.ErrorMessage Returns an error message for the current page if it's a designated error page for the site and an error exists; otherwise, returns an empty string.
$Site.ErrorDescription Returns the error description for the current page if it's a designated error page for the site and an error exists; otherwise, returns an empty string.
$Site.AnalyticsTrackingCode The tracking code associated with your site. Services such as Google Analytics can use this code to track page request data for your site.
$Site.BaseCustomUrl

Returns a base URL for the current site that doesn't use a subdomain. The returned URL uses the same protocol (HTTP or HTTPS) as the current request if at least one non-force.com custom URL that supports HTTPS exists on the site. The returned value never ends with a / character. If all the custom URLs in this site end in salesforce-sites.com or if this site has no custom URLs, $Site.BaseCustomUrl returns an empty string. If the current request isn’t a site request, then this method returns an empty string.

This field replaces CustomWebAddress and includes the custom URL's path prefix.

$Site.BaseInsecureUrl This merge field is deprecated. Returns a base URL for the current site that uses HTTP instead of HTTPS. The current request's domain is used. The returned value includes the path prefix and never ends with a / character. If the current request isn’t a site request, then this method returns an empty string
$Site.BaseRequestUrl Returns the base URL of the current site for the requested URL. The referring page's URL doesn’t influence $Site.BaseRequestUrl. The returned URL uses the same protocol (HTTP or HTTPS) as the current request. The returned value includes the path prefix and never ends with a / character. If the current request isn’t a site request, then this method returns an empty string.
$Site.BaseSecureUrl Returns a base URL for the current site that uses HTTPS instead of HTTP. The current request's domain is preferred if it supports HTTPS. Domains that aren’t force.com subdomains are preferred over force.com subdomains. A force.com subdomain, if associated with the site, is used if no other HTTPS domains exist in the current site. If there are no HTTPS custom URLs in the site, then this method returns an empty string. The returned value includes the path prefix and never ends with a / character. If the current request isn’t a site request, then this method returns an empty string.
$Site.BaseUrl

Returns the base URL of the current site that references and links use. This field can return the referring page's URL instead of the current request's URL. This field's value includes the path prefix and never ends with a / character. If the current request isn’t a site request, then this field returns an empty string.

This field replaces $Site.CurrentSiteUrl.
$Site.MasterLabel Returns the value of the Master Label field for the current site. If the current request isn’t a site request, then this field returns an empty string.
$Site.SiteId Returns the ID of the current site. If the current request isn’t a site request, then this field returns an empty string.
$Site.SiteType Returns the API value of the Site Type field for the current site. If the current request isn’t a site request, then this field returns an empty string.
$Site.SiteTypeLabel Returns the value of the Site Type field's label for the current site. If the current request isn’t a site request, then this field returns an empty string.
![Note](https://sf-zdocs-cdn-prod.zoominsoftware.com/tdta-platform-extend_click-264-0-0-production-enus/5f7d9219-b7b1-4552-8891-f1aba9b289fc/images/icon_note.png) Note To use these expressions, the Salesforce Sites feature must be enabled for your organization. You must also use them within the context of your public site; otherwise, an empty string is returned for all expressions except {!$Site.Template}, which returns the default template for the site.