HubL filters

Filters affect the ultimate output of your HubL. They can be applied to various HubL statements and expressions to alter the template markup outputted by the server.

The basic syntax of a filter is |filtername. The filter is added directly following the statement or the expression, within its delimiters. Some filters have additional parameters that can be added in parentheses. The basic syntax of a filter with a string, a number, and a boolean parameters is: |filtername("stringParameter", 10, true). Notice that string parameters should be written in quotes. Also note that HubL filters have an alias that can be used to serve the same purpose as the primary filter.

The following article contains all of the supported HubL filters.

Gets the absolute value of a number. You can use this filter to ensure that a number is positive.

In the example below, there is variable containing a sequence of types of fruits. The batch filter is applied to a loop that iterates through the sequence. The nested loop runs three times to print 3 types of fruit per row, before the outer loop runs again. Notice in the final output that since there are only 5 types of fruit, the final item is replaced by a &nbsp (the second parameter).

The example below shows a center filter being applied to a variable in a pre tag, so the whitespace isn't stripped out.

Calculates the ellipsoidal 2D distance between two points on Earth.

The groupby filter groups a sequence of objects by a common attribute. The parameter sets the common attribute to group by.

The indent filter uses whitespace to indent text within a given field length. This filter is not recommended or particularly useful since HubSpot's HTML compiler will automatically strip out the white space; however, it is included here for the sake of comprehensiveness. The example below shows a center filter being applied to a variable in a pre tag, so the whitespace isn't stripped out. The first parameter controls the amount of whitespace and the second boolean toggles whether to indent the first line.

Convert the value into an integer. If the conversion doesn’t work it will return 0. You can override this default using the first parameter.

This filter returns the intersection of two sets or lists. The list returned from the filter contains all unique elements that are contained in both lists.

Evaluates to true if the value is a valid IPv4 or IPv6 address.

Return a string which is the concatenation of the strings in the sequence. The separator between elements is an empty string per default, you can define it with the optional parameter. The second parameter can be used to specify an attribute to join.

Returns the last item of a sequence.

Return the number of items of a sequence or mapping.

Convert the number values into a list. If it was a string the returned list will be a list of characters. To add strings to a sequence, simply add them to the string variables to the sequence delimiters [ ].

Calculates the natural logarithm of a number.

Convert a value to all lowercase letters.

Applies a filter on a sequence of objects or looks up an attribute. This is useful when dealing with lists of objects but you are really only interested in a certain value of it.

The basic usage is mapping on an attribute. For example, if you want to use conditional logic to check if a value is present in a particular attribute of a dict. Alternatively, you can let it invoke a filter by passing the name of the filter and the arguments afterwards.

Calculates the md5 hash of the given object

Subtracts an amount of time to a datetime object.

Multiplies a value with a number. Functions the same as the * operator.

Adds an amount of time to a datetime object.

Pretty print a variable. This prints the type of variable and other info that is useful for debugging.

Return a random item from the sequence.

Searches for a regex pattern and replaces with a sequence of characters. The first argument is a RE2-style regex pattern, the second is the replacement string.

Information on the RE2 regex syntax can be found here.

Filters a sequence of objects by applying an expression test to the object and rejecting the ones with the test succeeding.

Filters a sequence of objects by applying a test to an attribute of an object and rejecting the ones with the test succeeding. 

Render strings containing HubL early so that the output can be passed into other filters.

Replace all instances of a substring with a new one. 

Reverse the object or return an iterator the iterates over it the other way round. To reverse a list use .reverse()

Calculates the square root of a value.

Round the number to a given precision.

Mark the value as safe which means that in an environment with automatic escaping enabled this variable will not be escaped.

Filters a sequence of objects by applying a test to the object and only selecting the ones with the test succeeding.

Filters a sequence of objects by applying a test to an attribute of an object and only selecting the ones with the test succeeding.

Randomizes the order of iteration through a sequence. The example below shuffles a standard blog loop.

Slice an iterator and return a list of lists containing those items. The first parameter specifies how many items will be sliced, and the second parameter specifies characters to fill in empty slices.

Sorts an iterable. This filter requires all parameters to sort by an attribute in HubSpot. The first parameter is a boolean to reverse the sort order. The second parameter determines whether or not the sorting is case sensitive. And the final parameter specifies an attribute to sort by. In the example below, posts from a blog are rendered and alphabetized by name.

Splits the input string into a list on the given separator. The first parameter specifies the separator to split the variable by. The second parameter determines how many times the variable should be split. Any remaining items would remained group. In the example below, a string of names is split at the ";" for the first 4 names.

Converts a different variable type to a string. In the example below, a integer is converted into a string (pprint is used to confirm the change in variable type).

Strip SGML/XML tags and replace adjacent whitespace by one space. This filter can be used to remove any HTML tags from a variable.

Converts a datetime string and a datetime format into a datetime object.

Adds numeric values in a sequence. The first parameter can specify an optional attribute and the second parameter sets a value to return if there is nothing in the variable to sum.

This filter returns the symmetric difference of two sets or lists. The list returned from the filter contains all unique elements that are in the first list but not the second, or are in the second list but not the first

Return a titlecased version of the value. I.e. words will start with uppercase letters, all remaining characters are lowercase.

Writes an object as a JSON string.

Strips leading and trailing whitespace. HubSpot already trims whitespace from markup, but this filter is documented for the sake of comprehensiveness.

Cuts off text after a certain number of characters. The default is 255. Please note that HTML characters are included in this count. The length is specified with the first parameter which defaults to 255. If the second parameter is true the filter will cut the text at length. Otherwise it will discard the last word. If the text was in fact truncated it will append an ellipsis sign ("..."). If you want a different ellipsis sign than "..." you can specify it using the third parameter.

Truncates a given string, respecting html markup (i.e. will properly close all nested tags). This will prevent a tag from remaining open after truncation. HTML characters do not count towards the character total. This filter has a length parameter and a truncation symbol parameter. There is a third boolean parameter that specifies whether words will be broken at length. This parameter is false by default in order to preserve the length of words. If using only one of the optional parameters, use keyword arguments, such as truncatehtml(70, breakwords = false).

This filter returns the union of two sets or lists. The list returned from the filter contains all unique elements that are in either list.

This filter extracts a unique set from a sequence or dict of objects. When filtering a dict, such as a list of posts returned by a function, you can specify which attribute is used to deduplicate items in the dict.

This filter converts a datetime object into a unix timestamp.

Convert a value to all uppercase letters.

Escapes and URL encodes a string using UTF-8 formatting. Accepts both dictionaries and regular strings as well as pairwise iterables.

Decodes encoded URL strings back to the original URL. Accepts both dictionaries and regular strings as well as pairwise iterables.

Converts URLs in plain text into clickable links. If you pass the filter an additional integer it will shorten the urls to that number. The second parameter is a boolean that dictates whether the link is rel="no follow". The final parameter lets you specify whether the link will open in a new tab.

Count the number of words in a string.

Causes words to wrap at a given character count. This works best in a <pre> because HubSpot strips whitespace by default.

Create an HTML/XML attribute string, based on the items in a dict. All values that are neither none
nor undefined are automatically escaped. It automatically prepends a space in front of the item if the filter returned something unless the first parameter is false.