url

Properties

Anchor to

object

The resource that the URL points to.

The object can be one of the following:

• article
• blog
• collection
• metaobject
• page
• policy
• product
• A string that contains the URL, if the type is external_link

For any other type, or if the resource no longer exists, nil is returned. A path that's entered as text, such as /products/walrus-socks, is a relative_link, so its object is nil even if the path matches a resource.

Anchor to

type

string from a set of values

The type of the URL.

The type depends on how the URL was set:

• A resource that's selected in the theme editor returns the type of that resource, such as product_link or catalog_link.
• A path that's entered as text, such as /products/walrus-socks, returns relative_link, even if the path matches a resource. The only exception is /, which returns home_link.
• A path from a dynamic source, such as {{ page.url }}, also returns relative_link.
• An absolute URL returns external_link, even if it points to the store.

Possible values	Description
anchor	The URL points to an anchor on the current page, such as #faq.
article_link	The URL points to an article.
blog_link	The URL points to a blog.
catalog_link	The URL points to the catalog page (/collections/all).
collection_link	The URL points to a collection.
collections_link	The URL points to the collection list page (/collections).
external_link	The URL is an absolute URL that starts with http, https, mailto, or tel.
home_link	The URL is the home page path (/).
metaobject_link	The URL points to a metaobject page.
page_link	The URL points to a page.
policy_link	The URL points to a policy page.
product_link	The URL points to a product page.
relative_link	The URL is a path that was entered as text or comes from a dynamic source, such as /pages/about.

Anchor to

url

string

The URL.

The URL string to be used as the href in links. This is the same value that's returned when the url object is referenced directly.

URLs that point to store resources, the home page, and the collection pages include the path prefix of the current locale, such as /fr/collections/spring. Relative paths and anchors are returned exactly as they were entered.