Funções do HubL

As funções no HubL são semelhantes aos filtros, pois aceitam parâmetros e geram um valor. No entanto, nem todas as funções precisam ser aplicadas a um valor de modelo inicial e, em vez disso, elas interagem com outras áreas do seu ambiente da HubSpot.

Caso mantenha um site mais antigo, você também pode querer verificar a lista de funções HubL descontinuadas.

Saiba mais sobre cada função HubL e sua sintaxe.

Adiciona um único item ao final de uma lista.

A função blog_all_posts_url retorna uma URL completa para a página de listagem de todos os posts do blog especificado. 

O exemplo abaixo mostra como esta função pode ser usada como um href âncora.

A função blog_author_url retorna uma URL completa para a página de listagem do autor do blog especificado.

O exemplo abaixo mostra como esta função pode ser usada como um href âncora. Isso pode ser combinado com blog_authors, como você pode ver nos exemplos que usam essa função.

A função blog_authors retorna uma sequência de objetos de autor de blog para o blog especificado, classificados de forma ascendente por slug. Essa sequência pode ser armazenada em uma variável e ser iterada para criar filtros personalizados para os posts do autor.

O número de posts publicados de cada autor pode ser acessado com author.live_posts.

A primeira linha do exemplo abaixo mostra como a função retorna uma sequência de objetos de autor. O resto do exemplo mostra um caso de uso ao gravar uma sequência em uma variável e depois iterar pelos objetos de autor, imprimindo um conjunto de links de listagem de autores. O exemplo assume que o blog tem quatro autores.

A função blog_by_id retorna um blog por ID. O código de exemplo abaixo mostra como essa função foi usada para gerar um item de lista com hiperlinks.

A função blog_page_link gera a URL de uma exibição paginada da listagem do seu blog. A função assume um parâmetro numérico, que lhe permite gerar links para a página atual, para a próxima página, para a página anterior ou para uma página específica. Esta função é geralmente usada no atributo href das tags de ancoragem de paginação e deve ser usada no modelo de listagem do seu blog.

Os exemplos abaixo mostram como esta função pode ser usada como uma âncora href. O primeiro exemplo renderiza a página atual. O segundo exemplo assume o parâmetro número sete para especificar a sétima página. O terceiro exemplo usa a variável next_page_num para gerar um link relativo ao número da página atual (você também pode usar a variável last_page_num para a página anterior). O último exemplo usa a variável current_page_num e o operador + para criar um link quatro vezes maior do que a página atual.

A função transforma um número definido de posts populares em uma sequência. Esta sequência pode ser salva em uma variável e iterada em loop, criando uma listagem personalizada de seus posts mais populares. 

Os resultados dessa função são armazenados em cache por seis horas. Para recuperar os posts de blog usando o HubL a fim de evitar o cache, use blog_recent_tag_posts.

No código de exemplo abaixo, a primeira linha mostra como a função retorna uma sequência. A sequência é salva como uma variável que é usada em um loop for. Qualquer variável de post de blog deve usar o nome do item de loop individual e não content. No exemplo, é usado pop_post.name. Esta técnica pode ser usada em modelos de blog e páginas do site.

A função blog_post_archive_url retorna a URL completa da página de listagem do arquivo para os valores de data no blog especificado. Esta função tem dois parâmetros obrigatórios e dois parâmetros opcionais. O primeiro parâmetro é a ID do blog, ou simplesmente a palavra-chave "default". O segundo é o ano dos posts arquivados que você gostaria de exibir.

Os parâmetros opcionais incluem o mês e o dia dos posts arquivados que você gostaria de exibir, respectivamente.

O exemplo abaixo mostra como esta função pode ser usada como um href âncora.

A função blog_recent_author_posts retorna uma sequência de objetos de post de blog para o autor especificado, classificados do mais recente para o menos recente. Esta sequência de posts pode ser gravada em uma variável e iterada em um loop, criando uma listagem personalizada de posts de um determinado autor. 

A função tem três parâmetros. O primeiro parâmetro especifica o blog do qual coletar os posts de um autor. O valor deve ser "default" ou o ID de um determinado blog (disponível na URL do painel do blog). O segundo parâmetro especifica o autor que deve ser utilizado. Este parâmetro pode usar a função content.blog_post_author.slug para usar o autor do post atual, ou aceita um nome em letras minúsculas separado por hifens, como "brian-halligan". O terceiro parâmetro especifica a quantidade de posts que devem ser recuperados. 

A primeira linha do exemplo abaixo demonstra como a função retorna uma sequência de posts de um autor. Neste exemplo, em vez de especificar exatamente o nome do autor, é usado o autor do post atual. A sequência é salva em uma variável e é exectada em loop. Qualquer variável de post de blog deve usar o nome do item individual no loop e não content. No exemplo, é utilizado author_post.name. Esta técnica pode ser usada em modelos de blog e página.

A função blog_recent_posts retorna uma sequência de objetos de post de blog para o blog especificado, classificados do mais recente para o menos recente. Esta sequência de posts pode ser gravada em uma variável e iterada em loop, criando uma listagem personalizada de seus posts mais populares. 

A função assume dois parâmetros. O primeiro parâmetro especifica de qual blog coletar posts populares. O valor deve ser "default" ou o ID de um determinado blog (disponível na URL do painel do blog). O segundo parâmetro especifica a quantidade de posts que devem ser recuperados. 

A primeira linha do exemplo abaixo demonstra como a função retorna uma sequência. A sequência é salva em uma variável e é exectada em loop. Qualquer variável de post de blog deve usar o nome do item de loop individual e não content. No exemplo, é usado rec_post.name. Esta técnica pode ser usada não só em modelos de blogs como também em páginas regulares.

A função blog_recent_tag_posts retorna uma sequência de objetos de post de blog para a tag ou as tags especificadas, classificados do mais recente para o menos recente. Esta sequência de posts pode ser gravada em uma variável e iterada em um loop, criando uma listagem personalizada de posts de uma determinada tag ou tags.

No exemplo de código abaixo:

• A primeira linha mostra como a função retorna uma sequência de posts por tag. 
• A segunda linha mostra como salvar a função em uma variável de sequência. O resto do código usa um loop for para percorrer os valores da variável. Qualquer variável de post de blog deve usar o nome do item de loop individual e não content. No exemplo, é usado tag_post.name. Você pode usar essa técnica nas páginas do blog e do site. 

Saiba mais sobre como criar uma lista de posts de blog relacionados.

A função blog_tag_url retorna uma URL completa para a página de listagem da tag do blog especificado.

Esta função aceita dois parâmetros. O primeiro parâmetro especifica o blog em que a página de listagem da tag existe. O segundo parâmetro especifica a tag a ser vinculada. Este parâmetro pode usar a função topic.slug para uma determinada tag de content.topic_list ou aceita um nome separado por hifens em letras minúsculas, como "marketing-tips".

O exemplo abaixo mostra como esta função pode ser usada como um hrefâncora.

A função blog_tags retorna uma sequência das 250 tags mais blogadas (com base no número de posts associados ao blog) para o blog especificado, classificadas por contagem de posts do blog.

Esta sequência pode ser armazenada em uma variável e iterada para criar filtros personalizados para tags de post. O número de posts para cada tag pode ser acessado com tag.live_posts. 

Esta função aceita dois parâmetros. O primeiro parâmetro especifica o blog no qual buscar as tags. O segundo parâmetro estabelece um limite para o número de tags buscadas.

A primeira linha do exemplo abaixo demonstra como a função retorna uma sequência de objetos de tag. O resto do exemplo demonstra um caso de uso ao gravar uma sequência em uma variável e depois iterar pelos objetos de tag, imprimindo um conjunto de links de tag. O exemplo assume que o blog tem quatro tags. 

Esta função retorna o número total de posts publicados no blog especificado. Se nenhum parâmetro for especificado, ele contará seus posts padrão no blog. Como alternativa, você pode especificar "default" ou o ID de um blog diferente para fazer a contagem. O ID do blog está disponível na URL do painel de um determinado blog.

Retorna o número de vezes que uma variável existe em uma lista.

Retorna uma lista de registros do CRM associados a outro registro por seu ID, categoria de associação e ID de definição de associação.

Esta função retorna um objeto com os seguintes atributos: has_more, total, offset e results.

• has_mais indica que há mais resultados disponíveis além desse lote (total > offset).
• total é o número total de resultados disponíveis.
• offset é a compensação a utilizar para o próximo lote de resultados.
• results retorna um conjunto de objetos associados que correspondem aos parâmetros da função.

Obtém um único registro de CRM por consulta ou por ID. Os registros são retornados como um dicionário de propriedades e valores.

Esta função também pode ser usada com objetos personalizados e integradores.

Obtém uma lista de registros para um tipo de objeto específico do HubSpot CRM.

Esta função retorna um objeto com os seguintes atributos: has_more, total, offset e results.

• has_more indica que há mais resultados disponíveis além deste lote (total > offset).
• total é o número total de resultados disponíveis.
• offset é a compensação a utilizar para o próximo lote de resultados.
• results retorna uma matriz dos objetos especificados que correspondem aos parâmetros da função.

Obtém a definição de propriedade para um determinado tipo de objeto e nome de propriedade.

Os tipos de objetos suportados são objetos padrão do HubSpot (por exemplo, contatos), objetos específicos do portal e objetos integradores.

Obtém as definições das propriedades para um determinado tipo de objeto e conjunto de nomes de propriedades.

Os tipos de objetos suportados são objetos padrão do HubSpot (por exemplo, contatos), objetos específicos do portal e objetos integradores.

Como os módulos de CTA têm vários parâmetros que contêm variações de seu código, você pode usar a função CTA para gerar facilmente uma determinada CTA em um modelo, página ou e-mail. Esta função é o que o editor de rich text usa quando você adiciona uma CTA por meio dele.

Estenda uma lista anexando todos os itens de um iterável. Em outras palavras, insira todos os itens de uma lista em outra lista.

Esta função retorna os metadados de um arquivo por ID. Ela aceita um parâmetro, a identificação numérica do arquivo que deve ser procurado.

Retorna os links da conta de mídia social definidos nas configurações de conta. Usado no módulo follow_me padrão. 

Formata um endereço com base na localidade do contexto. 

Formata o nome de uma empresa, adicionando honoríficos japoneses quando apropriado.

Formata os componentes de data e hora de um objeto de data, semelhante ao filtro de HubL format_datetime. Esta função substitui a função datetimeformat descontinuada.

Esta função contém quatro parâmetros e calcula a distância elipsoidal 2D entre dois pontos na Terra. Use esta função como uma consulta de filtro para obter dados do HubDB.

Essa função retorna a URL pública de um modelo ou arquivo de código especificado. O parâmetro desta função é o caminho do ativo no gerenciador de design. URLs de arquivo codificadas são atualizadas sempre que você as publica; portanto, usando essa função, você garante que está sempre usando a última versão do arquivo.

Você pode gerar automaticamente essa função no aplicativo clicando com o botão direito do mouse em um arquivo e selecionando Copiar URL público, ou clicando em Açõese selecionando Copiar URL público. 

O exemplo abaixo obtém a URL de um arquivo Javascript criado no Gerenciador de design que pode ser incluído como src de uma tag <script>.

Esta função funciona como get_public_template_url, retornando a URL pública de um modelo ou arquivo de código especificado. A única diferença é que o parâmetro dessa função é o ID do modelo (disponível na URL do modelo ou arquivo codificado), em vez do caminho do gerenciador de design.

O HubDB é um recurso disponível no CMS Hub Professional e Enterprise.

A função hubdb_table pode ser usada para ter as informações em uma tabela, incluindo nome, colunas, última atualização etc. 

As seguintes informações podem ser obtidas ao chamar os atributos apropriados:

• ID: o ID da tabela.
• name: o nome da tabela.
• columns: uma lista de informações de coluna.
• created_at: o carimbo de data/hora em que esta tabela foi criada pela primeira vez.
• published_at: o carimbo de data/hora em que esta tabela foi publicada.
• updated_at: o carimbo de data/hora em que esta tabela foi atualizada pela última vez.
• row_count: o número de linhas na tabela.

O HubDB é um recurso disponível no CMS Hub Professional e Enterprise.

A função hubdb_table_column pode ser usada para ter as informações de uma coluna em uma tabela, como rótulo, tipo e opções. Esta função aceita dois parâmetros. 

Estas informações sobre a coluna podem ser obtidas chamando os atributos apropriados:

• ID: o ID da coluna.
• name: o nome da coluna.
• label: o rótulo a ser utilizado para a coluna.
• type: o tipo da coluna.
• options: para colunas de tipo select, um mapa de optionId
• foreignIds: para colunas do tipo "foreignId", uma lista de foreignIds (com as propriedades id e name).

Além dos atributos acima, há também um método que pode ser chamado: getOptionByName("<option name>") segundo o qual, para colunas do tipo "select", obterá as informações da opção pelo nome da opção.

O HubDB é um recurso disponível no CMS Hub Professional e Enterprise.

A função hubdb_table_row pode ser usada para obter uma linha de uma tabela do HubDB. A partir desta linha, você pode obter as informações de cada célula da tabela, chamando o atributo correspondente: 

• hs_id: o ID exclusivo global desta linha.
• hs_created_at: um carimbo de data/hora que representa quando esta linha foi criada.
• hs_path: quando usado em páginas dinâmicas, esta string é o último segmento do caminho da url para a página.
• hs_name: quando usado em páginas dinâmicas, este é o título da página.
• <column name> ou ["<column name>"]: obtém o valor da coluna para esta linha pelo nome da coluna.

O HubDB é um recurso disponível no CMS Hub Professional e Enterprise.

A função hubdb_table_rows pode ser usada para listar as linhas de uma tabela do HubDB e ser iterada. Uma única chamada de hubdb_table_rows() é limitada a 10 verificações de tabela por página.

Por padrão, essa função retornará um máximo de 1.000 linhas. Para recuperar mais linhas, especifique um limit na consulta, conforme mostrado no código abaixo.

Essa função gera uma tag de link que faz referência ao Arquivo principal do CSS(default_custom_style.min.css). Esse arquivo foi projetado para ser um arquivo CSS global que pode ser adicionado a todos os modelos. Para renderizar, a função requer um valor de parâmetro booleano de True.

Retorna a localização do primeiro item correspondente em uma array de base zero.

Esta função aceita três parâmetros, o primeiro é obrigatório. O primeiro parâmetro é o item que você está tentando encontrar na array. O segundo start e o terceiro end permitem encontrar esse item em uma parte da array. 

Coloca um elemento em uma lista no índice específico fornecido.

Esta função aceita dois parâmetros:

• Index: a posição em que um elemento deve ser inserido.
• Element: o item a ser inserido.

Retorna uma representação em string legível por humanos de um código de idioma, opcionalmente traduzido para um idioma de destino.

Carrega as traduções de um determinado caminho de pasta _locales e retorna um mapa dos valores.

Saiba mais sobre como incluir traduções de campos em módulos e temas personalizados.

Retorna a estrutura de links aninhados de um menu avançado. Os nós de menu têm uma variedade de propriedades que podem ser usadas nos objetos que são retornados. Se você passar null para a função de menu, ele retornará uma lista vazia. Você também pode especificar um menu por nome. Na maioria dos casos, é mais seguro usar o ID do menu, pois renomear um menu não afeta o ID. Ao construir para o marketplace, faz sentido usar "default" como padrão se o menu for null.

Obtém a URL de um ativo anexado a um módulo personalizado por meio de Arquivos vinculados > Outros arquivos.

Cria um objeto de namespace que pode conter atributos arbitrários. Ele pode ser inicializado de um dicionário ou com argumentos de palavras-chave.

Essa função enfileira um arquivo CSS para ser renderizado no elemento head. Todas as tags de link do CSS são agrupadas e renderizadas antes das tags JavaScript. O HubL é substituído por uma linha vazia e então uma tag de link é adicionada a {{ standard_header_includes }}. Este método requer uma URL absoluta; o conteúdo do CMS com uma URL relativa conhecida pode ser requerido usando a função get_asset_url().

Para consultar um estilo integrado a ser renderizado no head por meio de um elemento de tag de estilo, use as tags {% require_css %} e {% end_require_css %} em vez das tags de estilo e CSS.

O segundo parâmetro é um dicionário de opções para modificar a tag gerada. Suporta async (verdadeiro/falso), uma técnica descrita em web.dev e qualquer outro par de valores-chave será adicionado como um atributo HTML à tag de estilo.

Especifica se um script deve ser enfileirado para renderizar no cabeçalho ou no rodapé (padrão). Especifique o local de renderização, incluindo o parâmetro head ou footer. O HubL será substituído por uma linha vazia e incluído no cabeçalho ou rodapé. 

Para enfileirar um script integrado a ser renderizado no rodapé por meio de um elemento script, envolva suas tags <script> com {% require_js %} e {% end_require_js %}. 

Você também pode incluir opções adicionais de renderização nesta função. Estes serão adicionados como atributos HTML na tag de script. As opções de renderização incluem:

• position: head/footer
• defer: true/false
• async: true/false
• type: string

Reescreve a URL da imagem armazenada no Gerenciador de arquivos para uma URL que redimensionará a imagem mediante solicitação. A função aceita um parâmetro obrigatório e cinco parâmetros opcionais. Pelo menos um parâmetro opcional deve ser passado.

Obrigatório

• URL: string, a URL de uma imagem hospedada pela HubSpot.

Opcional

• width: número, a nova largura da imagem em pixels.
• height: número, a nova altura da imagem em pixels.
• length: número, o novo comprimento do lado maior em pixels.
• upscale: booleano, usa as dimensões da imagem redimensionada, mesmo que isso aumente a imagem original (as imagens podem parecer desfocadas).
• upsize: booleano, retorna a imagem redimensionada, mesmo que ela seja maior do que a original em bytes..

Inverte a ordem dos itens de uma lista. Não aceita nenhum parâmetro. Para inverter um objeto ou retornar um iterador para iterar a lista na ordem inversa, use |reverse

Defina o código de resposta como o código especificado. Atualmente, o único código suportado é 404. Se optar por usar isso, a página retornará um erro 404.

Retorna o início do dia de hoje (0h). Opcionalmente, você pode adicionar um parâmetro para alterar o fuso horário a partir do UTC padrão.

Converte um carimbo de data/hora UNIX para a hora local, com base nas Configurações de relatório do HubSpot. Você pode aplicar um filtro datetimeformat para formatar a data.

Retorna um dicionário HubL representando o cluster de tópicos associado a um fragmento de conteúdo (determinado pelo ID do conteúdo passado), incluindo metadados sobre a página pilar associada, o tópico central e os subtópicos. Pode ser usado para vincular automaticamente um fragmento de conteúdo à página de pilar associada [se existir].

Os metadados disponíveis podem ser encontrados em: attachableContent (os metadados do conteúdo atual), topic (os metadados dos tópicos associados ao conteúdo atual), coreTopic (os metadados dos tópicos associados ao cluster) e pillarPage (os metadados dos pilares associados à página pilar).

Use {{ topicCluster|pprint }}  para ver uma exibição completa das propriedades/atributos disponíveis.

A função truncate funciona da mesma forma que a função truncate filter, mas utiliza sintaxe de função em vez de sintaxe de filtro. O primeiro parâmetro especifica a string. O segundo parâmetro especifica o comprimento em que se deve truncar. O parâmetro final especifica os caracteres a adicionar quando ocorrer o truncamento.