HubLフィルター

フィルターはHubLの最終出力に影響を与えます。さまざまなHubL文と式にフィルターを適用することで、サーバーから出力されるテンプレートマークアップを変更できます。

フィルターの基本構文は|filternameです。フィルターは文または式のすぐ後に、区切り記号で囲んで追加します。パラメーターを括弧内に追加指定できるフィルターもあります。文字列パラメーター、数値パラメーター、ブールパラメーターを含むフィルターの基本構文は、|filtername("stringParameter", 10, true)です。文字列パラメーターについては、引用符で囲む必要があることに注意してください。また、HubLフィルターにはエイリアスが存在し、それをプライマリーフィルターと同じ目的に使用できます。

サポートされる全てのHubLフィルターを以下に示します。

数値の絶対値を取得します。このフィルターを使用すると、常に正の数値が得られます。

以下の例では、一連のフルーツの種類からなるシーケンスが変数に格納されています。batchフィルターは、シーケンスを反復処理するループに適用します。ネストされたループが3回実行されて行ごとに3種類のフルーツを出力した後、外側のループが再び実行されます。フルーツが5種類しかないので、最終的な出力では最後の項目が&nbsp（2番目のパラメーター）に置き換えられる点にご注目ください。

以下の例では、空白が除去されないようにpreタグ内の変数にcenterフィルターを適用しています。

HTML属性入力の内容をエスケープします。文字列を受け入れ、文字&、<、‘、”、およびescape_jinjavaをHTMLで安全に使用できる文字列に変換します。このフィルターは、HTML属性に追加されるHubL変数に使用します。

hrefなどの、URLを受け入れる属性の値をエスケープする場合は、代わりにescape_urlフィルターを使用する必要があることに注意してください。

地上の2地点間の楕円2D距離を計算します。

groupbyフィルターは、共通の属性を基準に、一連のオブジェクトをグループ化します。パラメーターで、グループ化の基準となる共通属性を設定します。

indentフィルターは空白を使用して、特定のフィールド長の範囲内でテキストのインデントを設定します。ここには説明上記載していますが、HubSpotのHTMLコンパイラーでは空白が自動的に除去されるので、このフィルターは推奨されることもなく、特に有効でもありません。以下の例では、空白が除去されないようにpreタグ内の変数にcenterフィルターを適用しています。最初のパラメーターは空白の量を制御し、2番目のブール値は第1行をインデントするかどうかを切り替えます。

値を整数に変換します。正常に変換できない場合は0が返されます。この既定の動作は最初のパラメーターを使用することで変更できます。

このフィルターは、2つのセットまたはリストの共通部分を返します。フィルターから返されるリストには、両方のリストに含まれる一意の要素が全て格納されます。

値が有効なIPv4またはIPv6アドレスの場合には、trueと評価されます。

シーケンスの文字列を連結した1つの文字列を返します。要素間は既定では空文字列で区切られますが、任意のパラメーターで区切り文字を定義できます。2番目のパラメーターを使用すると、結合する属性を指定できます。

シーケンスの最後の項目を返します。

シーケンスまたはマッピング内の項目数を返します。

数値を変換して1つのリストにします。文字列の場合は、文字のリストが返されます。シーケンスに文字列を追加するには、それをシーケンス区切り[ ]と共に文字列変数に追加します。

数値の自然対数を計算します。

値を全て小文字に変換します。

オブジェクトのシーケンスにフィルターを適用するか、属性を検索します。オブジェクトのリストを扱い、その中の特定の値にだけ対象を絞り込む際に便利です。

基本的な使用法は、属性に対するマッピングです。例えば、ディクショナリーの特定の属性に特定の値が存在するかどうかを検査する条件付きロジックを使用する場合です。または、フィルター名と引数を渡してフィルターを起動することもできます。

特定のオブジェクトのmd5ハッシュを計算します

日時オブジェクトで一定の時間を差し引きます。

1つの値を数値で乗算します。*演算子と同様に機能します。

日時オブジェクトに一定の時間を加えます。

変数を整形して出力します。変数の型など、デバッグに役立つ情報を出力します。

シーケンスからランダムな1つの項目を返します。

正規表現パターンを検索して、文字シーケンスで置換します。最初の引数はRE2形式の正規表現パターン、2つ目は置換文字列です。

RE2正規表現の構文については、こちらをご覧ください。

オブジェクトに式による検証を適用して、該当する要素を拒否することにより、オブジェクトのシーケンスをフィルタリングします。

オブジェクトの属性を検証して該当する要素を拒否することにより、オブジェクトのシーケンスをフィルタリングします。 

HubLを含む文字列を早期にレンダリングして、出力を他のフィルターに渡すことができるようにします。

部分文字列の全てのインスタンスを、新しいものに置換します。 

オブジェクトを反転します。または、オブジェクトを逆順に反復処理するイテレーターを返します。リストを反転するには.reverse()を使用します

値の平方根を計算します。

数値を特定の精度に丸めます。

値に「セーフ」のマークを付けます。つまり、自動エスケープが有効になっている環境で、この変数はエスケープされません。

リッチ テキスト コンテンツの出力用にHTML入力のコンテンツをサニタイズ処理をします。文字列を受け入れ、許可されていないHTMLタグを削除します。HTMLで使用されており、安全なHTMLを許可するHubL変数に、このフィルターを使用します。

このフィルターを使用する場合、HTMLタグの特定のタイプを許可するために次のパラメーターを含めることができます：FORMATTING、BLOCKS、STYLES、LINKS、TABLES、IMAGES。例えば、sanitize_html(IMAGES)などです。

sanitize_htmlを使用すると、フィルターに全てのパラメーターが含まれます。

STRIPパラメーターを含めて、全てのHTMLを削除することもできます。全てのコンテンツは、ネストされた解釈を防ぐためにescape_jinjavaを介しても実行されます。

オブジェクトを検証して該当する要素だけを選ぶことにより、オブジェクトのシーケンスをフィルタリングします。

オブジェクトの属性を検証して該当する要素だけを選ぶことにより、オブジェクトのシーケンスをフィルタリングします。

シーケンス内の反復の順序をランダムにします。以下の例は、標準的なブログのループをシャッフルします。

イテレーターをスライスして、これらの項目を含むリストの一覧を返します。最初のパラメーターにはスライスされる項目数を指定し、2番目のパラメーターには空のスライスに埋める文字を指定します。

反復可能データを並べ替えます。このフィルターを使ってHubSpotの属性を基準に並べ替える際には、全てのパラメーターが必要になります。最初のパラメーターは、並べ替え順序を逆にするブール値です。2番目のパラメーターは、並べ替えの際に大文字と小文字を区別するかどうかを指定します。最後のパラメーターは、並べ替え基準にする属性を指定します。以下の例ではブログ内の記事が、名前のアルファベット順でレンダリングされます。

入力文字列を特定の区切り文字で分割して、リストにします。最初のパラメーターは、変数を分割する区切り文字を指定します。2番目のパラメーターは、変数の分割回数を決定します。残りの項目（ある場合）はグループ化されたままになります。以下の例では、複数の名前からなる1つの文字列が「;」を基準に最初の4回だけ分割されます。

他の型の変数を文字列に変換します。以下の例では、整数が文字列に変換されます（変数の型の変化を確認するためにpprintを使用しています）。

SGML/XMLタグを除去して、隣接する空白を1つのスペースで置換します。このフィルターは、変数内のHTMLタグを除去する際に使用できます。

日時文字列と日時書式を変換して、日時オブジェクトにします。

シーケンス内の数値を全て合算します。最初のパラメーターには任意の属性を指定し、2番目のパラメーターには、変数内に加算するものがない場合に返す値を設定します。

このフィルターは、2つのセットまたはリストの対称差を返します。フィルターから返されるリストには、最初のリストに含まれ、2番目には含まれない一意の要素、または2番目のリストに含まれ、最初には含まれない一意の要素が全て格納されます。

見出し表記の値を返します。つまり、単語の先頭が大文字に、残りの文字は全て小文字になります。

オブジェクトをJSON文字列として書き出します。

先頭および末尾にある空白を除去します。このフィルターは説明上記載していますが、HubSpotでは標準でマークアップから前後の空白が削除されます。

特定の文字数よりも後ろにあるテキストを切り捨てます。既定は255文字です。このカウントにはHTML文字が含まれることに注意してください。長さは最初のパラメーターで指定し、既定は255文字です。2番目のパラメーターがtrueの場合、この長さでテキストが切り捨てられます。それ以外の場合は、最後の単語が破棄されます。テキストが実際に切り捨てられた場合、省略記号（...）が付加されます。...とは別の省略記号を使用する場合は、3番目のパラメーターに指定できます。

htmlマークアップを考慮しながら（つまり、ネストしている全てのタグが適切に閉じられ）、特定の文字列を切り捨てます。これにより、切り捨て後にタグが開いたままになることが防止されます。HTML文字は、合計文字数にカウントされません。このフィルターには長さパラメーターと切り捨て記号パラメーターがあります。3番目のブール値パラメーター（任意）には、長さで単語を切り離すかどうかを指定します。単語の長さを保持する目的で、このパラメーターは既定でfalseになっています。任意のパラメーターのうち1つだけを使用する場合は、例えばtruncatehtml(70, breakwords = false)のようにキーワード引数を使用します。

このフィルターは、2つのセットまたはリストの和集合を返します。フィルターから返されるリストには、いずれかのリストに含まれる一意の要素が全て格納されます。

このフィルターは、オブジェクトのシーケンスまたはディクショナリーから一意のセットを抽出します。（関数から戻される記事リストなどの）ディクショナリーをフィルタリングする場合、どの属性を基準にディクショナリー項目の重複を排除するかを指定できます。

このフィルターは日時オブジェクトをUnixタイムスタンプに変換します。

値を全て大文字に変換します。

文字列をエスケープしてUTF-8形式でURLエンコードします。ディクショナリーと通常の文字列、およびペアワイズ反復を受け入れます。

エンコードされたURL文字列を元のURLにデコードします。ディクショナリーと通常の文字列、およびペアワイズ反復を受け入れます。

プレーンテキスト内のURLを、クリック可能なリンクに変換します。追加的な整数をこのフィルターに渡した場合、URLがその長さに短縮されます。2番目のパラメーターは、リンクをrel="no follow"にするかどうかを指示するブール値です。最後のパラメーターでは、リンクを新しいタブで開くかどうかを指定できます。

文字列内の単語数をカウントします。

指定された文字数で折り返します。HubSpotでは既定で空白が除去されるため、この機能は<pre>で特に役立ちます。

ディクショナリー内の項目に基づいてHTML/XML属性文字列を作成します。「値なし」および未定義値を除き、
全ての値が自動的にエスケープされます。最初のパラメーターがfalseの場合以外は、フィルターから返された項目の前に自動的にスペースが追加されます。