HubL functions
Functions in HubL are similar to filters in that they accept parameters and generate a value. However, not all functions need to be applied to an initial template value, and instead they interact with other areas of your HubSpot environment.
If you maintain an older website, you may also want to check out the list of deprecated HubL functions.
Below, learn more about each HubL function and its syntax.
The blog_all_posts_url
function returns a full URL to the listing page for all blog posts for the specified blog.
The example below shows how this function can be used as an anchor's href
.
Parameter | Type | Description |
---|---|---|
selected_blog
| Blog id or "default" | Specifies which blog to use. The blog id is returned by the module blog field. |
The blog_author_url
function returns a full URL to the specified blog author's listing page.
The example below shows how this function can be used as an anchor's href
. This can be combined with blog_authors
as shown in that function's examples.
Parameter | Type | Description |
---|---|---|
selected_blog
| Blog ID or "default" | Specifies which blog the author's listing page exists in. You can specify a blog by ID or use |
author_slug
| String or HubL Var | Specifies which author to link to. Can use either |
The blog_authors
function returns a sequence of blog author objects for the specified blog, sorted by slug ascending. This sequence can be stored in a variable and iterated through to create custom author post filters.
The number of live posts by each author can be accessed with author.live_posts.
Please note: this function has a limit of 250 authors. This function also has a limit of 10 calls per page.
The first line of the example below shows how the function returns a sequence of author objects. The rest of the example shows a use case of saving a sequence into a variable and then iterating though the author objects, printing a set of author listing links. The example assumes that the blog has 4 authors.
Parameter | Type | Description |
---|---|---|
selected_blog
| Blog ID or "default" | Specifies which blog to use, either a specific blog by its ID or the default blog by |
limit
| Integer | Sets the limit on the number of authors fetched. |
The blog_by_id
function returns a blog by ID. The below example code shows this function in use to generate a hyperlinked list item.
Please note: this function has a limit of 10 calls per page.
Parameter | Type | Description |
---|---|---|
selected_blog
| Blog ID or "default" | Specifies which blog to use, either a specific blog by its ID or the default blog by |
The blog_page_link
function generates the URL of a paginated view of your blog listing. The function takes a numeric parameter, which allows you to generate links for current, next, previous, or a specific page. This function is generally used in the href
attribute of pagination anchor tags and must be used on your blog listing template.
The examples below show this function in use as an anchor href
. The first example outputs the current page. The second example takes the number 7 parameter to specify the seventh page. The third example uses the next_page_num
variable to generate a link that is relative to the current page number (you can also use the last_page_num
variable for the previous page). The final example uses the current_page_num
variable and a +
operator to create a link that is 4 greater than the current page.
Parameter | Type | Description |
---|---|---|
page
| Number or HubL variable | Page number used to generate URL or HubL variable for page number. |
This function renders a set number of popular posts into a sequence. The sequence can then be saved into a variable and iterated through with a for loop, creating a custom post listing of your most popular posts.
Results from this function are cached for six hours. To retrieve blog posts using HubL in a way that avoids caching, you may want to use blog_recent_tag_posts instead.
In the example code below, the first line shows how the function returns a sequence. The sequence is saved as a variable which is then used in a for loop. Any blog post variables should use the name of the individual loop item rather than content.
. In the example, pop_post.name
is used. This technique can be used on blog templates and website pages.
Please note: this function has a limit of 200 posts. This function also has a limit of 10 calls per page.
Parameter | Type | Description |
---|---|---|
selected_blog
| Blog ID or "default" | Specifies which blog to use, either a specific blog by its ID or the default blog by |
limit
| Integer | Specifies the number of posts to add to the sequence up to a limit of 200. If not specified, defaults to 10. |
tag_slug
| Array | Optional list of tags to filter posts by. |
time_frame
| String | Optional timeframe of analytics to filter posts by. Default is
This parameter is required when including the |
logical_operator
| String | When When including this parameter, |
The blog_post_archive_url
function returns a full URL to the archive listing page for the given date values on the specified blog. This function has two required parameters and two optional parameters. The first parameter is a blog ID or simply the keyword "default"
. The second is the year of archived posts you'd like to display.
The optional parameters include the month and day of archived posts you'd like to display, respectively.
The example below shows how this function can be used as an anchor's href
.
Parameter | Type | Description |
---|---|---|
selected_blog
| Blog ID or "default" | Specifies which blog to use, either a specific blog by its ID or the default blog by |
year
| Integer | The year. |
month
| Integer | The optional month. |
day
| Integer | The optional day. |
The blog_recent_author_posts
function returns a sequence of blog post objects for the specified author, sorted by most recent. This sequence of posts can be saved into a variable and iterated through with a for loop, creating a custom post listing of posts by a particular author.
The function takes three parameters. The first parameter specifies which blog to collect posts by an author from. The value should be "default"
or the blog ID of a particular blog (available in the URL of the Blog dashboard). The second parameter specifies which author to use. This parameter can use the content.blog_post_author.slug
to use the author of the current post or accepts a lowercase hyphenated name such as "brian-halligan"
. The third parameter specifies how many posts are retrieved.
The first line of the example below demonstrates how the function returns a sequence of posts by an author. In this example, rather than specifying an exact author name, the current post author is used. The sequence is saved in a variable and looped through. Any blog post variables should use the name of the individual loop item rather than content.
. In the example, author_post.name
is used. This technique can be used on blog and page templates.
Please note: this function has a limit of 200 posts and 10 calls per page.
Parameter | Type | Description |
---|---|---|
selected_blog
| Blog ID or "default" | Specifies which blog to use. The blog ID is returned by the module blog field. |
author_slug
| String | Specifies which author to filter on. |
limit
| Integer | Specifies the number of posts to add to the sequence up to a limit of 200. |
The blog_recent_posts
function returns a sequence of blog post objects for the specified blog, sorted by most recent first. This sequence of posts can be saved into a variable and iterated through with a for loop, creating a custom post listing of your most popular posts.
The function takes two parameters. The first parameter specifies which blog to collect popular posts from. The value should be "default"
or the blog ID of a particular blog (available in the URL of the Blog dashboard). The second parameter specifies how many posts are retrieved.
The first line of the example below demonstrates how the function returns a sequence. The sequence is saved in a variable and looped through. Any blog post variables should use the name of the individual loop item rather than content.
. In the example, rec_post.name
is used. This technique can be used, not only on blog templates, but also regular pages.
Please note: this function has a limit of 200 posts and 10 calls per page.
Parameter | Type | Description |
---|---|---|
selected_blog
| Blog ID or "default" | Specifies which blog to use, either a specific blog by its ID or the default blog by |
limit
| Integer | Specifies the number of posts to add to the sequence, maximum 200. |
The blog_recent_tag_posts
function returns a sequence of blog post objects for a specified tag or tags, sorted by most recent first. This sequence of posts can be saved into a variable and iterated through with a for loop, creating a custom post listing of posts by a particular tag or tags.
In the example code below:
- The first line shows how the function returns a sequence of posts by
tag. - The second line shows how to save the function in a sequence variable. The rest of the code then uses a for loop to cycle through the variable values. Any blog post variables should use the name of the individual loop item rather than
content.
. In the example,tag_post.name
is used. You can use this technique on both blog and website pages.
Learn more about creating a related blog post listing.
Please note: this function has a limit of 100 posts and 10 calls per page.
Parameter | Type | Description |
---|---|---|
selected_blog
| Blog ID or "default" | Specifies which blog to use, either a specific blog by its ID or the default blog by |
tag_slug
| String | Specifies which tag to filter on. You can include up to 10 tags, comma separated. Tags with multiple words must be lowercase with spaces replaced by hyphens. |
limit
| Integer | Specifies the number of posts to add to the sequence. This parameter is required when including a |
logical_operator
| String | When When including this parameter, |
The blog_tag_url
function returns a full URL to the specified blog tag's listing page.
This function accepts two parameters. The first parameter specifies which blog the tag's listing page exists in. The second parameter specifies which tag to link. This parameter can use the topic.slug
for a particular tag from content.topic_list
or accepts a lowercase hyphenated name such as "marketing-tips"
.
The example below shows how this function can be used as an anchor's
Parameter | Type | Description |
---|---|---|
selected_blog
| Blog ID or "default" | Specifies which blog to use, either a specific blog by its ID or the default blog by |
tag_slug
| String | Specifies which tag to link to. |
The blog_tags
function returns a sequence of the 250 most blogged-about tags (based on number of associated blog posts) for the specified blog, sorted by blog post count.
This sequence can be stored in a variable and iterated through to create custom tag post filters. The number of posts for each tag can be accessed with tag.live_posts
.
This function accepts two parameters. The first parameter specifies which blog to fetch tags from. The second parameter sets a limit on the number of tags fetched.
The first line of the example below demonstrates how the function returns a sequence of tag objects. The rest of the example demonstrates a use case of saving a sequence into a variable and then iterating though the tag objects, printing a set of tag links. The example assumes that the blog has 4 tags.
Please note: this function has a limit of 250 tags.
Parameter | Type | Description |
---|---|---|
selected_blog
| Blog ID or "default" | Specifies which blog to use. The blog ID is returned by the module blog field. |
limit
| Integer | The maximum amount of tags to return. |
This function returns the total number of published posts in the specified blog. If no parameter is specified, it will count your default blog posts. Alternatively, you can specify "default"
or a blog ID of a different blog to count. The blog ID is available in the URL of your blog dashboard for a particular blog.
Please note: this function has a limit of 10 calls per page.
Parameter | Type | Description |
---|---|---|
selected_blog
| Blog ID or "default" | Specifies which blog to count. The blog ID is returned by the module blog field. |
This function lightens or darkens a hex value or color variable by a set amount. The first parameter is the hex color (for example ("#FFDDFF") or a variable storing a hex value. The second parameter is the amount to adjust it by, from 0 to 255. This function can be used in CSS files to create a color variation. Another good use case is to use it with a color parameter of a color module, to allow users to specify a primary color that automatically generates a color variation.
In the example below, the hex color #3A539B is stored in a variable called base_color
. The color is modified by -80 resulting in a darker blue (#00034B).
Parameter | Type | Description |
---|---|---|
base_color
| HEX color string | The starting color to be altered (Example: |
brightness_offset
| Integer | A positive or negative number used to lighten or darken the base color. |
Parameter | Type | Description |
---|---|---|
id
| ID | The ID of the content to look up. |
Given a list of content IDs, returns a dict of landing page, website page or blog posts matching those IDs.
This function takes one parameter, a list of page or blog post IDs to look up, placed within an array. Up to 100 content objects can be passed. The below example code shows this function in use to generate a list of hyperlinked list items.
Please note: this function has a limit of 10 calls per page.
Parameter | Type | Description |
---|---|---|
ids
| List | A list of page or blog post IDs to look up. Up to 100 content objects can be passed. |
Return a shallow copy of the list. Equivalent to a[:]
.
A shallow copy constructs a new compound object and then (to the extent possible) inserts references into it to the objects found in the original.
Returns the number of times a variable exists in a list.
Gets a list of CRM records associated with another record by its record ID, association category, and association definition ID.
This function returns an object with the following attributes: has_more
, total
, offset
and results
.
has_more
indicates there are more results available beyond this batch (total > offset).total
is the total number of results available.offset
is the offset to use for the next batch of results.results
returns an array of the specified associated objects matching the function's parameters
Please note: for security purposes, of the HubSpot standard object types only the product
, and marketing_event
objects can be retrieved on a publicly accessible page. Any other standard object type must be hosted on a page which is either password protected or requires a CMS Membership login. Custom objects do not have this same restriction.
Please note: this function can be called a maximum of 10 times per page. Each crm_associations
call can return at most 100 objects. The default limit is 10 objects.
Parameter | Type | Description |
---|---|---|
id
Required
| ID | ID of the record to find associations from. |
association category
Required
| String | The category of the association definition. Possible values are |
association type id
Required
| Integer | The ID of the association definition to use. For standard HubSpot supported objects see ID of the association type to use. |
query
| String | The Queries can include the following parameters:
|
properties
| String | Optional. A comma-separated list of properties to return. By default, a small set of common properties are returned. The ID property is always returned. A full list of properties can be found using the get all contact properties and get all company properties endpoints. |
formatting
| Boolean | Optional. Format values such as dates and currency according to this portal's settings. Omit or pass |
Gets a single CRM record by query or by its ID. Records are returned as a dict of properties and values.
This function can also be used with custom and integrator objects.
Please note: for security purposes, of the HubSpot standard object types only the product
, and marketing_event
objects can be retrieved on a publicly accessible page. Any other standard object type must be hosted on a page which is either password protected or requires a CMS Membership login. Custom objects do not have this same restriction.
What is the difference between in
and contains
?
in
returns if the property value matches with any of the given values. Whereas contains
returns if the property values for multi-select has all of the given values.
Please note: this function can only be called a maximum of 10 times on a single page.
Parameter | Type | Description |
---|---|---|
object_type
| String | The object type name. Object type names are case sensitive. For integrator and account specific object types with the same name as the built-in objects use the objects fully qualified name (FQN). |
query
| String | Optional. The
Queries can include the following parameters:
|
properties
| String | Optional. A comma-separated list of properties to return. By default, a small set of common properties are returned. The ID property is always returned. A full list of properties can be found using the get all contact properties and get all company properties endpoints. |
formatting
| Boolean | Optional. Format values such as dates and currency according to this portal's settings. Pass |
range
, distinct
, ndistinct
, and startswith
are reserved keywords. To query a property that uses one of those names, you'll need to use the following format: range__eq=
(rather than range=
).
Gets a list of records for a specific object type from the HubSpot CRM.
This function returns an object with the following attributes: has_more
, total
, offset
and results
.
has_more
indicates there are more results available beyond this batch (total > offset).total
is the total number of results available.offset
is the offset to use for the next batch of results.results
returns an array of the specified objects matching the function's parameters.
crm_objects("contact", "firstname=Bob&order=lastname&order=createdate")
will order contacts with the first name "Bob"
by last name and then by createdate
. To reverse a sort, prepend -
to the property name like order=-createdate
. The CRM objects function can also be used with custom and integrator objects.Please note: for security purposes, of the HubSpot standard object types only the product
, and marketing_event
objects can be retrieved on a publicly accessible page. Any other standard object type must be hosted on a page which is either password protected or requires a CMS Membership login. Custom objects do not have this same restriction.
Please note: this function can be called a maximum of 10 times per page. Each crm_objects
call can return at most 100 objects. The default limit is 10 objects.
Parameter | Type | Description |
---|---|---|
object_type
| String | The type of object by name. Object type names are case sensitive. Singular and plural are accepted for standard object types (e.g., For integrator and account specific object types with the same name as the built-in objects, use the objects fully qualified name (FQN). |
query
| String | Optional. The ID of the record or a query string, delimited by Supported operators are Example: Note: |
properties
| String | Optional. A comma-separated list of properties to return. By default, a small set of common properties are returned. The ID property is always returned. A full list of properties can be found using the get all contact properties and get all company properties endpoints. The record ID is always included in the returned object properties even when not explicitly added in the property list. |
formatting
| Boolean | Optional. Format values such as dates and currency according to this portal's settings. Pass |
range
, distinct
, ndistinct
, and startswith
are reserved keywords. To query a property that uses one of those names, you'll need to use the following format: range__eq=
(rather than range=
).
Get the property definition for a given object type and property name.
Supported object types are HubSpot standard objects (e.g., contacts), portal specific objects, and integrator objects.
Please note: for security purposes, of the HubSpot standard object types only the product
, and marketing_event
objects can be retrieved on a publicly accessible page. Any other standard object type must be hosted on a page which is either password protected or requires a CMS Membership login. Custom objects do not have this same restriction.
Parameter | Type | Description |
---|---|---|
object_type
| String | The object type name. Object type names are case sensitive. The supported object types. For integrator and account specific object types with the same name as the built-in objects use the objects fully qualified name (FQN). |
property_name
| String | The case-insensitive property name to retrieve the definition for. |
Get the property definitions for a given object type and set of property names.
Supported object types are HubSpot standard objects (e.g. contacts), portal specific objects, and integrator objects.
Please note: for security purposes, of the HubSpot standard object types only the product
, and marketing_event
objects can be retrieved on a publicly accessible page. Any other standard object type must be hosted on a page which is either password protected or requires a CMS Membership login. Custom objects do not have this same restriction.
Parameter | Type | Description |
---|---|---|
object_type
| String | The object type name. Object type names are case sensitive. The supported object types. For integrator and account specific object types with the same name as the built-in objects use the objects fully qualified name (FQN). |
property_name
| String | Optional. The case-insensitive property names comma separated, to retrieve the definition for. If empty, the definitions for all the properties will be retrieved. |
Because CTA modules have so many parameters that contain variations of their code, you can use the CTA function to easily generate a particular CTA in a template, page, or email. This function is what the rich text editor uses when you add a CTA via the editor.
Parameter | Type | Description |
---|---|---|
guid
| String | The ID of the CTA to render. Can be found in the URL of the details screen of the CTA. |
align_opt
| Enumeration | Adjusts alignment of CTA. Values include |
Extend a list by appending all items from an iterable. In other words, insert all list items from one list into another list.
This function returns the metadata of a file by ID. It accepts a single parameter, the numeric ID of the file to look up.
Please note: this function is limited to 10 calls per page.
Parameter | Type | Description |
---|---|---|
file_id
| ID | The ID of the file to look up. |
Returns the social media account links set in account settings. Used in the default follow_me module.
Formats an address based on the context's locale.
Parameter | Type | Description | Default |
---|---|---|---|
locale
Required
| String | The locale to format the address in. | |
address
Required
| String | The street address. | |
address2
Optional
| String | The second line of the address, such as floor or apartment number. | |
city
Required
| String | The city of the address. | |
state
Required
| String | The state of the address. | |
country
Required
| String | The country of the address. | |
zip
Required
| String | The zip code of the address. |
Formats a company's name by adding Japanese honorifics where appropriate.
Parameter | Type | Description | Default |
---|---|---|---|
companyName
Required
| String | The name of the company. | |
useHonorificIfApplicable
Required
| Boolean | When set to |
Parameter | Type | Description | Default |
---|---|---|---|
firstName
Required
| String | The person's first name. | |
surname
Required
| String | The person's surname or last name. |
False
|
useHonorificIfApplicable
Required
| Boolean | When set to |
Formats both the date and time components of a date object, similar to the format_datetime HubL filter. This function replaces the deprecated datetimeformat
function.
Parameter | Type | Description | Default |
---|---|---|---|
format
Required
| String | The format to use. Can be one of:
| |
timeZone
Optional
| String | The time zone of the output date in IANA TZDB format. | |
locale
Optional
| String | The locale to use for locale-aware formats. |
This function contains 4 parameters and calculates the ellipsoidal 2D distance between two points on Earth. Use this function as a filter query for getting HubDB data.
Parameter | Type | Description |
---|---|---|
point1
| Location | location from a HubDB column. |
point2_lat
| Latitude | Latitude of point2. |
point2_long
| Longitude | Longitude of point2. |
units
| String | Units for the return value. Options are |
This function returns the public URL of a specified template or code file. The parameter of this function is the asset's path in the design manager. Coded file URLs update each time you publish them; therefore, by using this function your ensure you are always using the latest version of the file.
You can automatically generate this function in the app, by either right-clicking a file and selecting Copy public URL, or by clicking Actions, then selecting Copy public URL.
The example below gets the URL of a Javascript file authored in Design Manager that can be included as the src
of a <script>
tag.

Parameter | Type | Description |
---|---|---|
path
| String | The design manager file path to the template or file. |
This function works just like get_public_template_url
, returning public URL of a specified template or code file. The only difference is the parameter of this function is the template ID (available in the URL of the template or coded file), instead of the design manager path.
Parameter | Type | Description |
---|---|---|
template_id
| ID | The ID number of the template of file. |
HubDB is a feature available in CMS Hub Professional and Enterprise.
The hubdb_table
function can be used to get information on a table including its name, columns, last updated, etc.
The following pieces of information can be pulled by calling the appropriate attributes:
- ID: the ID of the table.
- name: the name of the table.
- columns: a list of column information.
- created_at: the timestamp of when this table was first created.
- published_at: the timestamp of when this table was published.
- updated_at: timestamp of when this table was last updated.
- row_count: the number of rows in the table.
Please note: this function has a limit of 10 calls per page.
Parameter | Type | Description |
---|---|---|
table_id
| String | ID or name of the table. |
HubDB is a feature available in CMS Hub Professional and Enterprise.
The hubdb_table_column
function can be used to get information on a column in table such as its label, type and options. This function accepts two parameters.
These pieces of information about the column can be pulled by calling the appropriate attributes:
- ID: the ID of the column.
- name: the name of the column.
- label: the label to be used for the column.
- type: the type of the column.
- options: for columns of type
select
, a map ofoptionId
to option information. - foreignIds: for columns of type
"foreignId"
, a list offoreignIds
(withid
andname
properties).
In addition to the above attributes, there is also a method which can be called: getOptionByName("<option name>")
whereby for columns of type "select"
, this will get option information by the option's name.
Column names are not case sensitive. For example, HS_ID
and hs_id
are both valid.
Parameter | Type | Description |
---|---|---|
table_id
| String | ID or name of the table. |
column
| String | ID or name of the column. |
HubDB is a feature available in CMS Hub Professional and Enterprise.
The hubdb_table_row
function can be used to pull a single row from a HubDB table. From this row, you can pull information from each table cell by calling on the corresponding attribute:
- hs_id: the globally unique id for this row.
- hs_created_at: a timestamp representing when this row was created.
- hs_path: when used with dynamic pages, this string is the last segment of the url's path for the page.
- hs_name: when used with dynamic pages, this is the title of the page.
- <column name> or ["<column name>"]: get the value of the column for this row by the
name
of the column.
Column names are not case sensitive. For example, HS_ID
and hs_id
are both valid.
Please note: this function has a limit of 10 calls per page.
Parameter | Type | Description |
---|---|---|
table_id
| String | ID or name of the table. |
row_id
| Integer | ID of the row of the table. |
HubDB is a feature available in CMS Hub Professional and Enterprise.
The hubdb_table_rows
function can be used to list rows of a HubDB table, to be iterated through. A single call of hubdb_table_rows()
is limited to 10 table scans per page.
By default, this function will return a maximum of 1,000 rows. To retrieve more rows, specify a limit
in the query, as shown in the code below.
Please note: if you use a random filter on this function, the page will be prerendered periodically. This means that the filtered content will not be updated on every page reload.
Parameter | Type | Description |
---|---|---|
table_id
| String | ID or name of the table to query. |
query
| String | A query in the same format as a URL query string. If not passed, returns all rows. Learn more about the available filters for querying HubDB table rows. You can reverse the sort by adding a In addition to ordering by a column, you can also include the following functions:
These functions also support reverse ordering. For example, |
range
, distinct
, ndistinct
, and startswith
are reserved keywords. To query a property that uses one of those names, you'll need to use the following format: range__eq=
(rather than range=
).
This function generates a link tag that references the Primary CSS file (default_custom_style.min.css
). This file is designed to be a global CSS file that can be added to all templates. To render, the function requires a boolean parameter value of True
.
Returns the location of the first matching item in a 0-based array
.
This function accepts 3 parameters, The first parameter is required. The first parameter is the item you are trying to find in the array
. The second (start
) and third (end
) enable you to find that item in a slice of the array
.
Returns a human-readable string representation of a language code, optionally translated to a target language.
Parameter | Type | Description |
---|---|---|
language_code
| String | The language code. |
target_language_code
| String | The language that the output will be translated to. |
Returns the nested link structure of an advanced menu. Menu nodes have a variety of properties that can be used on objects that are returned. If you pass null
to the menu function it will return an empty pylist. You can also specify a menu by name. In most cases it's safer to use the menu id, as a menu being renamed won't affect the id. If building for the marketplace it makes sense to default to "default"
if menu is null
.
Please note: this function has a limit of 10 calls per page.
When using the menu()
function to generate a menu, you are fully responsible for making sure your menu is accessible.
Parameter | Type | Description |
---|---|---|
menu_id
| Id | Required. The id of the menu passed as a number. |
root_type
| Enumeration | Root type of the menu (
|
root_key
| String | Root key (id or name) when using |
Gets the URL for an asset attached to a custom module via Linked Files > Other Files.
Parameter | Type | Description |
---|---|---|
name
| String | The name of the asset. |
Parameter | Type | Description |
---|---|---|
request
| String | Request object, |
Parameter | Type | Description |
---|---|---|
expression
| String | An expression for the object and property to render. |
default
| String | Optional. A default value to use if the expression has no value. |
postal_location
function returns the latitude/longitude location pair for a given postal code and country code (limited to US, CA, and GB).Please note: this function has a limit of 10 calls per page.
Parameter | Type | Description |
---|---|---|
postal_code
| String | Postal code of the location. |
country_code
| String | Country code for the postal code. If not provided, the country will try to be inferred from the postal code. |
Returns a list containing an arithmetic progression of integers. With one parameter, range will return a list from 0 up to (but not including) the value
. With two parameters, the range will start at the first value and increment by 1 up to (but not including) the second value
. The third parameter specifies the step increment. All values can be negative. Impossible ranges will return an empty list. Ranges can generate a maximum of 1000 values.
Range can be used within a for loop to specify the number of iterations that should run.
This function enqueues a CSS file to be rendered in the head element. All CSS link tags are grouped together and render before any JavaScript tags. The HubL is replaced with an empty line and then a link tag is added to {{ standard_header_includes }}
. This method requires an absolute URL; CMS content with a known relative URL can be required by using the get_asset_url()
function.
To enqueue an inline style to be rendered in the head
via a style tag element, use the {% require_css %} and {% end_require_css %}
tag instead with your style tags and CSS inside of that.
The second parameter is a dictionary of options to modify generated tag. Supports async
(true/false) a technique described on web.dev and any other key-value pair will be added as HTML attributes to the style tag.
Specifies whether a script should be enqueued to render in the head or footer (default). Specify the render location by including the head
or footer
parameter. The HubL will be replaced by an empty line, and included in either the header or footer includes.
To enqueue an inline script to be rendered in the footer via a script element, wrap your <script>
tags with {% require_js %}
and {% end_require_js %}
.
You can also include additional render options in this function. These will be added as HTML attributes in the script tag. Render options include:
- position:
head
/footer
- defer:
true
/false
- async:
true
/false
- type:
string
Rewrites the URL of image stored in File Manager to a URL that will resize the image on request. The function accepts one required parameter, and five optional parameters. At least one optional parameter must be passed.
Required
- URL: string, URL of a HubSpot-hosted image.
Optional
- width: number, the new image width in pixels.
- height: number, the new image height in pixels.
- length: number, the new length of the largest side, in pixels.
- upscale: boolean, use the resized image dimensions even if they would scale up the original image (images may appear blurry).
- upsize: boolean, return the resized image even if it is larger than the original in bytes.
Please note: images that are larger than 4096 pixels in height or width will not be automatically resized. Instead, you'll need to manually resize the image.
Parameter | Type | Description |
---|---|---|
url
| String | URL of a HubSpot-hosted image. |
width
| Integer (px) | The new image width, in pixels. |
height
| Integer (px) | The new image height, in pixels. |
length
| Integer (px) | The new length of the largest side, in pixels. |
upscale
| Boolean | Use the resized image dimensions even if they would scale up the original image (images may appear blurry). Default value is |
upsize
| Boolean | Return the resized image even if it is larger than the original in bytes. |
Reverses the order of items in a list. Doesn't take any parameters. To reverse an object or return an iterator to iterate over the list in reverse, use |reverse
Set the response code as the specified code. 404 is the only supported code for now. When using this, your page will return a 404
error.
Parameter | Type | Description |
---|---|---|
code
| Integer | The HTTP response code. Currently, |
This function prints content from the parent template into a child template using the extends tag.
For example, in the code below, a basic HTML template has been created with a HubL block named sidebar
and saved as parent.html
. A second template file is created that will extend that parent file. Normally, the <h3>
would be printed in the parent HTML's sidebar block. But by using super
, content from the parent template sidebar block is combined with the content from the child template.
Returns the start of today (12:00am). Optionally you can add a parameter to change the timezone from the default UTC.
Converts a UNIX timestamp to the local time, based on your HubSpot Report Settings. You can then apply a datetimeformat filter to format the date.
Parameter | Type | Description |
---|---|---|
date
| Datetime | UNIX timestamp to convert to local time. |
Returns a HubL dict representing the topic cluster associated with a piece of content (determined by the passed content id), including metadata about the associated pillar page, core topic, and subtopics. Can be used to "auto-link" a piece of content with its associated pillar page [if it exists].
Available metadata can be found in: attachableContent (the current content's metadata), topic (the current content's associated topic metadata), coreTopic (the associated cluster's core topic metadata), and pillarPage (the associated pillar page's metadata).
Use {{ topicCluster|pprint }}
to see a full a display of available properties/attributes.
Please note: this function has a limit of 10 calls per page.
Parameter | Type | Description |
---|---|---|
content_id
| Id | The id of the page to look up. |
The truncate function works just like the truncate filter, but uses function syntax instead of filter syntax. The first parameter specifies the string. The second parameter specifies the length at which to truncate. The final parameter specifies the characters to add when the truncation occurs.
Parameter | Type | Description |
---|---|---|
string_to_truncate
| String | String that will be truncated. |
length
| integer | Specifies the length at which to truncate the text (includes HTML characters). |
killwords
| boolean | If true, the string will cut text at length, regardless of if it's in the middle of a word. |
end
| String | The characters that will be added to indicate where the text was truncated. |
Updates the dict with the elements from another dict object or from an iterable of key/value pairs.
Thank you for your feedback, it means a lot to us.