HubL関数

HubLの関数は、パラメーターを受け入れて値を生成するという点でフィルターに似ています。ただし、全ての関数を初期テンプレート値に適用する必要はありません。HubLの関数は、HubSpot環境の他の領域と相互作用するためです。

古いウェブサイトを維持している場合は、非推奨となったHubL関数のリストもご確認ください。

この記事では、各HubL関数とその構文についての詳細を確認できます。

リストの末尾に1つの項目を追加します。

blog_all_posts_url関数は、指定されたブログ内の全てのブログ記事のリストページを指す完全なURLを返します。 

以下の例は、この関数をアンカーのhrefとして使用する方法を示しています。

blog_author_url関数は、指定されたブログ執筆者のリストページを指す完全なURLを返します。

以下の例は、この関数をアンカーのhrefとして使用する方法を示しています。これをblog_authors関数と組み合わせる例については、blog_authors関数の説明を参照してください。

blog_authorsは、指定されたブログのブログ執筆者オブジェクトからなるシーケンスを、スラッグの昇順に並べ替えて返します。このシーケンスを変数の中に保存して反復処理すると、カスタム執筆者記事フィルターを作成できます。

各執筆者による公開中の記事の数にアクセスするには、author.live_postsを使用できます。

以下の例の第1行は、この関数によって執筆者オブジェクトのシーケンスがどのように返されるかを示しています。例の残りの部分では、シーケンスを変数の中に保存し、執筆者オブジェクトを反復処理して執筆者オブジェクトのリンクをいくつか出力する例を示しています。この例では、ブログに4人の執筆者がいることを想定しています。

blog_by_id関数はID別にブログを返します。以下のコード例は、この関数を使ってハイパーリンクされたリスト項目を生成する方法を示しています。

blog_page_link関数は、ページ番号付きのブログリスト表示のURLを生成します。この関数は1つの数値パラメーターを受け入れ、これによって現在のページ、次のページ、前のページ、または特定のページのリンクを生成できます。この関数は通常、ページ番号付きアンカータグのhref属性で使用され、ブログ一覧テンプレートでこの関数を使用する必要があります。

以下に示す例では、アンカーhrefとしてこの関数を使用しています。最初の例では、現在のページを出力します。2番目の例では、第7ページを指定する数値7をパラメーターとして受け入れています。3番目の例では、現在のページからの相対ページ番号のリンクを生成する目的でnext_page_num変数を使用しています（前のページを指定するにはlast_page_num変数を使用できます）。最後の例では、current_page_num変数と+演算子を使用して、現在のページより4つ大きい番号へのリンクを作成しています。

blog_popular_posts関数は、特定数の人気のある記事をシーケンスとしてレンダリングします。この記事シーケンスを変数の中に保存することができ、forループでそれを反復処理すると、人気のある記事を示すカスタム記事リストを作成できます。 

この関数の結果は6時間キャッシュされます。キャッシュを使用せずにHubLでブログ記事を取得するには、代わりにblog_recent_tag_postsを使用することをお勧めします。

以下のサンプルコードでは、最初の行にこの関数でシーケンスを取得する方法が示されています。シーケンスは変数として保存されます。以下のコードでは、変数を使用してシーケンスをループ処理しています。ブログ記事の変数では例外なく、contentではなく個々のループ項目の名前を使用する必要があります。この例では、pop_post.nameが使用されています。この手法は、ブログテンプレートやウェブサイトページに対して使用できます。

blog_post_archive_url関数は、指定されたブログ上の特定の日付値に関するアーカイブリストページの完全なURLを返します。この関数には2つの必須パラメーターと2つの任意指定パラメーターがあります。最初のパラメーターはブログIDまたは単純なキーワード"default"です。2番目は、どの年のアーカイブされた記事を表示するかを指定します。

任意指定パラメーターには、それぞれどの月および日のアーカイブされた記事を表示するかが格納されます。

以下の例は、この関数をアンカーのhrefとして使用する方法を示しています。

blog_recent_author_posts関数は、指定された執筆者のブログ記事オブジェクトからなるシーケンスを、新しい順に並べ替えて返します。この記事シーケンスを変数の中に保存することができ、forループでそれを反復処理すると、特定の執筆者のカスタム記事リストを作成できます。 

この関数は3つのパラメーターを受け入れます。最初のパラメーターはどのブログから執筆者の記事を収集するかを指定します。値は"default"、または（ブログダッシュボードのURLで取得できる）特定のブログのIDです。2番目のパラメーターは、どの執筆者を使用するかを指定します。このパラメーターでcontent.blog_post_author.slugを使用すると、現在の記事の執筆者が指定されます。または、"brian-halligan"などのハイフン付きの小文字の名前を受け入れることもできます。3番目のパラメーターは取得する記事数を指定します。 

以下の例の第1行は、関数がどのように執筆者の記事シーケンスを返すかを示しています。この例では、執筆者名を正確に指定する代わりに現在の記事執筆者が使用されています。シーケンスは1つの変数に保存され、ループ処理されます。ブログ記事変数では、contentではなく個々のループ項目の名前を使用する必要があります。この例ではauthor_post.nameが使用されています。この手法はブログテンプレートとページテンプレートで使用できます。

blog_recent_posts関数は、指定されたブログでのブログ記事オブジェクトからなるシーケンスを、新しい順に並べ替えて返します。この記事シーケンスを変数の中に保存することができ、forループでそれを反復処理すると、人気のある記事を示すカスタム記事リストを作成できます。 

この関数は2つのパラメーターを受け入れます。最初のパラメーターは、どのブログから人気のある記事を収集するかを指定します。値は"default"、または（ブログダッシュボードのURLで取得できる）特定のブログのIDです。2番目のパラメーターは取得する記事数を指定します。 

以下の例の第1行は、関数がどのようにシーケンスを返すかを示しています。シーケンスは1つの変数に保存され、ループ処理されます。ブログ記事の変数では例外なく、contentではなく個々のループ項目の名前を使用する必要があります。この例ではrec_post.nameが使用されています。この手法は、ブログテンプレートだけでなく通常のページに対しても使用できます。

blog_recent_tag_posts関数は、指定されたタグ（複数可）のブログ記事オブジェクトからなるシーケンスを、新しい順に並べ替えて返します。この記事シーケンスを変数の中に保存することができ、forループでそれを反復処理すると、特定のタグのカスタム記事リストを作成できます。

この関数は3つのパラメーターを受け入れます。最初のパラメーターは、どのブログから記事を収集するかを指定します。値は"default"、または（ブログダッシュボードのURLで取得できる）特定のブログのIDです。

2番目のパラメーターはどのタグを使用するかを指定します。1つのタグ、またはカンマで区切った最大10個のタグの配列を指定できます。このパラメーターでは、content.tag_listからの特定のタグを示すtag.slugを使用できます。または"marketing-tips"などのハイフン付きの小文字の名前を受け入れることもできます。タグ名のスペースはハイフンに変換する必要があります。

3番目のパラメーターは取得する記事数を指定します。 

以下の例の第1行は、関数がどのようにタグの記事シーケンスを返すかを示しています 。第2行で使われている関数は、後でループ処理する目的でシーケンスを変数に保存します。ブログ記事の変数では例外なく、contentではなく個々のループ項目の名前を使用する必要があります。この例ではtag_post.nameが使用されています。この手法は、ブログテンプレートだけでなく通常のページに対しても使用できます。 

個々のブログ記事レイアウトの関連記事セクションの基礎として、この関数を使用できます。関連する記事セクションの作成については、こちらのチュートリアルをご覧ください。

blog_tag_url関数は、指定されたブログタグのリストページを指す完全なURLを返します。

この関数は2つのパラメーターを受け入れます。最初のパラメーターは、そのタグのリストページがどのブログ内に存在するかを指定します。2番目のパラメーターは、どのタグにリンクするかを指定します。このパラメーターでは、content.topic_listからの特定のタグを示すtopic.slugを使用できます。または"marketing-tips"などのハイフン付きの小文字の名前を受け入れることもできます。

以下の例は、この関数をアンカーのhrefとして使用する方法を示しています。

blog_tags関数は、（関連するブログ記事数に基づき）指定したブログに関連する特によく使用される250個のタグのシーケンスを、ブログ記事カウントで並べ替えて返します。

このシーケンスを変数の中に保存して反復処理すると、カスタムタグ記事フィルターを作成できます。各タグの記事数にアクセスするには、tag.live_postsを使用できます。

この関数は2つのパラメーターを受け入れます。最初のパラメーターは、どのブログからタグを取得するかを指定します。2番目のパラメーターは、取得されるタグ数の上限を設定します。

以下の例の第1行は、関数がどのようにタグオブジェクトのシーケンスを返すかを示しています。例の残りの部分では、シーケンスを変数の中に保存し、タグオブジェクトを反復処理して執筆者タグのリンクをいくつか出力する例を示しています。この例では、ブログに4つのタグがあることを想定しています。 

この関数は、指定されたブログでの公開済み記事の総数を返します。パラメーターを指定しない場合、既定のブログ記事をカウントします。あるいは、"default"を指定したり、カウントする別のブログのIDを指定することもできます。ブログIDは、特定のブログのブログダッシュボードのURLで得られます。

ある変数がリスト内に出現する回数を返します。

レコードID、関連付けカテゴリー、関連付け定義IDによって別のレコードに関連付けられているCRMレコードのリストを取得します。

この関数は、オブジェクトおよび属性has_more、total、offset、resultsを返します。

• has_moreは、このバッチに含まれるよりも多い結果が存在することを示しています（total > offset）。
• totalは、得られる結果の総数です。
• offsetは、この次の結果バッチに使用されるオフセットです。
• resultsは、関数のパラメーターに一致する特定の関連オブジェクトからなる配列を返します。

クエリーまたはIDを使用して1つのCRMレコードを取得します。レコードは、プロパティーと値からなるディクショナリーとして返されます。

この関数はカスタムオブジェクトおよびインテグレーターオブジェクトで使用することもできます。

特定のオブジェクトタイプのレコードをHubSpot CRMから取得して一覧表示します。

この関数は、オブジェクトおよび属性has_more、total、offset、resultsを返します。

• has_moreは、このバッチに含まれる結果以外の結果も存在することを示しています（total > offset）。
• totalは、返された結果の総数です。
• offsetは、この次の結果バッチに使用されるオフセットです。
• resultsは、関数のパラメーターに一致する特定のオブジェクトからなる配列を返します。

指定したオブジェクトタイプとプロパティー名のプロパティー定義を取得します。

サポート対象のオブジェクトタイプは、HubSpot標準オブジェクト（コンタクトなど）、ポータル固有のオブジェクト、インテグレーターオブジェクトです。

指定されたオブジェクトタイプと一連のプロパティー名のプロパティー定義を取得します。

サポート対象のオブジェクトタイプは、HubSpot標準オブジェクト（コンタクトなど）、ポータル固有のオブジェクト、インテグレーターオブジェクトです。

CTAモジュールには、コードバリエーションを含むパラメーターが多数あるので、cta関数を使用するとテンプレート、ページ、Eメールの中に特定のCTAを簡単に生成できます。リッチテキストエディターを使ってCTAを追加するとき、エディターはこの関数を使用します。

反復可能オブジェクトの全ての項目を付加することで、リストを拡張します。言い換えると、あるリストの全ての項目を別のリストに挿入します。

この関数は、IDを基準にファイルのメタデータを返します。唯一のパラメーターとして、検索するファイルを示す数値IDを受け入れます。

アカウントで設定されているソーシャル メディア アカウントへのリンクを返します。既定のfollow_meモジュールで使用されます。 

コンテキストのロケールに基づいて住所を書式設定します。 

必要に応じて、日本語の敬称を追加して会社名を書式設定します。

format_datetime HubLフィルターと同様に、日付オブジェクトの日付と時刻の両方のコンポーネントを書式設定します。この関数は、非推奨のdatetimeformat関数に置き換わるものです。

この関数には4つのパラメーターがあり、地球上の2地点間の楕円2D距離を計算します。この関数は、HubDBデータを取得するためのフィルタークエリーとして使用します。

この関数は、指定したテンプレートまたはコードファイルの公開URLを返します。この関数のパラメーターは、デザインマネージャー内でのアセットのパスです。コードファイルURLは、公開されるたびに更新されます。したがって、この関数を使用すると常にファイルの最新バージョンを使用していることを確認できます。

ファイルを右クリックして［公開URLをコピー］を選択するか、［アクション］をクリックして［公開URLをコピー］を選択することで、アプリ内でこの関数を自動的に生成できます。

以下の例では、デザインマネージャーで作成されたJavaScriptファイルのURLを取得します。これを<script>タグのsrcとして含めることができます。

この関数の動作はget_public_template_urlと同様で、指定したテンプレートまたはコードファイルの公開URLを返します。唯一の違いは、この関数のパラメーターがデザインマネージャー内でのパスではなく、テンプレートIDであることです（このIDはテンプレートまたはコードファイルのURLで判別できます）。

HubDBは、CMS Hub ProfessionalおよびEnterpriseでご利用いただける機能です。

テーブルの名前、列、最終更新日などの情報を取得するには、hubdb_table()関数を使用できます。 

適切な属性を呼び出すことで、次のような情報を取得できます。

• ID：テーブルのID。
• name：テーブルの名前。
• columns：列情報のリスト。
• created_at：テーブルが初めて作成された時点のタイムスタンプ。
• published_at：このテーブルが公開された時点のタイムスタンプ。
• updated_at： このテーブルの最終更新時点のタイムスタンプ。
• row_count：テーブルの行数。

HubDBは、CMS Hub ProfessionalおよびEnterpriseでご利用いただける機能です。

hubdb_table_column関数を使用すると、テーブルの列に関する情報（ラベル、タイプ、オプションなど）を取得できます。この関数は2つのパラメーターを受け入れます。 

適切な属性を呼び出すことで、列に関する次のような情報を取得できます。

• ID：列のID。
• name：列の名前。
• label：列に使用されるラベル。
• type：列のタイプ。
• options：タイプがselectの列の場合、これはoptionIdからoption情報へのマップです。
• foreignIds："foreignId"列タイプの場合、これはforeignIdのリストです（idプロパティーとnameプロパティーを含む）。

上記の属性に加えて、getOptionByName("<option name>")というメソッドを呼び出すこともできます。"select"タイプの列の場合、これによりオプションの名前を基準にoption情報が取得されます。

HubDBは、CMS Hub ProfessionalおよびEnterpriseでご利用いただける機能です。

hubdb_table_row関数を使用すると、HubDBテーブルから1つの行を取得できます。この行に関して、該当する属性を呼び出すことで各テーブルセルから次のような情報を取得できます。 

• hs_id：この行のグローバルに固有のID。
• hs_created_at：この行が作成された時点を示すタイムスタンプ。
• hs_path：動的ページで使用される場合、この文字列はページのURLパスの最後のセグメントです。
• hs_name：動的ページで使用される場合、これはページのタイトルです。
• <column name>または["<column name>"]：列のnameを基準に、この行の列の値を取得します。

HubDBは、CMS Hub ProfessionalおよびEnterpriseでご利用いただける機能です。

hubdb_table_rows関数を使用すると、反復処理用にHubDBテーブルの行のリストを取得できます。hubdb_table_rows()の1回の呼び出しでは、1ページあたり10件のテーブルスキャンに制限されています。

既定では、この関数は最大1,000行を返します。これよりも多くの行を取得するには、以下のコードに示されているようにクエリー内でlimitを指定します。

この関数は、プライマリーCSSファイル（default_custom_style.min.css）を参照するリンクタグを生成します。このファイルはグローバルCSSファイルとして用意され、全てのテンプレートにこれを追加できます。この関数によってレンダリングするには、ブール値パラメーターの値Trueが必要です。

0ベースのarrayの中で最初にマッチする項目の所在地を返します。

この関数は3つのパラメーターを受け入れ、最初のパラメーターは必須です。最初のパラメーターは、array内で検索される項目です。2番目（start）と3番目（end）のパラメーターを使用すると、arrayのスライス内でその項目を検出できます。 

リスト内の指定されたインデックス場所に要素を挿入します。

この関数は次の2つのパラメーターを受け入れます。

• Index：要素を挿入する位置。
• Element：挿入される項目。

言語コードを判読可能な文字列表記として返し、オプションでターゲット言語に翻訳します。

詳細メニューの、ネストしたリンク構造を返します。メニューノードには、返されたオブジェクトで使用できるさまざまなプロパティーがあります。nullをメニュー関数に渡した場合、空のpylistが返されます。名前でメニューを指定することもできます。ほとんどの場合、メニューIDを使用するのが安全です。名前を変更してもIDには影響しないからです。マーケットプレイス用にビルドする場合は、メニューがnullである場合、既定で"default"にするのが理にかなっています。

［リンク済みファイル］>［その他のファイル］によってカスタムモジュールに付加されるアセットのURLを取得します。

この関数は、レンダリングされるCSSファイルをhead要素に追加します。全てのCSS linkタグは一緒のグループになり、JavaScriptタグの前にレンダリングされます。HubLは空の行に置換され、その後でlinkタグが{{ standard_header_includes }}に追加されます。ここでは絶対URLが必要とされます。get_asset_url()関数を使用することで、既知の相対URL付きのCMSコンテンツを要求できます。

styleタグ要素を介して、レンダリングされるインラインスタイルをheadに含めるには、styleタグとその中のCSSの代わりに{% require_css %}および{% end_require_css %}タグを使用してください。

2番目のパラメーターは、生成されるタグを変更するためのオプションのディクショナリーです。web.devの記事で紹介されているasync（true/false）がサポートされます。その他のキーと値のペアは、HTML属性としてスタイルタグに追加されます。

headまたはfooterでのレンダリングのために、スクリプトをキューに登録するかどうかを指定します（既定）。レンダリングする位置を指定するため、headパラメーターまたはfooterパラメーターをインクルードします。HubLは空の行に置換され、ヘッダーまたはフッターのインクルードのいずれかにインクルードされます。

script要素を使用してフッターにレンダリングされるインラインスクリプトをキューに登録するには、<script>タグを{% require_js %}と{% end_require_js %}で囲みます。 

この関数には追加のレンダリングオプションを含めることもできます。これらはスクリプトタグにHTML属性として追加されます。レンダリングオプションには次のものがあります。

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

ファイルマネージャーに保存された画像のURLを書き換えて、リクエスト時に画像のサイズを変更するURLにします。この関数は1つの必須パラメーターと5つの任意指定パラメーターを受け入れます。少なくとも1つの任意指定パラメーターを渡す必要があります。

必須

• URL：HubSpotでホスティングされている画像のURL（文字列）。

任意

• width：画像の新しい幅（ピクセル単位の数値）。
• height：画像の新しい高さ（ピクセル単位の数値）。
• length：画像の新しい長辺（ピクセル単位の数値）。
• upscale：画像の元の寸法よりも拡大される場合でもサイズ変更後の寸法を使用するかどうかを示すブール値（画像がぼやけて表示される可能性があります）。
• upsize：元のバイト数よりも増える場合でもサイズ変更後の画像を返すかどうかを示すブール値。

リスト内の項目の順序を逆にします。パラメーターは取りません。オブジェクトを逆にするか、リスト内を逆に反復処理するイテレーターを返すには、|reverseを使用します。

レスポンスコードを、指定されたコードに設定します。現在、指定できるコードは404だけです。これを使用すると、ページから404エラーが返されます。

今日の始まり（午前0:00）を返します。タイムゾーンを既定のUTCから変更するパラメーターを追加できます（任意）。

HubSpotレポート設定に基づいて、UNIXタイムスタンプをローカル時間に変換します。その後、datetimeformatフィルターを適用して日付を書式設定できます。

（渡されたコンテンツIDで判別される）コンテンツ部分に関連しているトピッククラスターを表すHubLディクショナリーを返します。これには、関連付けられているピラーページ、コアトピック、サブトピックについてのメタデータが含まれます。これを使用すると、関連ピラーページが存在する場合、それをコンテンツ部分に「自動リンク」させることができます。

取得可能なメタデータがある場所は、attachableContent（現在のコンテンツのメタデータ）、topic（現在のコンテンツの関連トピックメタデータ）、coreTopic（関連クラスターのコアトピックメタデータ）、およびpillarPage（関連ピラーページのメタデータ）です。

可能なプロパティーと属性を全て表示するには、{{ topicCluster|pprint }}を使用してください。

truncate関数の動作はtruncateフィルターとまったく同じですが、フィルター構文ではなく関数構文を使用します。最初のパラメーターは、文字列を指定します。2番目のパラメーターは、どこで切り捨てるかを長さで指定します。最後のパラメーターは、切り捨てが発生した場合に追加する文字を指定します。