Fonctions HubL

Les fonctions dans HubL sont similaires aux filtres puisqu'elles acceptent des paramètres et génèrent une valeur. Cependant, toutes les fonctions n'ont pas besoin d'être appliquées à une valeur de modèle initiale, mais interagissent avec d'autres zones de votre environnement HubSpot.

Si vous gérez un site web plus ancien, vous pouvez également consulter la liste des fonctions HubL obsolètes.

Découvrez ci-dessous chaque fonction HubL et sa syntaxe.

Ajoute un seul élément à la fin d'une liste.

La fonction blog_all_posts_url renvoie une URL complète vers la page de listing de tous les articles du blog indiqué. 

L'exemple ci-dessous montre comment cette fonction peut être utilisée comme href d'une ancre.

La fonction blog_author_url renvoie une URL complète vers la page de listing de l'auteur du blog indiqué.

L'exemple ci-dessous montre comment cette fonction peut être utilisée comme href d'une ancre. Cette fonction peut être combinée avec blog_authors comme le montrent les exemples de cette fonction.

La fonction blog_authors renvoie une séquence d'objets auteurs de blog pour le blog indiqué, triés par slug en ordre croissant. Cette séquence peut être stockée dans une variable et être parcourue pour créer des filtres d'articles d'auteurs personnalisés.

Le nombre d'articles publiés par chaque auteur peut être consulté avec author.live_posts.

La première ligne de l'exemple ci-dessous montre comment la fonction renvoie une séquence d'objets auteur. La suite de l'exemple montre un cas d'utilisation consistant à enregistrer une séquence dans une variable, puis à parcourir les objets auteur, en imprimant un ensemble de liens de listing d'auteurs. L'exemple suppose que le blog a 4 auteurs.

La fonction blog_by_id renvoie un blog selon l'ID. L'exemple de code ci-dessous montre l'utilisation de cette fonction pour générer un élément de liste avec lien hypertexte.

La fonction blog_page_link génère l'URL d'une vue paginée du listing de votre blog. La fonction prend un paramètre numérique, qui vous permet de générer des liens pour la page actuelle, suivante, précédente ou une page spécifique. Cette fonction est généralement utilisée dans l'attribut href des balises d'ancrage de la pagination et doit être utilisée sur le modèle de listing de votre blog.

Les exemples ci-dessous montrent cette fonction utilisée comme un href d'ancre. Le premier exemple affiche la page actuelle. Le deuxième exemple utilise le paramètre numéro 7 pour la septième page. Le troisième exemple utilise la variable next_page_num pour générer un lien relatif au numéro de la page actuelle (vous pouvez également utiliser la variable last_page_num pour la page précédente). Le dernier exemple utilise la variable current_page_num et un opérateur + pour créer un lien supérieur de 4 à la page actuelle.

Cette fonction rend un nombre déterminé d'articles populaires en une séquence. La séquence peut ensuite être enregistrée dans une variable et être parcourue par une boucle for, créant un listing personnalisé de vos articles les plus populaires. 

Les résultats de cette fonction sont mis en cache pendant six heures. Pour récupérer des articles de blog en utilisant HubL d'une manière qui évite la mise en cache, vous pouvez utiliser blog_recent_tag_posts à la place.

Dans l'exemple de code ci-dessous, la première ligne montre comment la fonction renvoie une séquence. La séquence est enregistrée en tant que variable qui est ensuite utilisée dans une boucle for. Toute variable d'article de blog doit utiliser le nom de l'élément individuel de la boucle plutôt que content.. Dans l'exemple, on utilise pop_post.name. Cette technique peut être utilisée sur les modèles de blog et les pages de site web.

La fonction blog_post_archive_url renvoie une URL complète vers la page de listing des archives pour les valeurs de date données sur le blog indiqué. Cette fonction comporte deux paramètres obligatoires et deux paramètres facultatifs. Le premier paramètre est un ID de blog ou simplement le mot clé "default". Le second est l'année des articles archivés que vous souhaitez afficher.

Les paramètres facultatifs comprennent le mois et le jour des archives archivés que vous souhaitez afficher, respectivement.

L'exemple ci-dessous montre comment cette fonction peut être utilisée comme href d'une ancre.

La fonction blog_recent_author_posts renvoie une séquence d'objets d'article de blog pour l'auteur indiqué, triés en commençant par le plus récent. Cette séquence d'articles peut être enregistrée dans une variable et être parcourue par une boucle for, créant un listing d'articles personnalisé d'un auteur particulier. 

La fonction prend trois paramètres. Le premier paramètre indique à partir de quel blog collecter les articles d'un auteur. La valeur doit être "default" ou l'ID d'un blog particulier (disponible dans l'URL du tableau de bord Blog) Le deuxième paramètre indique l'auteur à utiliser. Ce paramètre peut utiliser la balise content.blog_post_author.slug pour utiliser l'auteur de l'article actuel ou accepter un nom en minuscule avec trait d'union tel que "brian-halligan". Le troisième paramètre indique combien d'articles sont récupérés. 

La première ligne de l'exemple ci-dessous montre comment la fonction renvoie une séquence d'articles d'un auteur. Dans cet exemple, plutôt que d'indiquer un nom d'auteur exact, l'auteur actuel de l'article est utilisé. La séquence est enregistrée dans une variable et parcourue en boucle. Toute variable d'article de blog doit utiliser le nom de l'élément individuel de la boucle plutôt que content.. Dans l'exemple, on utilise author_post.name. Cette technique peut être utilisée sur les modèles de blog et de page.

La fonction blog_recent_posts renvoie une séquence d'objets d'articles de blog pour le blog indiqué, triés en commençant par le plus récent. Cette séquence d'articles peut être enregistrée dans une variable et être parcourue par une boucle for, créant un listing personnalisé de vos articles les plus populaires. 

La fonction prend deux paramètres. Le premier paramètre indique le blog à partir duquel collecter les articles populaires. La valeur doit être "default" ou l'ID d'un blog particulier (disponible dans l'URL du tableau de bord Blog) Le deuxième paramètre indique le nombre d'articles à récupérer. 

La première ligne de l'exemple ci-dessous montre comment la fonction renvoie une séquence. La séquence est enregistrée dans une variable et parcourue en boucle. Toute variable d'article de blog doit utiliser le nom de l'élément individuel de la boucle plutôt que content.. Dans l'exemple, on utilise rec_post.name. Cette technique peut être utilisée, non seulement sur les modèles de blog, mais aussi sur les pages ordinaires. 

La fonction blog_recent_tag_posts renvoie une séquence d'objets d'article de blog pour une ou plusieurs balises indiquées, triés en commençant par le plus récent. Cette séquence d'articles peut être enregistrée dans une variable et être parcourue par une boucle for, créant un listing d'articles personnalisé d'une ou plusieurs balises particulières.

Dans l'exemple de code ci-dessous :

• La première ligne montre comment la fonction renvoie une séquence d'articles selon la balise. 
• La deuxième ligne montre comment enregistrer la fonction dans une variable de séquence. Le reste du code utilise ensuite une boucle for pour parcourir les valeurs de la variable. Toute variable d'article de blog doit utiliser le nom de l'élément individuel de la boucle plutôt que content.. Dans l'exemple, on utilise tag_post.name. Vous pouvez utiliser cette technique sur les pages de blog et de site web. 

Découvrez-en davantage sur la création d'une liste d'articles de blog connexes.

La fonction blog_tag_url renvoie une URL complète vers la page de listing de la balise du blog indiquée.

Cette fonction accepte deux paramètres. Le premier paramètre indique dans quel blog se trouve la page de listing de la balise. Le deuxième paramètre indique la balise à mettre en lien. Ce paramètre peut utiliser topic.slug pour une balise particulière de content.topic_list ou accepter un nom en minuscule avec un trait d'union tel que "marketing-tips".

L'exemple ci-dessous montre comment cette fonction peut être utilisée comme  d'une ancre.href.

La fonction blog_tags renvoie une séquence des 250 balises les plus présentes dans les blogs (en fonction du nombre d'articles de blog associés) pour le blog indiqué, triées par nombre d'articles de blog.

Cette séquence peut être stockée dans une variable et être parcourue pour créer des filtres d'articles de balises personnalisés. Le nombre d'articles pour chaque balise peut être consulté avec tag.live_posts. 

Cette fonction accepte deux paramètres. Le premier paramètre indique le blog à partir duquel récupérer les balises. Le deuxième paramètre fixe une limite au nombre de balises récupérées.

La première ligne de l'exemple ci-dessous montre comment la fonction renvoie une séquence d'objets balises. La suite de l'exemple montre un cas d'utilisation consistant à enregistrer une séquence dans une variable, puis à parcourir les objets balise, en imprimant un ensemble de liens de balise. L'exemple suppose que le blog a 4 balises. 

Cette fonction renvoie le nombre total d'articles publiés dans le blog indiqué. Si aucun paramètre n'est indiqué, il comptera les articles de votre blog par défaut. Vous pouvez également indiquer "default" ou l'ID d'un blog différent à comptabiliser. L'ID du blog est disponible dans l'URL de votre tableau de bord pour un blog particulier.

Renvoie le nombre de fois qu'une variable existe dans une liste.

Obtient une liste d'enregistrements CRM associés à un autre enregistrement par son ID d'enregistrement, sa catégorie d'association et son ID de définition d'association.

Cette fonction renvoie un objet avec les attributs suivants : has_more, total, offset et results.

• has_more indique qu'il y a plus de résultats disponibles au-delà de ce lot (total > offset).
• total est le nombre total de résultats disponibles.
• offset est le décalage à utiliser pour le prochain lot de résultats.
• results renvoie un tableau des objets associés indiqués correspondant aux paramètres de la fonction

Récupère un seul enregistrement CRM par requête ou selon son ID. Les enregistrements sont renvoyés sous la forme d'un dictionnaire de propriétés et de valeurs.

Cette fonction peut également être utilisée avec des objets personnalisés et des objets intégrateurs.

Obtient une liste d'enregistrements pour un type d'objet spécifique à partir de HubSpot CRM.

Cette fonction renvoie un objet avec les attributs suivants : has_more, total, offset et results.

• has_more indique qu'il y a plus de résultats disponibles au-delà de ce lot (total > offset).
• total est le nombre total de résultats disponibles.
• offset est le décalage à utiliser pour le prochain lot de résultats.
• results renvoie un tableau des objets indiqués correspondant aux paramètres de la fonction

Obtenir la définition de la propriété pour un type d'objet et un nom de propriété donnés.

Les types d'objets pris en charge sont les objets standards HubSpot (par exemple, contacts), les objets spécifiques au portail et les objets intégrateurs.

Obtenir les définitions de propriété pour un type d'objet et un ensemble de noms de propriétés donnés.

Les types d'objets pris en charge sont les objets standards HubSpot (par exemple, contacts), les objets spécifiques au portail et les objets intégrateurs.

Étant donné que les modules CTA possèdent de nombreux paramètres qui contiennent des variations de leur code, vous pouvez utiliser la fonction CTA pour générer facilement un CTA particulier dans un modèle, une page ou un e-mail. Cette fonction est celle que l'éditeur de texte enrichi utilise lorsque vous ajoutez un CTA via l'éditeur.

Étend une liste en ajoutant tous les éléments d'une table itérative. En d'autres termes, insérer tous les éléments d'une liste dans une autre liste.

Cette fonction renvoie les métadonnées d'un fichier par ID. Elle accepte un seul paramètre, l'ID numérique du fichier à rechercher.

Renvoie les liens de compte de réseau social définis dans les paramètres du compte. Utilisé dans le module follow_me par défaut. 

Formate une adresse en fonction des paramètres régionaux du contexte. 

Formate le nom d'une entreprise en ajoutant des titres honorifiques japonais, le cas échéant.

Formate les composants de date et d'heure d'un objet de date, comme pour le filtre HubL format_datetime. Cette fonction remplace la fonction obsolète datetimeformat.

Cette fonction contient 4 paramètres et calcule la distance ellipsoïdale 2D entre deux points sur la Terre. Utilisez cette fonction comme une requête de filtre pour obtenir des données HubDB.

Cette fonction renvoie l'URL publique d'un modèle ou d'un fichier de code indiqué. Le paramètre de cette fonction est le chemin d'accès de la ressource dans le gestionnaire de conception. Les URL des fichiers codés sont mises à jour à chaque fois que vous les publiez ; par conséquent, en utilisant cette fonction, vous vous assurez de toujours utiliser la dernière version du fichier. 

Vous pouvez générer automatiquement cette fonction dans l'application, soit en faisant un clic droit sur un fichier et en sélectionnant Copier l'URL publique, soit en cliquant sur Actions, puis en sélectionnant Copier l'URL publique. 

L'exemple ci-dessous permet d'obtenir l'URL d'un fichier JavaScript créé dans le gestionnaire de conception qui peut être inclus comme src d'une balise <script>.

Cette fonction s'utilise comme get_public_template_url, elle renvoie l'URL publique d'un modèle ou d'un fichier de code indiqué. La seule différence est que le paramètre de cette fonction est l'ID du modèle (disponible dans l'URL du modèle ou du fichier codé), au lieu du chemin d'accès du gestionnaire de conception.

HubDB est une fonctionnalité disponible dans CMS Hub Pro et Entreprise.

La fonction hubdb_table peut être utilisée pour obtenir des informations sur un tableau, notamment son nom, ses colonnes, sa dernière mise à jour, etc. 

Les éléments d'information suivants peuvent être extraits en appelant les attributs appropriés :

• ID : l'ID du tableau.
• name : nom du tableau.
• columns : une liste d'informations sur les colonnes.
• created_at : l'horodatage de la date de création de ce tableau.
• published_at : l'horodatage de la date de publication de ce tableau.
• updated_at : horodatage de la dernière mise à jour de ce tableau.
• row_count : le nombre de lignes dans le tableau.

HubDB est une fonctionnalité disponible dans CMS Hub Pro et Entreprise.

La fonction hubdb_table_column peut être utilisée pour obtenir des informations sur une colonne du tableau telles que son libellé, son type et ses options. Cette fonction accepte deux paramètres. 

Ces informations sur la colonne peuvent être extraites en appelant les attributs appropriés :

• ID : l'ID de la colonne.
• name : nom de la colonne.
• label : le libellé à utiliser pour la colonne.
• type : le type de la colonne.
• options : pour les colonnes de type select, un plan de optionId et les informations sur les options.
• foreignIds : pour les colonnes de type "foreignId", une liste de foreignIds (avec les propriétés id et name).

En plus des attributs ci-dessus, il existe également une méthode qui peut être appelée : getOptionByName("<option name>") pour les colonnes de type "select", cela permet d'obtenir des informations sur l'option grâce au nom de l'option.

HubDB est une fonctionnalité disponible dans CMS Hub Pro et Entreprise.

La fonction hubdb_table_row peut être utilisée pour extraire une seule ligne d'un tableau HubDB. À partir de cette ligne, vous pouvez extraire des informations de chaque cellule du tableau en faisant appel à l'attribut correspondant : 

• hs_id : l'identifiant unique au niveau mondial pour cette ligne.
• hs_created_at : un horodatage représentant la date de création de cette ligne.
• hs_path : lorsqu'il est utilisé avec des pages dynamiques, cette chaîne est le dernier segment du chemin d'accès de l'URL de la page.
• hs_name : lorsqu'il est utilisé avec des pages dynamiques, il s'agit du titre de la page.
• <column name> ou ["<column name>"] : obtient la valeur de la colonne pour cette ligne selon le name de la colonne.

HubDB est une fonctionnalité disponible dans CMS Hub Pro et Entreprise.

La fonction hubdb_table_rows peut être utilisée pour lister les lignes d'un tableau HubDB, afin de les parcourir. Un appel de hubdb_table_rows() est limité à 10 analyses de tableau par page.

Par défaut, cette fonction renverra un maximum de 1 000 lignes. Pour récupérer plus de lignes, spécifiez une limit dans la demande, comme indiqué dans le code ci-dessous.

Cette fonction génère une balise de lien qui fait référence au Fichier CSS principal (default_custom_style.min.css). Ce fichier est conçu pour être un fichier CSS global qui peut être ajouté à tous les modèles. Pour effectuer le rendu, la fonction nécessite un paramètre booléen dont la valeur est True.

Renvoie l'emplacement du premier élément correspondant dans un array à base de 0.

Cette fonction accepte 3 paramètres. Le premier paramètre est obligatoire. Le premier paramètre est l'élément que vous essayez de trouver dans le array. Le deuxième (start) et le troisième (end) vous permettent de trouver cet élément dans une partie du array. 

Place un élément dans une liste à l'indice spécifique fourni.

Cette fonction accepte deux paramètres :

• Index : la position où un élément doit être inséré.
• Element : l'élément à insérer.

Renvoie une représentation sous forme de chaîne lisible par l'homme d'un code de langue, éventuellement traduit dans une langue cible.

Charge les traductions à partir d'un chemin de dossier_locales spécifique et renvoie une carte des valeurs.

Découvrez-en davantage sur l'inclusion des traductions de champs dans des modules et des thèmes personnalisés.

Renvoie la structure des liens imbriqués d'un menu avancé. Les nœuds de menu ont une variété de propriétés qui peuvent être utilisées sur les objets qui sont renvoyés. Si vous transmettez null à la fonction menu, elle renverra une liste de pylônes vide. Vous pouvez également indiquer un menu par son nom. Dans la plupart des cas, il est plus sûr d'utiliser l'id du menu, car un menu renommé conservera son id. S'il est créé pour la marketplace, il est logique de mettre par défaut "default" si le menu est null.

Obtient l'URL d'une ressource attachée à un module personnalisé via Fichiers associés > Autres fichiers.

Crée un objet d'espace de noms qui peut contenir des attributs arbitraires. Il peut être initialisé à partir d'un dictionnaire ou avec des arguments de mots-clés.

Cette fonction met en file d'attente un fichier CSS à rendre dans l'élément head. Toutes les balises de lien CSS sont regroupées et sont rendues avant toute balise JavaScript. Le HubL est remplacé par une ligne vide, puis une balise de link est ajoutée à {{ standard_header_includes }}. Cette méthode nécessite une URL absolue ; le contenu du CMS avec une URL relative connue peut être nécessaire en utilisant la fonction get_asset_url().

Pour mettre en file d'attente un style intraligne à rendre dans head via un élément de balise de style, utilisez plutôt les balises {% require_css %} et {% end_require_css %} avec vos balises de style et CSS à l'intérieur.

Le second paramètre est un dictionnaire d'options permettant de modifier la balise générée. Pend en charge async (true/false) , une technique décrite sur web.dev et tout autre couple clé-valeur sera ajoutée comme attribut HTML à la balise de style.

Indique si un script doit être mis en file d'attente pour être rendu dans l'en-tête ou le pied de page (par défaut). Indiquez l'emplacement du rendu en incluant le paramètre head ou footer. Le HubL sera remplacé par une ligne vide, et inclus soit dans l'en-tête ou le pied de page . 

Pour mettre en file d'attente un script intraligne qui sera rendu dans le pied de page via l'élément script, encadrez vos balises <script> avec {% require_js %} et {% end_require_js %}. 

Vous pouvez également inclure des options de rendu supplémentaires dans cette fonction. Ils seront ajoutés en tant qu'attributs HTML dans la balise script. Les options de rendus incluent :

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

Réécrit l'URL de l'image stockée dans le Gestionnaire de fichiers en une URL qui redimensionnera l'image sur demande. La fonction accepte un paramètre obligatoire et cinq paramètres facultatifs. Au moins un paramètre facultatif doit être transmis.

Obligatoire

• URL : chaîne, URL d'une image hébergée par HubSpot.

Facultatif

• width : nombre, la nouvelle largeur de l'image en pixels.
• height : nombre, la nouvelle hauteur de l'image en pixels.
• length : nombre, la nouvelle longueur du plus grand côté, en pixels.
• upscale : booléen, utilise les dimensions de l'image redimensionnée même si elles augmentent l'échelle de l'image originale (les images peuvent apparaître floues).
• upsize : booléen, renvoie l'image redimensionnée même si elle est plus grande que l'originale en octets.

Inverse le classement des éléments d'une liste. Il ne prend pas de paramètres. Pour inverser un objet ou renvoyer un itérateur pour parcourir la liste en sens inverse, utilisez |reverse

Définir le code de réponse comme le code indiqué. 404 est le seul code pris en charge pour le moment. Si vous l'utilisez, votre page renverra une erreur 404.

Renvoie le début de la journée (12h00). Vous pouvez éventuellement ajouter un paramètre pour modifier le fuseau horaire par rapport à l'UTC par défaut.

Convertit un horodatage UNIX en heure locale, en fonction des paramètres de votre rapport HubSpot. Vous pouvez ensuite appliquer un filtre datetimeformat pour formater la date.

Renvoie un dictionnaire HubL représentant le groupe thématique associé à un élément de contenu (déterminé par l'id de contenu transmis), y compris les métadonnées sur la page pilier associée, le thème principal et les sous-thèmes. Peut être utilisé pour établir un "auto-link" entre un élément de contenu et la page pilier qui lui est associée [si elle existe].

Les métadonnées disponibles se trouvent dans : attachableContent (les métadonnées du contenu actuel), topic (les métadonnées du thème associé du contenu actuel), coreTopic (les métadonnées du thème principal du groupe associé), et pillarPage (les métadonnées de la page pilier associées).

Utilisez {{ topicCluster|pprint }} pour obtenir un affichage complet des propriétés/attributs disponibles.

La fonction truncate s'utilise de la même manière que le filtre truncate mais utilise la syntaxe de la fonction au lieu de celle du filtre. Le premier paramètre indique la chaîne. Le deuxième paramètre indique la longueur à laquelle il faut tronquer. Le dernier paramètre indique les caractères à ajouter lorsque la troncature se produit.