UrlHelper

Type: Class
Namespace: craft\helpers
Inherits: craft\helpers\UrlHelper
Since: 3.0.0

Class Url

# Public Methods

Method	Description
actionUrl()
baseCpUrl()	Returns the control panel’s base URL (with a trailing slash) (sans control panel trigger).
baseSiteUrl()	Returns the current site’s base URL (with a trailing slash).
baseUrl()	Returns either the current site’s base URL or the control panel’s base URL, depending on the type of request this is.
buildQuery()	Returns a query string based on the given params.
cpHost()	Returns the control panel's host.
cpUrl()	Returns a control panel URL.
encodeParams()	Encodes a URL’s query string params.
getSchemeForTokenizedUrl()	Returns what the scheme part of the URL should be (http/https) for any tokenized URLs in Craft (email verification links, password reset urls, share entry URLs, etc.
host()	Returns the host info for the control panel or the current site, depending on the request type.
hostInfo()	Parses a URL for the host info.
isAbsoluteUrl()	Returns whether a given string appears to be an absolute URL.
isFullUrl()	Returns whether a given string appears to be a "full" URL (absolute, root-relative or protocol-relative).
isProtocolRelativeUrl()	Returns whether a given string appears to be a protocol-relative URL.
isRootRelativeUrl()	Returns whether a given string appears to be a root-relative URL.
prependCpTrigger()	Prepends the control panel trigger onto the given path.
removeParam()	Removes a query string param from a URL.
rootRelativeUrl()	Returns a root-relative URL based on the given URL.
siteHost()	Returns the current site’s host.
siteUrl()	Returns a site URL.
stripQueryString()	Removes the query string from a given URL.
url()	Returns either a control panel or a site URL, depending on the request type.
urlWithParams()	Returns a URL with additional query string parameters.
urlWithScheme()	Returns a URL with a specific scheme.
urlWithToken()	Returns a URL with a 'token' query string param set to a given token.

# `actionUrl()`

View source (opens new window)

Arguments

$path (string (opens new window))
$params (array (opens new window), string (opens new window), null (opens new window))
$scheme (string (opens new window), null (opens new window)) – The scheme to use ('http' or 'https'). If empty, the scheme used for the current request will be used.
$showScriptName (boolean (opens new window)) – Whether the script name (index.php) should be included in the URL. Note that it’s only safe to set this to false for URLs that will be used for GET requests.

Returns

string (opens new window)

# `baseCpUrl()`

Returns the control panel’s base URL (with a trailing slash) (sans control panel trigger).

View source (opens new window)

Returns

string (opens new window)

# `baseSiteUrl()`

Returns the current site’s base URL (with a trailing slash).

View source (opens new window)

Returns

string (opens new window)

Throws

craft\errors\SiteNotFoundException
if there's no current site for some reason

# `baseUrl()`

Returns either the current site’s base URL or the control panel’s base URL, depending on the type of request this is.

View source (opens new window)

Returns

string (opens new window)

Throws

craft\errors\SiteNotFoundException
if this is a site request and yet there's no current site for some reason

# `buildQuery()`

Since: 3.3.0

Returns a query string based on the given params.

View source (opens new window)

Arguments

$params (array (opens new window))

Returns

string (opens new window)

# `cpHost()`

Returns the control panel's host.

View source (opens new window)

Returns

string (opens new window)

# `cpUrl()`

Returns a control panel URL.

View source (opens new window)

Arguments

$path (string (opens new window))
$params (array (opens new window), string (opens new window), null (opens new window))
$scheme (string (opens new window), null (opens new window))

Returns

string (opens new window)

# `encodeParams()`

Since: 3.7.24

Encodes a URL’s query string params.

View source (opens new window)

Arguments

$url (string (opens new window))

Returns

string (opens new window)

# `getSchemeForTokenizedUrl()`

Returns what the scheme part of the URL should be (http/https) for any tokenized URLs in Craft (email verification links, password reset urls, share entry URLs, etc.

View source (opens new window)