Funciones de HubL

Las funciones en HubL son similares a los filtros en el sentido de que aceptan parámetros y generan un valor. Sin embargo, no todas las funciones deben aplicarse a un valor de plantilla inicial, sino que interactúan con otras áreas de tu entorno de HubSpot.

Si mantienes un sitio web antiguo, también puedes consultar la lista de funciones de HubL obsoletas.

A continuación, descubre más información sobre cada función de HubL y su sintaxis.

Agrega un solo elemento al final de una lista.

La función blog_all_posts_url devuelve una URL completa de la página del listado de todas las publicaciones del blog especificado. 

El ejemplo siguiente muestra cómo se puede utilizar esta función como hrefde un ancla.

La función blog_author_url devuelve una URL completa de la página del listado del autor del blog especificado.

El ejemplo siguiente muestra cómo se puede utilizar esta función como hrefde un ancla. Esto se puede combinar con blog_authors como se muestra en los ejemplos de esa función.

La función blog_authors devuelve una secuencia de objetos de autor de blog para el blog especificado, ordenados por slug de forma ascendente. Esta secuencia puede ser almacenada en una variable e iterada para crear filtros de publicación de autor personalizados.

Se puede acceder al número de publicaciones activas de cada autor con author.live_posts.

La primera línea del ejemplo siguiente demuestra cómo la función devuelve una secuencia de objetos de autor. El resto del ejemplo muestra un caso de uso de guardar una secuencia en una variable y luego iterar a través de los objetos de autor, imprimiendo un conjunto de enlaces de listas de autores. El ejemplo supone que el blog tiene 4 autores.

La función blog_by_id devuelve un blog por ID. El siguiente código de ejemplo muestra esta función en uso para generar un elemento de lista con hipervínculos.

La función blog_page_link genera la URL de una vista paginada del listado de tu blog. La función toma un parámetro numérico, que permite generar enlaces para la página actual, la siguiente, la anterior o una página específica. Esta función se utiliza generalmente en el atributo href de las etiquetas de anclaje de la paginación y debe ser utilizada en la plantilla de la lista de tu blog.

Los ejemplos siguientes muestran esta función en uso como un ancla href. El primer ejemplo muestra la página actual. El segundo ejemplo toma el parámetro número 7 para especificar la séptima página. El tercer ejemplo utiliza la variable next_page_num para generar un enlace relativo al número de página actual (también puedes utilizar la variable last_page_num para la página anterior). El último ejemplo utiliza la variable current_page_num y un operador + para crear un enlace que sea 4 mayor que la página actual.

Esta función convierte un número determinado de publicaciones populares en una secuencia. Esta secuencia se puede guardar en una variable e iterar a través de un bucle for, creando un listado de publicaciones personalizadas de tus publicaciones más populares. 

Los resultados de esta función se almacenan en caché durante seis horas. Para recuperar publicaciones de blog usando HubL de una manera que evite el almacenamiento en caché, es recomendable que uses blog_recent_tag_posts en su lugar.

En el siguiente código de ejemplo, la primera línea muestra cómo la función devuelve una secuencia. La secuencia se guarda como una variable que luego se usa en un bucle for. Cualquier variable de la publicación del blog debe utilizar el nombre del elemento individual del bucle en lugar del contenido.. En el ejemplo, se utiliza pop_post.name. Esta técnica se puede utilizar en plantillas de blog y páginas de sitio web.

La función blog_post_archive_urldevuelve una URL completa a la página del listado de archivos para los valores de fecha dados en el blog especificado. Esta función tiene dos parámetros obligatorios y dos opcionales. El primer parámetro es un ID de blog o simplemente la palabra clave "default". El segundo es el año de las publicaciones archivadas que deseas mostrar.

Los parámetros opcionales incluyen el mes y el día de las publicaciones archivadas que deseas mostrar, respectivamente.

El ejemplo siguiente muestra cómo se puede utilizar esta función como hrefde un ancla.

La función blog_recent_author_posts devuelve una secuencia de objetos de publicaciones de blog para el autor especificado, ordenados por el más reciente. Esta secuencia de publicaciones puede guardarse en una variable e iterarse con un bucle for, creando un listado de publicaciones personalizado de un autor en particular. 

La función toma tres parámetros. El primer parámetro especifica de qué blog se recogen las publicaciones de un autor. El valor debe ser "default" o el ID de un blog en particular (disponible en la URL del panel de control del blog). El segundo parámetro especifica el autor a utilizar. Este parámetro puede utilizar el content.blog_post_author.slug para usar el autor del post actual o acepta un nombre con guion en minúsculas como "brian-halligan". El tercer parámetro especifica cuántos posts se recuperan. 

La primera línea del ejemplo siguiente demuestra cómo la función devuelve una secuencia de publicaciones de un autor. En este ejemplo, en lugar de especificar un nombre de autor exacto, se utiliza el autor actual de la publicación. La secuencia se guarda en una variable y se repite en bucle. Cualquier variable del blog debe utilizar el nombre del elemento individual del bucle en lugar del contenido.. En el ejemplo, se utiliza author_post.name. Esta técnica se puede utilizar en las plantillas de blogs y páginas.

El blog_recent_posts devuelve una secuencia de objetos de publicaciones de blog para el blog especificado, ordenados por el más reciente primero. Esta secuencia de publicaciones puede ser guardada en una variable e iterada a través de un bucle for, creando un listado de publicaciones personalizadas de tus publicaciones más populares. 

La función toma dos parámetros. El primer parámetro especifica de qué blog se recogen los posts populares. El valor debe ser "default" o el ID de un blog en particular (disponible en la URL del panel de control del blog). El segundo parámetro especifica cuántos posts se recuperan. 

La primera línea del ejemplo siguiente demuestra cómo la función devuelve una secuencia. La secuencia se guarda en una variable y se repite en bucle. Cualquier variable de la publicación del blog debe utilizar el nombre del elemento individual del bucle en lugar del contenido.. En el ejemplo, se utiliza rec_post.name. Esta técnica se puede utilizar, no sólo en las plantillas de los blogs, sino también en las páginas regulares

La función blog_recent_tag_posts devuelve una secuencia de objetos de publicaciones de blog para una o varias etiquetas especificadas, ordenadas por la más reciente primero. Esta secuencia de publicaciones puede guardarse en una variable e iterarse con un bucle for, creando un listado de publicaciones personalizado por una o varias etiquetas en particular.

En el código de ejemplo a continuación:

• La primera línea muestra cómo la función devuelve una secuencia de publicaciones por etiqueta. 
• La segunda línea muestra cómo guardar la función en una variable de secuencia. El resto del código utiliza un bucle for para recorrer los valores de la variable. Cualquier variable de la publicación del blog debe utilizar el nombre del elemento individual del bucle en lugar del contenido.. En el ejemplo, se utiliza tag_post.name. Puedes usar esta técnica tanto en páginas de blog como de sitio web. 

Más información sobre cómo crear una lista de publicaciones de blog relacionadas.

La función blog_tag_url devuelve una URL completa de la página de la etiqueta del blog especificada.

Esta función acepta dos parámetros. El primer parámetro especifica en qué blog se encuentra la página del listado de la etiqueta. El segundo parámetro especifica la etiqueta a enlazar. Este parámetro puede utilizar el topic.slug para una etiqueta particular de content.topic_list o acepta un nombre con guion en minúsculas como "marketing-tips".

El siguiente ejemplo muestra cómo se puede utilizar esta función como un ancla href.

La función blog_tags devuelve una secuencia de las 250 etiquetas más comentadas en el blog (en función del número de publicaciones asociadas) para el blog especificado, ordenadas por el número de publicaciones.

Esta secuencia puede ser almacenada en una variable e iterada para crear filtros personalizados para los posts de la etiqueta. Se puede acceder al número de publicaciones de cada etiqueta con tag.live_posts 

Esta función acepta dos parámetros. El primer parámetro especifica de qué blog se van a obtener las etiquetas. El segundo parámetro establece un límite en el número de etiquetas obtenidas.

La primera línea del ejemplo siguiente muestra cómo la función devuelve una secuencia de objetos de etiqueta. El resto del ejemplo muestra un caso de uso de guardar una secuencia en una variable y luego iterar a través de los objetos de etiqueta, imprimiendo un conjunto de enlaces de etiqueta. El ejemplo supone que el blog tiene 4 etiquetas. 

Esta función devuelve el número total de posts publicados en el blog especificado. Si no se especifica ningún parámetro, contará las publicaciones de tu blog por opción predeterminada. Alternativamente, puedes especificar "default" o un ID de un blog diferente para contar. El ID del blog está disponible en la URL de tu panel de control para un blog en particular.

Devuelve el número de veces que una variable existe en una lista.

Obtiene una lista de registros de CRM asociados a otro registro por su ID de registro, categoría de asociación e ID de definición de asociación.

Esta función devuelve un objeto con los siguientes atributos: has_more, total, offset y results.

• has_more indica que hay más resultados disponibles más allá de este lote (total > offset).
• total es el número total de resultados disponibles.
• offset es el desplazamiento a utilizar para el siguiente lote de resultados.
• results devuelve una matriz de los objetos asociados especificados que coinciden con los parámetros de la función

Obtiene un único registro de CRM por consulta o por su ID. Los registros se devuelven como un dictado de propiedades y valores.

Esta función también puede utilizarse con objetos personalizados e integradores.

Obtiene una lista de registros para un tipo de objeto específico del HubSpot.

Esta función devuelve un objeto con los siguientes atributos: has_more, total, offset y results.

• has_more indica que hay más resultados disponibles más allá de este lote (total > offset).
• total es el número total de resultados disponibles.
• offset es el offset a utilizar para el siguiente lote de resultados.
• results devuelve una matriz de los objetos especificados que coinciden con los parámetros de la función.

Obtén la definición de la propiedad para un tipo de objeto y un nombre de propiedad dados.

Los tipos de objetos admitidos son los objetos estándar de HubSpot (por ejemplo, los contactos), los objetos específicos del portal y los objetos del integrador.

Obtén las definiciones de propiedades para un tipo de objeto y un conjunto de nombres de propiedades dados.

Los tipos de objetos admitidos son los objetos estándar de HubSpot (por ejemplo, los contactos), los objetos específicos del portal y los objetos del integrador.

Debido a que los módulos CTA tienen muchos parámetros que contienen variaciones de su código, puedes utilizar la función CTA para generar fácilmente un CTA particular en una plantilla, página o correo electrónico. Esta función es la que utiliza el editor de texto enriquecido cuando se agrega un CTA a través del editor.

Amplía una lista agregando todos los elementos de un iterable. En otras palabras, inserta todos los elementos de una lista en otra lista.

Esta función devuelve los metadatos de un archivo por ID. Acepta un único parámetro, el ID numérico del fichero a buscar.

Devuelve los enlaces de cuenta de redes sociales establecidos en la configuración de la cuenta. Usado en el módulo follow_me predeterminado. 

Formatea una dirección según la configuración regional del contexto. 

Formatea el nombre de una empresa agregando honoríficos japoneses cuando corresponda.

Formatea los componentes de fecha y hora de un objeto fecha, similar al filtro de HubL format_datetime. Esta función reemplaza la función datetimeformat obsoleta.

Esta función contiene 4 parámetros y calcula la distancia elipsoidal 2D entre dos puntos de la Tierra. Utilice esta función como una consulta de filtro para obtener los datos de HubDB.

Esta función devuelve la URL pública de una plantilla o archivo de código especificado. El parámetro de esta función es la ruta del activo en el gestor de diseño. Las URL de los archivos codificados se actualizan cada vez que se publican; por lo tanto, al utilizar esta función te aseguras de utilizar siempre la última versión del archivo

Puedes generar automáticamente esta función en la aplicación, bien haciendo clic con el botón derecho en un archivo y seleccionando Copiar URL pública, o bien haciendo clic en Accionesy seleccionando luego Copiar URL pública 

Tl siguiente ejemplo obtiene la URL de un archivo Javascript creado en Design Manager que puede incluirse como src de una etiqueta<script>.

Esta función trabaja igual que get_public_template_url, devolviendo la URL pública de una plantilla o archivo de código especificado. La única diferencia es que el parámetro de esta función es el ID de la plantilla (disponible en la URL de la plantilla o archivo codificado), en lugar de la ruta del gestor de diseño.

HubDB es una función disponible en CMS Hub Pro y Enterprise.

La función hubdb_table puede utilizarse para obtener información sobre una tabla, incluyendo su nombre, columnas, última actualización, etc. 

Los siguientes datos pueden obtenerse llamando a los atributos correspondientes:

• ID: el ID de la tabla.
• name: el nombre de la tabla.
• columns: una lista de información de las columnas.
• created_at: la marca de tiempo de cuando se creó esta tabla por primera vez.
• published_at: la marca de tiempo de cuando se publicó esta tabla.
• updated_at: marca de tiempo de cuando esta tabla fue actualizada por última vez.
• row_count: el número de filas de la tabla.

HubDB es una función disponible en CMS Hub Pro y Enterprise.

La función hubdb_table_column puede utilizarse para obtener información sobre una columna de la tabla, como su etiqueta, tipo y opciones. Esta función acepta dos parámetros. 

Esta información sobre la columna puede obtenerse llamando a los atributos correspondientes:

• ID: el ID de la columna.
• name: el nombre de la columna.
• label: la etiqueta que se utilizará para la columna.
• type: el tipo de la columna.
• options: para las columnas de tipo select, un mapa de optionId para información de la opción.
• foreignIds: para las columnas de tipo "foreignId" , una lista de foreignIds (con las propiedades id y name).

Además de los atributos anteriores, también hay un método que se puede llamar: getOptionByName("<option name>") mediante el cual, para las columnas de tipo "select" , se obtendrá la información de la opción por el nombre de la misma.

HubDB es una función disponible en CMS Hub Pro y Enterprise.

La función hubdb_table_row puede utilizarse para extraer una sola fila de una tabla HubDB. Desde esta fila, se puede extraer información de cada celda de la tabla llamando al atributo correspondiente: 

• hs_id: el identificador único global de esta fila.
• hs_created_at: una marca de tiempo que representa cuándo se creó esta fila.
• hs_path: cuando se utiliza con páginas dinámicas, esta cadena es el último segmento de la ruta de la url de la página.
• hs_name: cuando se utiliza con páginas dinámicas, es el título de la página.
• <column name> o ["<column name>"]: obtiene el valor de la columna para esta fila por el nombre de la columna.

HubDB es una función disponible en CMS Hub Pro y Enterprise.

La función hubdb_table_rows se puede utilizar para enumerar las filas de una tabla HubDB, para ser iterada. Una sola llamada de hubdb_table_rows() está limitada a 10 escaneos de tabla por página.

Por opción predeterminada, esta función devolverá un máximo de 1.000 filas. Para recuperar más filas, especifica un limit en la consulta, como se muestra en el código a continuación.

Esta función genera una etiqueta de enlace que hace referencia al Archivo CSS principal(default_custom_style.min.css). Este archivo está diseñado para ser un archivo CSS global que se puede agregar a todas las plantillas. Para renderizar, la función requiere un valor de parámetro booleano de True.

Devuelve la ubicación del primer elemento coincidente en una arraybasada en 0.

Esta función acepta 3 parámetros, El primer parámetro es obligatorio. El primer parámetro es el elemento que se intenta encontrar en la array. La segunda (inicio) y la tercera (fin) permiten encontrar ese elemento en una porción de la array. 

Coloca un elemento en una lista en el índice específico proporcionado.

Esta función acepta dos parámetros:

• Index: la posición en la que se va a insertar un elemento.
• Element: el elemento que se va a insertar.

Devuelve una representación de cadena legible por humanos de un código de idioma, opcionalmente traducido a un idioma de destino.

Carga traducciones de una ruta de carpeta_locales determinada y devuelve un mapa de los valores.

Obtén más información sobre la inclusión de traducciones de campo en módulos y temas personalizados.

Devuelve la estructura de enlaces anidados de un menú avanzado. Los nodos del menú tienen una variedad de propiedades que se pueden utilizar en los objetos que se devuelven. Si pasas null a la función de menú, ésta devolverá un pylist vacío. También puedes especificar un menú por su nombre. En la mayoría de los casos es más seguro utilizar el id del menú, ya que el cambio de nombre de un menú no afectará al id. Si se construye para el mercado tiene sentido que por opción predeterminada sea "default" si el menú es null.

Obtiene la URL de un material adjunto a un módulo personalizado a través de Linked Files > Other Files.

Crea un objeto namespace que puede contener atributos arbitrarios. Se puede inicializar desde un diccionario o con argumentos de palabras clave.

Esta función pone en cola un archivo CSS para ser renderizado en el elemento head. Todas las etiquetas de enlace CSS se agrupan y se muestran antes que cualquier etiqueta JavaScript. El HubL se sustituye por una línea vacía y luego se agrega una etiqueta de link a {{ standard_header_includes }}. Este método requiere una URL absoluta; se puede requerir contenido CMS con una URL relativa conocida utilizando la función get_asset_url().

Para poner en cola un estilo en línea para que se muestre en el head a través de un elemento de etiqueta style, utiliza la etiqueta {% require_css %} y {% end_require_css %} en su lugar con tus etiquetas style y CSS dentro de eso.

El segundo parámetro es un diccionario de opciones para modificar la etiqueta generada. Admite async (true/false) una técnica descrita en web.dev y cualquier otro par clave-valor se agregará como atributos HTML a la etiqueta de estilo.

Especifica si un script debe ser puesto en cola para ser renderizado en el encabezado o en el pie de página (default). Especifique la ubicación del renderizado incluyendo el encabezado o pie de página de la página. El HubL será sustituido por una línea vacía, y se incluirá en el encabezado o en el pie de página

Para poner en cola un script en línea para que se muestre en el pie de página a través de un elemento de script, envuelve tus etiquetas <script> con {% require_js %} y {% end_require_js %}. 

También puedes incluir opciones de renderizado adicionales en esta función. Se agregarán como atributos HTML en la etiqueta del script. Las opciones de renderización incluyen:

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

Reescribe la URL de la imagen almacenada en el Administrador de archivos a una URL que redimensionará la imagen a petición. La función acepta un parámetro obligatorio y cinco opcionales. Se debe pasar al menos un parámetro opcional.

Requerido

• URL: cadena, URL de una imagen alojada en HubSpot.

Opcional

• width: número, la nueva anchura de la imagen en píxeles.
• height: número, la nueva altura de la imagen en píxeles.
• length: número, la nueva longitud del lado mayor, en píxeles.
• upscale: booleano, utiliza las dimensiones de la imagen redimensionada incluso si escalan la imagen original (las imágenes pueden aparecer borrosas).
• upsize: booleano, devuelve la imagen redimensionada aunque sea mayor que la original en bytes.

Invierte el orden de los elementos de una lista. No toma ningún parámetro. Para invertir un objeto o devolver un iterador para iterar sobre la lista en sentido inverso, utiliza |reverse

Establece el código de respuesta como el código especificado. 404 es el único código admitido por ahora. Cuando se utiliza esto, tu página devolverá un error 404.

Vuelve el inicio de hoy (12:00am). Opcionalmente puedes agregar un parámetro para cambiar la zona horaria de la UTC predeterminada.

Convierte una marca de tiempo UNIX a la hora local, basándose en tu configuración de informes de HubSpot. A continuación, puedes aplicar un filtro datetimeformat para formatear la fecha.

Devuelve un dict de HubL que representa el grupo de temas asociado a un contenido (determinado por el id de contenido pasado), incluyendo metadatos sobre la página pilar asociada, el tema central y los temas secundarios. Puede utilizarse para "autoenlazar" un contenido con su página pilar asociada [si existe].

Los metadatos disponibles se encuentran en: attachableContent (los metadatos del contenido actual), topic (los metadatos del tema asociado al contenido actual), coreTopic (los metadatos del tema central del conjunto asociado), y pillarPage (los metadatos de la página del pilar asociado).

Utiliza {{ topicCluster|pprint }} para ver una presentación completa de las propiedades/atributos disponibles.

La función de truncamiento trabaja igual que el filtro truncar pero utiliza la sintaxis de la función en lugar de la del filtro. El primer parámetro especifica la cadena. El segundo parámetro especifica la longitud a la que se debe truncar. El último parámetro especifica los caracteres que se agregarán cuando se produzca el truncamiento.