HubL Functions

Last updated:

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. Instead they interact with other areas of your HubSpot environment.

append

Adds a single item to the end of a list.

{% set numbers_under_5 = [1,2,3] %}
{% do numbers_under_5.append(4) %}
{{numbers_under_5}}
Parameter Type Description
item
Any

Item to be appended to the list.

blog_all_posts_url

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.

<a href="{{ blog_all_posts_url('default') }}">All Marketing blog posts</a>
Parameter Type Description
selected_blog
Blog id or 'default'

Specifies which blog to use.

blog_author_url

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.

<a href="{{ blog_author_url('default', 'brian-halligan') }}">Brian Halligan</a>
Parameter Type Description
selected_blog
Blog id or 'default'

Specifies which blog the author's listing page exists in.

author_slug
String or HubL Var

Specifies which author to link to. Can use either content.blog_post_author.slug or a lowercase hyphenated name. Example: 'jane-doe'.

blog_authors

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.

This function has a limit of 250 authors.

{{ blog_authors('default', 250) }}

{% set my_authors = blog_authors('default', 250) %}
<ul>
{% for author in my_authors %}
<li><a href="{{ blog_author_url(group.id, author.slug) }}">{{ author }}</a></li>
{% endfor %}
</ul>
Parameter Type Description
selected_blog
Blog id or 'default'

Specifies which blog to use.

limit
Integer

Sets the limit on the number of authors fetched.

The first line of the example below demonstrates how the function returns a sequence of author objects. The rest of the example demonstrates 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.

blog_by_id

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.

This function has a limit of 10 calls per page.

{% set my_blog = blog_by_id(47104297) %}
<ul>
    <li>
        <a href="{{ my_blog.absolute_url }}">{{my_blog.html_title}}</a>
	</li>
</ul>
Parameter Type Description
selected_blog
Integer

Numeric ID of a blog.

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.

<a href="{{ blog_page_link(current_page_num) }}">Current page</a>
<a href="{{ blog_page_link(7) }}">Page 7</a>
<a href="{{ blog_page_link(next_page_num) }}">Next</a>
<a href="{{ blog_page_link(current_page_num + 4) }}">Page Plus 4</a>
Use this table to describe parameters / fields
Parameter Type Description
page
Number or HubL Var

Page Number used to generate URL or HubL variable for page number.

The blog_popular_posts function renders a set number of popular posts into a sequence. 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 up to 4 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 (optional) parameter specifies how many posts to retrieve - if not specified, defaults to 10.  The third (optional) parameter specifies a topic by which to filter the results - if specified, only popular posts associated with this topic will be returned. The fourth (optional) parameter specifies the timeframe of analytics used to determine posts' popularity. The default is `popular_past_year.`

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, pop_post.name is used. This technique can be used, not only on blog templates, but also regular pages.

This function has a limit of 200 posts.

{% set pop_posts = blog_popular_posts('default', 5, 'marketing-tips') %}
{% for pop_post in pop_posts %}
    <div class="post-title">{{ pop_post.name }}</div>
{% endfor %}
Use this table to describe parameters / fields
Parameter Type Description
selected_blog
Blog id or 'default'

Specifies which blog to use.

limit
Integer

Specifies the number of posts to add to the sequence up to a limit of 200.

tag_slug
String

Optional tag to filter posts by.

time_frame
String

Optional timeframe of analytics to filter posts by (must be one of 'popular_all_time', 'popular_past_year', 'popular_past_six_months', 'popular_past_month'). Default is 'popular_past_year'.

blog_post_archive_url

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.

<a href="{{ blog_post_archive_url('default', 2017, 7, 5) }}">Posts from July 5th, 2017</a>
Use this table to describe parameters / fields
Parameter Type Description
selected_blog
Blog id or 'default'

Specifies which blog to use.

year
Integer

The year.

month
Integer

The optional month.

day
Integer

The optional day.

blog_recent_author_posts

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, not only on blog templates, but also regular pages. 

This function has a limit of 200 posts.

{{ blog_recent_author_posts('default', content.blog_post_author.slug, 5 ) }}
{% set author_posts = blog_recent_author_posts('default', content.blog_post_author.slug, 5) %}
{% for author_post in author_posts %}
    <div class="post-title">{{ author_post.name }}</div>
{% endfor %}
Use this table to describe parameters / fields
Parameter Type Description
selected_blog
Blog id or 'default'

Specifies which blog to use.

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.

blog_recent_posts

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. 

This function has a limit of 200 posts.

{{ blog_recent_posts('default', 5) }}
{% set rec_posts = blog_recent_posts('default', 5) %}
{% for rec_post in rec_posts %}
    <div class="post-title">{{ rec_post.name }}</div>
{% endfor %}
Use this table to describe parameters / fields
Parameter Type Description
selected_blog
Blog id or 'default'

Specifies which blog to use.

limit
Integer

Specifies the number of posts to add to the sequence, maximum 200.

blog_recent_tag_posts

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.

The function takes three parameters. The first parameter specifies which blog to collect 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 which tags to use, either a single tag or an array of up to 10 tags separated by commas. This parameter can use tag.slug for a particular tag from content.tag_list or accepts a lowercase hyphenated name such as 'marketing-tips'.  Spaces in tag names must be converted to hyphens.

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 tag. The second line shows the function used to save a sequence in a variable which is then looped through. Any blog post variables should use the name of the individual loop item rather than content.. In the example, tag_post.name is used. This technique can be used, not only on blog templates, but also regular pages. 

You can use this function as the foundation for a related posts section of an individual blog post layout. To learn more about creating a related posts section, check out this tutorial.

This function has a limit of 100 most recent posts.

{{ blog_recent_tag_posts('default', 'marketing-tips', 5 ) }}
{% set tag_posts = blog_recent_tag_posts('default', ['marketing', 'fun', 'inbound'], 3) %}
{% for tag_post in tag_posts %}
    <div class="post-title">{{ tag_post.name }}</div>
{% endfor %}
Use this table to describe parameters / fields
Parameter Type Description
selected_blog
Blog id or 'default'

Specifies which blog to use.

tag_slug
String

Specifies which tag to filter on.

limit
Integer

Specifies the number of posts to add to the sequence.

blog_tag_url

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 hrefThis can be combined with blog_topics as shown in that function's examples.

<a href="{{ blog_tag_url('default', 'inbound-marketing') }}">Inbound Marketing</a>
Use this table to describe parameters / fields
Parameter Type Description
selected_blog
Blog id or 'default'

Specifies which blog to use.

tag_slug
String

Specifies which tag to link to.

blog_tags

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 author tag links. The example assumes that the blog has 4 tags. 

This function has a limit of 250 tags.

{{ blog_tags('default', 250) }}

{% set my_tags = blog_tags('default', 250) %}
<ul>
{% for item in my_tags %}
<li><a href="{{ blog_tag_url(group.id, item.slug) }}">{{ item }}</a></li>
{% endfor %}
</ul>
Use this table to describe parameters / fields
Parameter Type Description
selected_blog
Blog id or 'default'

Specifies which blog to use.

limit
Integer

Max tags to return.

blog_total_post_count

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.

{{ blog_total_post_count }} 
{{ blog_total_post_count(359485112) }}
Use this table to describe parameters / fields
Parameter Type Description
selected_blog
Blog id or 'default'

Specifies which blog to count.

clear

Removes all items from a list. Unlike pop(), it does not return anything.

{% set words = ["phone","home"] %}
{% do words.clear() %}
{{words}}

color_variant

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).

{% set base_color ="#3A539B" %} 
{{ color_variant(base_color, -80) }}
Use this table to describe parameters / fields
Parameter Type Description
base_color
HEX color string

The starting color to be altered (Example: #F7F7F7).

brightness_offset
Integer
A positive or negative number used to lighten or darken the base color.

content_by_id

The content_by_id function returns a landing page, website page or blog post by ID. The only parameter accepted by this function is a numeric content ID. 

The below example code shows this function in use to generate a hyperlinked list item.

This function has a limit of 10 calls per page. 
{% set my_content = content_by_id(4715624297) %}
<ul>
    <li>
        <a href="{{ my_content.absolute_url }}">{{my_content.title}}</a>
    </li>
</ul>
Use this table to describe parameters / fields
Parameter Type Description
id
Id

The id of the content to look up.

content_by_ids

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. 

This function has a limit of 10 calls per page. 

{% set contents = content_by_ids([4715624297, 4712623297, 5215624284]) %}
<ul>
{% for content in contents %}
    <li>
        <a href="{{ content.absolute_url }}">{{content.title}}</a>
    </li>
    {% endfor %}
</ul>
Use this table to describe parameters / fields
Parameter Type Description
ids
List

A list of page or blog post ids to look up. Up to 100 content objects can be passed.

copy

Return a shallow copy of the list. Equivalent to 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.

{% set a = ["ham"] %}
{% set b = a.copy() %}
a: {{a}}

b: {{b}}

  After Append
{% do a.append("swiss") %}
a: {{a}}

b: {{b}}

count

Returns the number of times a variable exists in a list.

{% set attendees = ["Jack","Jon","Jerry","Jessica"] %}
{% set jon_count = attendees.count("Jon") %}
There are {{jon_count}} Jon's in the list.
<p>After append:</p>
{% do attendees.append("Jon") %}
{% set jon_count_after_append = attendees.count("Jon") %}
There are now {{jon_count_after_append}} Jon's in the list.

crm_associations

Gets a list of CRM objects associated to an object 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 associated objects matching the function's parameters

For security purposes, only Product objects can be retrieved on a publicly accessible page. Any other object type must be hosted on a page which is either password protected or requires a CMS Membership login. Objects in the results array are returned as a dict of properties and values.

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.

{% set associated_contacts = crm_associations(847943847, 2, 'limit=3&years_at_company__gt=2&orderBy=email', 'firstname,email', false) %} 
{{ associated contacts }}
Use this table to describe parameters / fields
Parameter Type Description
id
Id

Id of object to find associations from.

association type id
Integer

Id of the association type to use.

query
String

Query string delimited by &. All expressions are ANDed together. Supported operators are eq (default), neq, lt, lte, gt, gte, is_null and not_null.

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.

formatting
Boolean

Optional. Format values such as dates and currency according to this portal's settings. Omit or pass false for raw strings.

crm_object

Gets a single object from the HubSpot CRM.

For security purposes, only Product objects can be retrieved on a publicly accessible page. Any other object type must be hosted on a page which is either password protected or requires a CMS Membership login. Objects are returned as a dict of properties and values.

The first parameter (required) is a string specifying the CRM object type to get (contact, product, company, deal, ticket or quote).

The second parameter (required) specifies which CRM object to get. This parameter can either be a number, or a string. If you wish to get a specific CRM object by ID, pass a number of the ID of the object. If you wish to get a CRM object by querying crm_objects, pass a query string, delimited by &. All expressions are ANDed together. Supported operators are eq (default), neqltltegtgteis_null and not_null

The third parameter is a comma-separated list of properties to return. By default, a small set of common properties are returned. 

The final parameter specifies if values such as dates and currency should be formatted according to the portal's settings. Pass false for raw values. 

This function can only be called a maximum of 10 times on a single page.

<!-- by query -->
{% set contact = crm_object("contact", "email=contact@company.com", "firstname,lastname", false) %}
<!-- by id -->
{% set contact = crm_object("contact", 123) %}
{{ contact.firstname }}
{{ contact.lastname }}
Use this table to describe parameters / fields
Parameter Type Description
object_type
String

Case-insensitive. contact, product, company, deal, ticket or quote.

query
String

The id of the object OR a query string, delimited by &. All expressions are ANDed together. Supported operators are eq (default), neq, lt, lte, gt, gte, is_null and not_null.

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.

formatting
Boolean

Optional. Format values such as dates and currency according to this portal's settings. Omit or pass false for raw strings.

crm_objects

Gets a list of objects 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.
Results can be sorted using at least one order parameter in the query. For example, 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.

For security purposes, only Product objects can be retrieved on a publicly accessible page. Any other object type must be hosted on a page which is either password protected or requires a CMS Membership login. Objects in the results array are returned as a dict of properties and values.

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.

{% set objects = crm_objects("contact", "firstname__not_null=&limit=3", "firstname,lastname") %} 
{{ objects }}
Use this table to describe parameters / fields
Parameter Type Description
object_type
String

Case-insensitive. contact, product, company, deal, ticket or quote

query
String

A query string, delimited by &. All expressions are ANDed together. Supported operators are eq (default), neq, lt, lte, gt, gte, is_null and not_null.

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.

formatting
Boolean

Optional. Format values such as dates and currency according to this portal's settings. Omit or pass false for raw strings.

cta

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.

{{ cta('ccd39b7c-ae18-4c4e-98ee-547069bfbc5b')  }} 
{{ cta('ccd39b7c-ae18-4c4e-98ee-547069bfbc5b', 'justifycenter') }}
Use this table to describe parameters / fields
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 justifyleft, justifycenter, justifyright, justifyfull.

datetimeformat

The datetimeformat function works just like the datetimeformat filter, but uses function syntax instead of filter syntax. It uses the same parameters to format the date. See the complete list of formatting parameters.

{{ datetimeformat(content.publish_date_local_time, '%B %e, %Y') }} 

extend

Extend a list by appending all items from an iterable. In other words, insert all list items from one list into another list.

{% set vehicles = ["boat","car","bicycle"] %}
{% set more_vehicles = ["airplane","motorcycle"] %}
{% do vehicles.extend(more_vehicles) %}
{{vehicles}}

file_by_id

This function returns the metadata of a file by ID. It accepts a single parameter, the numeric ID of the file to look up.

This function is limited to 10 calls per page.

{% set file = file_by_id(123) %} 
{{ file.friendlyUrl }}
Use this table to describe parameters / fields
Parameter Type Description
file_id
Id

The ID of the file to look up.

geo_distance

This function contains 4 parameters and calculates the ellipsoidal 2D distance between two points on Earth.

This function is for use with HubDB as a filter query.

{% for row in hubdb_table_rows(1234567, "geo_distance(loc,1.233,-5.678,mi)__gt=500") %}
    {{row.name}} <br> 
{% endfor %}
Use this table to describe parameters / fields
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 FT for feet, MI for miles, M for meters or KM for kilometers.

get_asset_url

This function returns the public URL of a specified template or code file. The parameter of this function is the path in 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 on a file name and choosing "Copy public URL" or by choosing Actions > 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>.

copy-public-url
{{ get_asset_url("/custom/styles/style.css") }} 
Use this table to describe parameters / fields
Parameter Type Description
path
String

The Design Manager file path to the template or file.

get_public_template_url_by_id

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.

{{ get_public_template_url_by_id('2778457004')  }} 
Use this table to describe parameters / fields
Parameter Type Description
template_id
Id

The ID number of the template of file.

hubdb_table

For a comprehensive overview of HubDB, read our HubDB page in the CMS Developer tools section. 

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 - timestamp of when this table was first created
  • published_at - 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
{% set table_info = hubdb_table(1548215) %} 
{{ table_info.row_count }}
Use this table to describe parameters / fields
Parameter Type Description
table_id
String

Id or name of the table.

hubdb_table_column

For a comprehensive overview of HubDB, read our HubDB page in the CMS Developer tools section.

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 colum
  • type - the type of the column 
  • options - for columns of type 'select', a map of optionId to option information
  • foreignIds - for columns of type 'foreignId', a list of foreignIds (with id and name 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 info by the option's name.

{% set column_info = hubdb_table_column(123456, 6)  %} 
{{ column_info.label }}
Use this table to describe parameters / fields
Parameter Type Description
table_id
String

Id or name of the table.

column
String

Id or name of the column.

hubdb_table_row

For a comprehensive overview of HubDB, read our HubDB page in the CMS Developer tools section. 

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: 

(Built-in and custom column names are case insensitive. HS_ID will work the same as hs_id)

  • 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
{% set row = hubdb_table_row(1548264, 6726439331)  %} 
{{ row.role  }}
Use this table to describe parameters / fields
Parameter Type Description
table_id
String

Id or name of the table.

row_id
Integer
Id of the row of the table.

hubdb_table_rows

For a comprehensive overview of HubDB, read our HubDB page in the CMS Developer tools section.

The hubdb_table_rows function can be used to list rows of a HubDB table, to be iterated through.

There is a limit of 10 table scans per CMS page defined as a single call to hubdb_table_rows().

{% for row in hubdb_table_rows(1546258, "years_at_company__gt=3&orderBy=count") %}
  the value for row {{ row.hs_id }} is {{ row.name }}
{% endfor %}
Use this table to describe parameters / fields
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. Additionally, there are several optional filters that can be used.

include_default_custom_css

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.

{{ include_default_custom_css(True) }} 

index

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

{% set shapes = ["triangle","square","trapezoid","triangle"] %}
triangle index: {{shapes.index("triangle")}} <br>
trapezoid index: {{shapes.index("trapezoid")}}
<hr>
adjusted start and end <br>
triangle index: {{shapes.index("triangle",1,5)}}

insert

Places an element into a list at the specific index provided.

This function accepts 2 parameters:

  • Index: the position where an element is to be inserted
  • Element: the item to be inserted
{% set even_numbers = [2,4,8,10]  %}
{% do even_numbers.insert(2,6) %}
{{even_numbers}}

locale_name

Returns a human-readable string representation of a language code, optionally translated to a target language.

{{ locale_name('es') }}
{{ locale_name('es', 'en') }}
Use this table to describe parameters / fields
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.

Important: If you use the menu() function to generate a menu, you are fully responsible for making sure your menu is accessible.

{% set node = menu(987) %}
{% for child in node.children %}
	{{ child.label }}<br>
{% endfor %}

{% set default_node = menu("default") %}
{% for child in default_node.children %}
	{{ child.label }}<br>
{% endfor %}
Use this table to describe parameters / fields
Parameter Type Description
menu_id
Id

Required. The id of the menu passed as a number.

root_type
Enumeration

Root type of the menu ("site_root", "top_parent", "parent", "page_name", "page_id", "breadcrumb").

  • "site_root" denotes static - Always show top-level pages in menu.
  • "top_parent" denotes dynamic by section - Show pages in menu that are related to section being viewed.
  • "parent" denotes dynamic by page - Show pages in menu that are related to page being viewed.
  • "breadcrumb" denotes breadcrumb style path menu (uses horizontal flow).
root_key
String

Root key (id or name) when using "page_name" or "page_id".

module_asset_url

Gets the URL for an asset attached to a custom module via Linked Files > Other Files.

{{ module_asset_url("smile.jpg") }} 
Use this table to describe parameters / fields
Parameter Type Description
name
String

The name of the asset.

oembed

Returns OEmbed data dictionary for given request.

This function only works in emails.

{{ oembed({ url: "https://www.youtube.com/watch?v=KqpFNtbEOh8"}) }}
Use this table to describe parameters / fields
Parameter Type Description
request
String

Request object, {url: string, max_width: long, max_height: long}.

personalization_token

Returns the value of a contact or contact related property, or a default.
Hi {{ personalization_token("contact.firstname", "there") }}!
Use this table to describe parameters / fields
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.

pop

Removes the item at the index from the list. Also returns the removed item if printed.
{% set even_numbers = [2,3,4,6,8,9,10]  %}
{% do even_numbers.pop(1) %}
{{even_numbers.pop(4)}}
{{even_numbers}}

postal_location

The postal_location function returns the latitude/longitude location pair for a given postal code and country code (limited to US, CA, and GB).
{{ postal_location("02139") }}
{% set location = postal_location("02139", "US") %}
{{ location.latitude }}
{{ location.longitude }}
Use this table to describe parameters / fields
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.

range

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.

{{ range(11) }}
{{ range(5, 11) }}
{{ range(0, 11, 2) }}
       
       
{% for number in range(11) %}
{{ number }}
{% endfor %}

require_css

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.

{{ standard_header_includes }}
<!-- more html -->
{{ require_css("http://example.com/path/to/file.css") }}
{{ require_css(get_asset_url("/relative/path/to/file.css")) }}

require_js

This function enqueues a script to be rendered in either the head tag (in standard_header_includes) or footer (in standard_footer_includes). The HubL is replaced by an empty line and included in either {{ standard_footer_includes }} (the default) or {{ standard_header_includes }} if the call contains the 'head' parameter.

To enqueue an inline script to be rendered in the standard_footer_includes  via a script element, use the {% require_js %} and {% end_require_js %} tag instead with you script tags and JS code inside.

{{ standard_header_includes }}
<!-- more html -->
{{ require_js("http://example.com/path/to/footer-file.js", "footer") }}
{{ require_js("http://example.com/path/to/head-file.js", "head") }}

{{ standard_footer_includes }}

resize_image_url

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

Images that are larger than 4096 pixels in height or width will not be automatically resized. Images with dimensions larger than this limit must first be manually resized via the steps outlined here

{{ resize_image_url("http://your.hubspot.site/hubfs/img.jpg", 0, 0, 300) }}
Use this table to describe parameters / fields
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).

upsize
Boolean

Return the resized image even if it is larger than the original in bytes.

reverse

Reverses the order of items in a list. Does not take any parameters. To reverse an object or return an iterator to iterate over the list in reverse, use |reverse

{% set numbers = [1,2,3,4] %}
{% do numbers.reverse() %}
{{numbers}}

set_response_code

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.

{{ set_response_code(404) }} 
Use this table to describe parameters / fields
Parameter Type Description
code
Integer

The HTTP response code. Currently, 404 is the only supported code.

super

Super prints content from the parent template into a child template, when you have created parent and children templates, 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. 

{% extends "custom/page/web_page_basic/parent.html" %}

{% block sidebar %}
    <h3>Table Of Contents</h3>
    {{ super() }}
{% endblock %}

today

Returns the start of today (12:00am). Optionally you can add a parameter to change the timezone from the default UTC.

{{ today() }}
{{ today("America/New_York") }}
{{ unixtimestamp(today("America/New_York").plusDays(1)) }}

to_local_time

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.

{{ to_local_time(eastern_dt) }} 
Use this table to describe parameters / fields
Parameter Type Description
date
Datetime

UNIX timestamp to convert to local time.

topic_cluster_by_content_id

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.

{{ topic_cluster_by_content_id(content.id) }}
{%- if content.id -%}
  {%- set topicCluster = topic_cluster_by_content_id(content.id) -%}
  {%- if topicCluster.pillarPage.url.value and topicCluster.pillarPage.publishState == 'PUBLISHED' -%}
    <div>Topic: <a href="{{ topicCluster.pillarPage.url.value }}">{{ topicCluster.coreTopic.phrase }}</a></div> 
  {%- endif -%}
{%- endif -%}
Use this table to describe parameters / fields
Parameter Type Description
content_id
Id

The id of the page to look up.

truncate

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.

{{ truncate('string to truncate at a certain length', 19, end='...') }} 

type

This function accepts one argument and returns the type of an object. The return value is one of "bool", "datetime", "dict", "float", "int", "list", "long", "null", "str" or "tuple".

{{ type("Blog") }}
{% set my_type = type("Blog") %}
<p>{{my_type}}</p>

unixtimestamp

This function returns a unix timestamp. By default it will return the timestamp of now or you can optionally supply a datetime object to be converted to a unix timestamp.

{{ unixtimestamp() }}
{{ unixtimestamp(d) }}

update

Updates the dict with the elements from another dict object or from an iterable of key/value pairs.

{% set dict_var = {'authorName': 'Douglas Judy', 'authorTitle': 'Mastermind' } %}
{% set test = dict_var.update({'authorFriend': 'Jake'}) %}
{% set test = dict_var.update({'authorLocation': 'unknown'}) %}
{{ dict_var }}