Os filtros afetam a saída final do HubL. Eles podem ser aplicados a várias instruções e expressões do HubL para alterar a marcação do modelo emitido pelo servidor.
A sintaxe básica de um filtro é |filtername. O filtro é adicionado diretamente após a instrução ou a expressão, dentro dos seus delimitadores. Alguns filtros têm parâmetros adicionais que podem ser adicionados entre parênteses. A sintaxe básica de um filtro com uma string, um número e um parâmetro booleano é: |filtername("stringParameter", 10, true). Observe que os parâmetros das strings devem ser escritos entre aspas. Observe também que os filtros do HubL têm alias que podem ser usados da mesma forma que o filtro principal.
O artigo a seguir contém todos os filtros do HubL suportados.
Observação:
Você pode aplicar os filtros do HubL a tokens de personalização, como tokens de contato e da empresa, nas páginas do CMS e do blog do HubSpot, mas não nos e-mails.abs
Calcula o valor absoluto de um número. Você pode usar essa Filtrar para garantir que um número seja positivo.
add
Adiciona um valor numérico a outro valor numérico. Este filtro funciona da mesma forma que o operador +. O parâmetro entre parênteses é o adendo que você está combinando com o seu valor numérico inicial.
attr
Renderiza o atributo de um dicionário. Este filtro é o equivalente a imprimir uma variável que existe dentro de um dicionário, tal como content.absolute_url.
lote
Agrupa itens dentro de uma sequência.
No exemplo abaixo, há uma variável contendo uma sequência de tipos de frutas. O filtro batch é aplicado a um loop que itera pela sequência. O loop agrupado é executado três vezes para imprimir três tipos de fruta por linha, antes de o loop externo ser executado novamente. Observe na saída final que existem apenas cinco tipos de fruta: o item final é substituído por (o segundo parâmetro).
between_times
Calcula o tempo entre dois objetos de data e hora na unidade de tempo especificada.
Observação:
Você deve usar este filtro somente com variáveis que retornam uma data. A partir de 30 de setembro de 2024, este filtro não retornará mais a data atual quando um valor nulo for passado. Após essa data, um valor nulo no filtro retornará 30 de setembro de 2024.bool
Converte um valor de string de texto em booleano.
capitalizar
Coloca em maiúscula a primeira letra de um valor de variável. O primeiro caractere será maiúsculo, todas as outras letras serão minúsculas. As palavras subsequentes separadas por espaços ou hifens não terão a primeira letra em maiúscula.
centralizar
Centraliza o texto dentro de um determinado comprimento de campo usando espaços em branco. Este filtro não é recomendado nem particularmente útil, pois o compilador HTML do HubSpot removerá automaticamente os espaços em branco; no entanto, ele foi incluído aqui por uma questão de abrangência.
O exemplo abaixo mostra esse filtro sendo aplicado a uma variável em uma tag pre, para que o espaço em branco não seja removido.
convert_rgb
Converte um valor HEX para uma string RGB. É útil se você precisar converter variáveis de cor para RGB para usá-las com uma declaração CSS RGBA. No exemplo abaixo, o valor definido por um módulo de cor é convertido para um valor RGB e usado em uma declaração CSS RGBA.
cut
Remove uma string de um valor. Este filtro pode ser usado para combinar e cortar uma parte específica de uma string. O parâmetro especifica a parte da string que deve ser removida. O exemplo abaixo remove o espaço e a palavra “world” do valor da variável original.
default
Se o valor não estiver definido, retornará o primeiro parâmetro; caso contrário, o valor da variável será impresso. Se você quiser usar o padrão com variáveis que avaliam como falso, precisará definir o segundo parâmetro como trueverdadeiro.
O primeiro exemplo abaixo imprimiria a mensagem se a variável não estivesse definida. O segundo exemplo aplica o filtro a uma string vazia, que não é indefinida, mas imprime uma mensagem devido ao segundo parâmetro.
dictsort
Classifica um dicionário e produz pares (chave, valor). Os dicionários não são classificados por padrão, mas você pode imprimir um dicionário classificado por chave ou valor. O primeiro parâmetro é um booleano para determinar se a classificação diferencia ou não maiúsculas de minúsculas. O segundo parâmetro determina se o dicionário deve ser classificado por chave ou por valor. O exemplo abaixo imprime um dicionário de contatos classificado, com todos os detalhes conhecidos sobre o contato.
difference
Retorna a diferença de dois conjuntos ou listas. A lista retornada pelo filtro contém todos os elementos únicos que estão na primeira lista, mas não na segunda.
divide
Divide o valor atual por um divisor. O parâmetro passado é o divisor. Este filtro é uma alternativa ao operador /.
divisible
Uma alternativa para o teste de expressão divisibleby, este filtro será avaliado como verdadeiro se o valor for divisível pelo número fornecido.
escape_html
Limpa o conteúdo de uma entrada HTML. Aceita uma string e converte os caracteres &, <, >, ‘, ” e escape_jinjava em sequências seguras para HTML. Use esse filtro para variáveis HubL usadas em HTML, mas que não devem permitir nenhum HTML.
escape_attr
Limpa o conteúdo de uma entrada de atributo de HTML. Aceita uma string e converte os caracteres &, <, ‘, ” e escape_jinjava em sequências seguras para HTML. Use esse filtro para variáveis HubL que estão sendo adicionadas aos atributos HTML.
Observe que, ao limpar valores de atributos que aceitam URLs, como href, você deve usar o filtro escape_url.
escape_jinjava
Converte os caracteres { e } em strings para sequências seguras para Jinjava. Use este filtro se você precisar exibir texto que possa conter tais caracteres em Jinjava.
escape_js
Limpa as strings, incluindo escape_jinjava, para que possam ser inseridas em segurança em uma declaração de variável JavaScript. Use esse filtro para variáveis HubL usadas dentro de elementos de script HTML.
escape_url
Escapa o conteúdo de uma entrada de URL, aplicando protocolos especificados, removendo caracteres inválidos e perigosos e codificando entidades HTML. Retorna em branco se um URL for válido. Use esse filtro para variáveis HubL usadas em atributos HTML que devem ser URLs válidos.
escapejson
Limpa as strings para que possam ser usadas como valores JSON.
Formata um valor numérico em um tamanho de arquivo legível por humanos (por exemplo, 13 kB, 4,1 MB, 102 bytes, etc.). Por padrão, prefixos decimais são usados (por exemplo, MB e GB), mas você pode definir o binary parâmetro para true usar prefixos binários como Mebi (MiB) e Gibi (GiB).
first
Retorna o primeiro item de uma sequência.
float
Converte um valor em um número de ponto flutuante. Se a conversão não funcionar, ela retornará 0.0. Você pode substituir esse padrão usando o primeiro parâmetro.
forceescape
Aplica rigorosamente o escape de HTML. No ambiente HubSpot, não há um caso de uso para escape duplo; isso geralmente se comporta da mesma forma que o filtro de escape.
Aplica formatação de string Python a um objeto. %s pode ser substituído por outra variável.
Formata um determinado número como uma moeda com base na moeda padrão do portal e no local passado como parâmetro. Substitui o filtro format_currency descontinuado.
Formata o componente de data de um objeto de data.
Observação:
Você deve usar este filtro somente com variáveis que retornam uma data. A partir de 30 de setembro de 2024, este filtro não retornará mais a data atual quando um valor nulo for passado. Após essa data, um valor nulo no filtro retornará 30 de setembro de 2024.Observação:
Você deve usar este filtro somente com variáveis que retornam uma data. A partir de 30 de setembro de 2024, este filtro não retornará mais a data atual quando um valor nulo for passado. Após essa data, um valor nulo no filtro retornará 30 de setembro de 2024.Observação:
Você deve usar este filtro somente com variáveis que retornam uma data. A partir de 30 de setembro de 2024, este filtro não retornará mais a data atual quando um valor nulo for passado. Após essa data, um valor nulo no filtro retornará 30 de setembro de 2024.fromjson
Converte uma string JSON em um objeto.
geo_distance
Calcula a distância elipsoidal 2D entre dois pontos na Terra.
groupby
Agrupa uma sequência de objetos por um atributo comum. O parâmetro define o atributo comum a ser agrupado.
indent
Recua o texto dentro de um determinado comprimento de campo usando espaços em branco. Este filtro não é recomendado nem particularmente útil porque o compilador HTML do HubSpot removerá automaticamente os espaços em branco. No entanto, ele está incluído aqui por uma questão de abrangência. O exemplo abaixo mostra um filtro indent sendo aplicado a uma variável em uma tag <pre>, para que o espaço em branco não seja removido. O primeiro parâmetro controla a quantidade de espaços em branco e o segundo booleano alterna se a primeira linha deve ser recuada.
int
Converte o valor em um inteiro. Se a conversão não funcionar, ela retornará 0. Você pode substituir esse padrão usando o primeiro parâmetro.
intersect
Retorna a interseção de dois conjuntos ou listas. A lista retornada pelo filtro contém todos os elementos únicos que estão contidos em ambas as listas.
ipaddr
Avalia para true se o valor for um endereço IPv4 ou IPv6 válido.
join
Retorna uma string que é a concatenação das strings na sequência. O separador entre os elementos é uma string vazia por padrão. Você pode defini-la com o parâmetro opcional. O segundo parâmetro pode ser usado para especificar um atributo para unir.
last
Retorna o último item de uma sequência.
length
Retorna o número de itens de uma sequência ou mapeamento.
list
Converte valores em uma lista. As strings serão retornadas como caracteres separados, a menos que estejam contidas em delimitadores de sequência de colchetes [ ].
log
Calcula o logaritmo natural de um número.
lower
Converte todas as letras de um valor em minúsculas.
map
Aplica um filtro em uma sequência de objetos ou procura um atributo. Isso é útil ao lidar com uma lista de objetos em que você está interessado apenas em um determinado valor.
Geralmente, é usado para mapear um atributo. Por exemplo, se você quiser usar a lógica condicional para verificar se um valor está presente em um determinado atributo de um dicionário. Como alternativa, você pode deixá-lo invocar um filtro, passando o nome do filtro e os argumentos depois.
md5
Calcula o hash md5 do objeto fornecido.
minus_time
Subtrai uma quantidade de tempo de um objeto datetime.
multiply
Multiplica um valor por um número. Funciona da mesma forma que o operador *.
plus_time
Adiciona uma quantidade de tempo a um objeto de data/hora.
pprint
Imprime uma variável. Imprime o tipo de variável e outras informações úteis para a depuração.
random
Retorna um item aleatório da sequência.
Observação:
Ao usar este filtro, a página será pré-renderizada periodicamente, em vez de sempre que o conteúdo da página for atualizado. Isso significa que o conteúdo filtrado não será atualizado em cada recarga de página.Isso pode não ser um problema para certos tipos de conteúdo, como exibir uma lista aleatória de posts de blog. No entanto, se você precisar que o conteúdo seja alterado aleatoriamente em cada carregamento de página, use o JavaScript para randomizar o conteúdo do lado do cliente.regex_replace
Procura um padrão regex e o substitui por uma sequência de caracteres. O primeiro argumento é um padrão regex no estilo RE2; o segundo é a string de substituição.
Saiba mais sobre Sintaxe regex RE2.
reject
Filtra uma sequência de objetos aplicando um teste de expressão ao objeto e rejeitando aqueles que passaram com sucesso no teste.
rejectattr
Filtra uma sequência de objetos aplicando um teste a um atributo de um objeto e rejeitando aqueles que passaram com sucesso no teste.
render
Renderiza rapidamente as strings que contêm HubL para que a saída possa ser passada para outros filtros.
replace
Substitui todas as instâncias de uma substring por uma nova.
reverse
Inverte o objeto ou retorna um iterador que itera sobre ele no sentido inverso. Para reverter uma lista, use .reverse()
root
Calcula a raiz quadrada de um valor.
round
Arredonda um número para uma precisão fornecida.
safe
Marque um valor como seguro, o que significa que, em um ambiente com escape automático habilitado, esta variável não sofrerá escape.
sanitize_html
Limpa o conteúdo de uma entrada HTML para a saída de conteúdo de rich text. Aceita uma string e, em seguida, remove as tags HTML que não são permitidas. Use esse filtro para variáveis HubL usadas em HTML que devem permitir HTML seguro.
Você pode incluir os seguintes parâmetros para permitir tipos específicos de tags HTML: FORMATTING, BLOCKS, STYLES, LINKS, TABLES, IMAGES. Por exemplo, sanitize_html(IMAGES).
Usar sanitize_html incluirá todos os parâmetros no filtro.
Você também pode incluir um parâmetro STRIP para remover todo o HTML. Todo o conteúdo também é executado por escape_jinjava para evitar interpretações aninhadas.
select
Filtra uma sequência de objetos, aplicando um teste aos objetos e selecionando apenas aqueles que passaram com sucesso no teste.
selectattr
Filtra uma sequência de objetos aplicando um teste a um atributo dos objetos e selecionando apenas aqueles cujo teste foi bem-sucedido.
shuffle
Randomiza a ordem de iteração por uma sequência. O exemplo abaixo randomiza um loop padrão do blog.
Observação:
Ao usar este filtro, a página será pré-renderizada periodicamente, em vez de sempre que o conteúdo da página for atualizado. Isso significa que o conteúdo filtrado não será atualizado em cada recarga de página.Isso pode não ser um problema para certos tipos de conteúdo, como exibir uma lista aleatória de posts de blog. No entanto, se você precisar que o conteúdo seja alterado aleatoriamente em cada carregamento de página, use o JavaScript para randomizar o conteúdo do lado do cliente.slice
Divide um iterador e retorna uma lista de listas que contêm esses itens. O primeiro parâmetro especifica quantos itens serão divididos, e o segundo parâmetro especifica os caracteres para preencher as divisões vazias.
sort
Classifica um iterável. Este filtro requer todos os parâmetros para classificar por um atributo no HubSpot. O primeiro parâmetro é um booleano para inverter a ordem de classificação. O segundo parâmetro determina se a classificação diferencia ou não maiúsculas de minúsculas. E o parâmetro final especifica por qual atributo classificar. No exemplo abaixo, os posts de um blog foram renderizados e classificados em ordem alfabética por nome.
split
Divide a string de entrada em uma lista em um determinado separador. O primeiro parâmetro especifica o separador pelo qual a variável deve ser dividida. O segundo parâmetro determina quantas vezes a variável deve ser dividida. Qualquer item restante permanece agrupado. No exemplo abaixo, uma string de nomes é dividida no ; para os quatro primeiros nomes.
string
Converte um tipo de variável diferente em uma string. No exemplo abaixo, um número inteiro é convertido em uma string (pprint é usado para confirmar a mudança no tipo de variável).
Remove tags SGML/XML e substitui espaços em branco adjacentes por um espaço. Este filtro pode ser usado para remover quaisquer tags HTML de uma variável.
strtodate
Converte uma sequência de data e um formato de data em um objeto de data.
strtotime
Converte uma string e um formato de data/hora em um objeto de data/hora.
sum
Soma valores numéricos em uma sequência. O primeiro parâmetro pode especificar um atributo opcional e o segundo parâmetro define o valor a retornar se não houver nada na variável a somar.
symmetric_difference
Retorna a diferença simétrica de dois conjuntos ou listas. A lista retornada pelo filtro contém todos os elementos únicos que estão na primeira lista, mas não na segunda, ou que estão na segunda lista, mas não na primeira
title
Retorna uma versão do valor em caixa alta (ou seja, as palavras começarão com letras maiúsculas, mas todos os caracteres restantes serão minúsculos).
tojson
Escreve um objeto como uma string JSON.
trim
Remove espaços em branco antes e depois. O HubSpot já remove os espaços em branco da marcação, mas este filtro está documentado por uma questão de abrangência.
truncate
Corta o texto após um certo número de caracteres. O padrão é 255. Os caracteres HTML estão incluídos nesta contagem.
Observação: como esse filtro depende dos espaços entre as palavras para encurtar as strings, ele pode não funcionar como esperado para idiomas sem espaços entre caracteres, como japonês.
truncatehtml
Trunca uma determinada string, respeitando a marcação html (ou seja, fecha adequadamente todas as tags aninhadas). Isso evita que uma tag permaneça aberta após o truncamento. Os caracteres HTML não são contabilizados no total de caracteres.
Observação: como esse filtro depende dos espaços entre as palavras para encurtar as strings, ele pode não funcionar como esperado para idiomas sem espaços entre caracteres, como japonês.
unescape_html
Converte texto com entidades codificadas em HTML para seus equivalentes em Unicode.
union
Retorna a união de dois conjuntos ou listas. A lista retornada do filtro contém todos os elementos exclusivos que estão em qualquer uma das listas.
unique
Extrai um conjunto exclusivo de uma sequência ou dicionário de objetos. Ao filtrar um dicionário, como uma lista de postagens retornadas por uma função, você pode especificar qual atributo é usado para desduplicar itens no dicionário.
unixtimestamp
Converte um objeto datetime em um registro de data e hora Unix.
Observação:
Você deve usar este filtro somente com variáveis que retornam uma data. A partir de 30 de setembro de 2024, este filtro não retornará mais a data atual quando um valor nulo for passado. Após essa data, um valor nulo no filtro retornará September 30, 2024.upper
Converte todas as letras de um valor em maiúsculas.
urlencode
Escapes e URL codificam uma string usando a formatação UTF-8. Aceita dicionários e strings regulares, bem como iteráveis em pares.
urldecode
Decodifica as strings de URL codificadas para a URL original. Aceita dicionários e strings regulares, bem como iteráveis em pares.
urlize
Converte URLs de texto simples em links clicáveis. Se você passar um número inteiro adicional para o filtro, ele encurtará as urls para esse número. O segundo parâmetro é um booleano que determina se o link é rel=“no follow”. O parâmetro final permite especificar se o link será aberto em uma nova aba.
wordcount
Conta o número de palavras em uma string.
Se a string contiver HTML, use o striptags filtre para obter uma contagem precisa.
wordwrap
Insere uma quebra nas palavras após um determinado número de caracteres. Funciona melhor em um <pre> porque o HubSpot remove os espaços em branco por padrão.
xmlattr
Cria uma string de atributo HTML/XML, com base nos itens em um dicionário. Todos os valores que não são none nem undefined são escapados automaticamente. Se o filtro retornar algo, adiciona automaticamente um espaço na frente do item, a menos que o primeiro parâmetro seja falso.
