HubSpotのCMS開発者向けのHubLフィルターの一覧と例。
|filtername
です。フィルターは文または式のすぐ後に、区切り記号で囲んで追加します。パラメーターを括弧内に追加指定できるフィルターもあります。文字列、数値、およびブール値のパラメーターを使用するフィルターの基本構文は、|filtername("stringParameter", 10, true)
です。文字列パラメーターについては、引用符で囲む必要があることに注意してください。また、HubLフィルターにはエイリアスが存在し、それをプライマリーフィルターと同じ目的に使用できます。
以下にて、サポートされる全てのHubLフィルターを示します。
content.absolute_url
など、ディクショナリーに含まれる変数を出力する機能と同等です。
パラメーター | 説明 |
---|---|
attribute_name | どの属性を出力するかを指定します |
batch
フィルターは、シーケンスを反復処理するループに適用されます。入れ子ループが3回実行され、行ごとに3種類のフルーツを出力した後、外側のループが再び実行されます。フルーツが5種類しかないので、最終的な出力では最後の項目が
(2番目のパラメーター)に置き換えられる点にご注目ください。
パラメーター | タイプ | 説明 |
---|---|---|
linecount | 数値 | バッチに含める項目の数。 |
fill_with | 文字列 | 項目の欠落がある場合に何で埋めるかを指定します。 |
パラメーター | タイプ | 説明 |
---|---|---|
end | 日時オブジェクト | 終了日時オブジェクト。 |
timeunit | 文字列 | 有効な時間単位は、nanos 、micros 、millis 、seconds 、minutes 、hours 、half_days 、days 、weeks 、months 、years 、decades 、centuries 、millennia 、eras です。 |
パラメーター | タイプ | 説明 |
---|---|---|
width | 数値 | テキストを中央揃えするための空白の長さを指定します。 |
パラメーター | タイプ | 説明 |
---|---|---|
characters_to_cut | 文字列 | 削除対象となる部分文字列。 |
true
に設定する必要があります。
以下の1つ目の例では、変数が未定義の場合にメッセージが出力されます。2つ目の例では、未定義ではない空の文字列にフィルターを適用していますが、2番目のパラメーターが原因でメッセージが出力されます。
パラメーター | タイプ | 説明 |
---|---|---|
default_value | 文字列 | 変数が未定義の場合に返される値。変数が定義されている場合は、変数の値が返されます。 |
truthy | ブール値 | false と評価される変数で使用するには、true に設定します。 |
パラメーター | タイプ | 説明 |
---|---|---|
case_sensitive | ブール値 | 並べ替えの際に大文字と小文字を区別するかどうかを指定します。 |
sort_by | "key" | "value" | key またはvalue のどちらを基準に並べ替えるかを指定します。 |
パラメーター | タイプ | 説明 |
---|---|---|
list | 配列 | 最初のリストとの差異を見つけるために比較する2番目のリスト。 |
パラメーター | タイプ | 説明 |
---|---|---|
divisor | 数値 | 変数を除算するための数値。 |
divisibleby
式評価の代わりになります。値を特定の数で割り切れる場合、trueと評価されます。
パラメーター | タイプ | 説明 |
---|---|---|
divisor | 数値 | 値を割り切れるかどうかを評価するために使用する数値。 |
&
、<
、>
、‘
、”
、およびescape_jinjava
文字をHTMLで安全に使用できるシーケンスに変換します。HTMLで使用されているものの、HTMLを許可しないHubL変数には、このフィルターを使用します。
&
、<
、‘
、”
、およびescape_jinjava
文字をHTMLで安全に使用できるシーケンスに変換します。このフィルターは、HTML属性に追加されるHubL変数に使用します。
href
など、URLを受け入れる属性の値をエスケープする場合は、代わりにescape_url
フィルターを使用してください。
{
および}
文字を、Jinjavaで安全に使用できるシーケンスに変換します。このような文字が含まれる可能性のあるテキストをJinjavaで表示する際にこのフィルターを使用します。
escape_jinjava
を含む)文字列をエスケープ処理します。このフィルターは、HTMLスクリプト要素内で使用されるHubL変数に使用します。
binary
パラメーターをtrue
に設定します。
パラメーター | タイプ | 説明 |
---|---|---|
binary | ブール値 | true に設定すると、Mebi(MiB)やGibi(GiB)などのバイナリープレフィックスが使用されます。 |
0.0
を返します。このデフォルトの動作は、最初のパラメーターを使用することで変更できます。
パラメーター | タイプ | 説明 |
---|---|---|
default | 数値 | 正常に変換できない場合に返される整数。 |
%s
を別の変数に置換できます。
パラメーター | タイプ | 説明 |
---|---|---|
locale | 文字列 | Javaローカル言語タグ(英語)。デフォルトはページのlocale.Format : ISO639LanguageCodeInLowercase-ISO3166CountryCodeInUppercase です。 |
currency | 文字列 | 通貨の英字のISO 4217コード。デフォルトは、ポータルのデフォルトの通貨です。数値コードは使用できません。 |
minDecimalDigits | 数値 | 出力に含める小数桁数の最小値。デフォルトで、通貨のデフォルトの小数桁数に設定されます。 |
maxDecimalDigits | 数値 | 出力に含める小数桁数の最大値。デフォルトで、通貨のデフォルトの小数桁数に設定されます。 |
パラメーター | タイプ | 説明 |
---|---|---|
format | 'short' | 'medium' | 'long' | 'full' | カスタムパターン | 使用する形式。Unicode LDML(英語)に従ったカスタムパターンを指定できます。 |
timeZone | 文字列 | IANA TZDB形式(英語)で出力される日付のタイムゾーン。 |
locale | 文字列 | ロケール対応の形式に使用するロケール。サポートされているロケールの一覧(英語)を参照してください。 |
パラメーター | タイプ | 説明 |
---|---|---|
format | 'short' | 'medium' | 'long' | 'full' | カスタムパターン | 使用する形式。Unicode LDMLに従うカスタムパターンを指定できます。long またはfull を使用する場合、タイムスタンプにはZが含まれ、オフセットがゼロであるUTC時間(つまり2:23:00 PM Z )を示します。Z指定子を削除するにはtimeZone を指定してください。 |
timeZone | 文字列 | IANA TZDB形式(英語)で出力される日付のタイムゾーン。デフォルトではUTC時間を返します。 |
locale | 文字列 | ロケール対応の形式に使用するロケール。サポートされているロケールの一覧(英語)を参照してください。 |
パラメーター | タイプ | 説明 |
---|---|---|
locale | 文字列 | 書式設定に使用するロケール。サポートされているロケールの一覧(英語)を参照してください。 |
maxDecimalDigits | 数値 | 出力に含める小数桁数の最大値。デフォルトでは、入力値の小数桁数を使用します。 |
パラメーター | タイプ | 説明 |
---|---|---|
format | 'short' | 'medium' | 'long' | 'full' | カスタムパターン | 使用する形式。Unicode LDMLに従うカスタムパターンを指定できます。long またはfull を使用する場合、タイムスタンプにはZが含まれ、オフセットがゼロであるUTC時間(つまり2:23:00 PM Z )を示します。Z指定子を削除するにはtimeZone を指定してください。 |
timeZone | 文字列 | IANA TZDB形式(英語)で出力される日付のタイムゾーン。デフォルトではUTC時間を返します。 |
locale | 文字列 | ロケール対応の形式に使用するロケール。サポートされているロケールの一覧(英語)を参照してください。 |
パラメーター | 説明 |
---|---|
attribute | グループ化の基準となる属性。 |
<pre>
タグ内の変数にindent
フィルターを適用しています。最初のパラメーターは空白の幅を制御し、2番目のブール値は最初の行をインデントするかどうかを切り替えます。
パラメーター | タイプ | 説明 |
---|---|---|
width | 数値 | 適用される空白の幅。 |
indent-first | ブール値 | true に設定すると、最初の行がインデントされます。 |
0
を返します。このデフォルトの動作は、最初のパラメーターを使用することで変更できます。
パラメーター | タイプ | 説明 |
---|---|---|
default | 数値 | 正常に変換できない場合に返される整数。 |
パラメーター | タイプ | 説明 |
---|---|---|
list | 整列 | 最初のリストとの共通部分を見つけるために比較される2番目のリスト。 |
true
と評価されます。
パラメーター | タイプ | 説明 |
---|---|---|
delimiter | 文字列 | 文字列の連結に使用する区切り文字。 |
attribute | HubL変数 | オブジェクト内で結合する値の属性。 |
[ ]
で囲まれていない限り、別々の文字として返されます。
パラメーター | タイプ | 説明 |
---|---|---|
base | 数値 | 対数計算に使用する基数。 |
パラメーター | タイプ | 説明 |
---|---|---|
filter | 文字列 | オブジェクトのシーケンスに適用するフィルター。 |
パラメーター | タイプ | 説明 |
---|---|---|
diff | 数値 | 差し引く数量。 |
timeunit | 文字列 | 有効な時間単位は、nanos 、micros 、millis 、seconds 、minutes 、hours 、half_days 、days 、weeks 、months 、years 、decades 、centuries 、millennia 、eras です。 |
パラメーター | タイプ | 説明 |
---|---|---|
diff | 数値 | 差し引く数量。 |
timeunit | 文字列 | 有効な時間単位は、nanos 、micros 、millis 、seconds 、minutes 、hours 、half_days 、days 、weeks 、months 、years 、decades 、centuries 、millennia 、eras です。 |
パラメーター | タイプ | 説明 |
---|---|---|
exp_text | 文字列 | オブジェクトに適用する式評価の名前。 |
パラメーター | タイプ | 説明 |
---|---|---|
attribute_name | 文字列 | 選択する属性を指定します。ドット表記を使用すると、ネストされた属性にアクセスできます。 |
exp_test | 文字列 | オブジェクトに適用する式評価の名前。 |
パラメーター | タイプ | 説明 |
---|---|---|
old | 文字列 | 置換の対象にする部分文字列。 |
new | 文字列 | 置換する文字列。 |
count | 数値 | 指定した場合、最初の出現数分のみが置換されます。 |
パラメーター | タイプ | 説明 |
---|---|---|
nth_root | 数値 | 計算に使用するn乗根。 |
パラメーター | タイプ | 説明 |
---|---|---|
precision | 数値 | 端数処理の精度を指定します。 |
rounding_method | 'common' (デフォルト) | 'ceil' | 'floor' | オプションには、common (四捨五入:デフォルト)、ceil (常に切り上げ)、floor (常に切り下げ)があります。 |
FORMATTING
、BLOCKS
、STYLES
、LINKS
、TABLES
、IMAGES
を含めることができます。例えば、sanitize_html(IMAGES)
です。
sanitize_html
を使用すると、全てのパラメーターがフィルターに含められます。
さらにSTRIP
パラメーターを含めると、全てのHTMLを削除できます。また、ネストされた解釈を防ぐ目的で、全てのコンテンツがescape_jinjava
を介して実行されます。
パラメーター | タイプ | 説明 |
---|---|---|
exp_text | 文字列 | オブジェクトを検証する式。 |
パラメーター | タイプ | 説明 |
---|---|---|
attribute_name | 文字列 | テストする属性。ドット表記を使用すると、ネストされた属性にアクセスできます。 |
exp_test | 文字列 | オブジェクトに適用する式評価の名前。 |
val | 文字列 | テストの対象となる値。 |
パラメーター | タイプ | 説明 |
---|---|---|
slices | 数値 | スライスされる項目の数。 |
filler | 文字列 | 空白のスライスに埋める文字を指定します。 |
パラメーター | タイプ | 説明 |
---|---|---|
reverse | ブール値 | 並べ替え順序を逆にするには、true に設定します。 |
case_sensitive | ブール値 | true に設定すると、並べ替えで大文字と小文字が区別されま。 |
attribute | 文字列 | 並べ替えの基準となる属性。リストを並べ替えるときには省略します。 |
;
を基準に最初の4回だけ分割されます。
パラメーター | タイプ | 説明 |
---|---|---|
character_to_split_by | 文字列 | 変数を分割する区切り文字を指定します。 |
number_of_splits | 数値 | 変数を分割する回数を指定します。残りの項目(存在する場合)は、グループ化されたままになります。 |
pprint
を使用しています)。
パラメーター | タイプ | 説明 |
---|---|---|
dateFormat | 文字列 | 使用する日付形式(英語)。 |
パラメーター | タイプ | 説明 |
---|---|---|
datetimeFormat | 文字列 | 使用する日付と時刻の形式(英語)。 |
パラメーター | タイプ | 説明 |
---|---|---|
attribute | 文字列 | 合計する属性。 |
return_if_nothing | 文字列 | 変数内に加算するものがない場合に返す値。 |
パラメーター | タイプ | 説明 |
---|---|---|
list | 整列 | 1つ目のリストとの対称差を見つけるために比較する2つ目のリスト。 |
パラメーター | タイプ | 説明 |
---|---|---|
number_of_characters | 数値 | テキストが切り捨てられる前の許容文字数。デフォルト値は255文字です。 |
breakword | ブール値 | true の場合、長さでテキストが切り捨てられます。false の場合は、最後の単語が除去されます。 |
end | 文字列 | 切り捨て後に付加されるデフォルトの記号「…」を変更します。 |
パラメーター | タイプ | 説明 |
---|---|---|
number_of_characters | 数値 | テキストが切り捨てられる前の許容文字数。デフォルト値は255文字です。 |
end | 文字列 | 切り捨て後に付加されるデフォルトの記号「…」を変更します。 |
breakword | ブール値 | ブール値。true の場合、長さでテキストが切り捨てられます。false (デフォルト)の場合は、最後の単語が除去されます。任意のパラメーターのうち1つだけを使用する場合は、例えばtruncatehtml(70, breakwords = false) のようにキーワード引数を使用します。 |
パラメーター | タイプ | 説明 |
---|---|---|
list | 整列 | 1つ目のリストに対して結合される2つ目のリスト。 |
パラメーター | タイプ | 説明 |
---|---|---|
attr | 文字列 | ディクショナリー値を絞り込む際に使用する属性を指定します。 |
September 30, 2024
を返します。パラメーター | タイプ | 説明 |
---|---|---|
shorten_text | 数値 | URLを指定の数に短縮する整数。 |
no_follow | ブール値 | true に設定すると、リンクにrel="no follow" が含まれます。 |
target="_blank" | 文字列 | リンクを新しいタブで開くかどうかを指定します。 |
striptags
フィルターを使用します。<pre>
で特に役立ちます。
パラメーター | 説明 |
---|---|
character_count | コンテンツを折り返す文字数。 |
パラメーター | タイプ | 説明 |
---|---|---|
autospace | ブール値 | 項目の前にスペースを追加するには、true に設定します。 |