📘 公式リファレンス🔧 リファレンス/フィルター初級

escape フィルター（HTML特殊文字をエスケープ）

文字列内の HTML 特殊文字（<、>、&、シングルクォート、ダブルクォートなど）をエスケープシーケンスに変換する。ユーザー入力やメタフィールドの値を安全に HTML として出力するときに使う。

用途

商品説明やレビュー本文など、ユーザーが入力したテキストをストア上に表示するとき。またはメタフィールドに保存された HTML タグ文字列をそのまま画面に表示させたくない場合に用いる。

設置場所

Liquid テンプレート内で `{{ value | escape }}` の形で使う。例えば `{{ product.description | escape }}` のように、出力の直前にフィルターを付ける。

注意点

escape フィルターはエスケープシーケンスを持たない文字には何もしない。複数のセキュリティ対策が必要な場合は escape だけでなく、JavaScript 埋め込み時には `json` フィルターも組み合わせるとよい。既に HTML エンコードされた文字列に再度 escape を適用すると二重エスケープが起こるため、入力元の処理状態を確認する。

タグ:escapehtmlsecuritystringoutput

仕様

30 行 / json

{
  "category": "string",
  "deprecated": false,
  "deprecation_reason": "",
  "description": "",
  "parameters": [],
  "return_type": [
    {
      "type": "string",
      "name": "",
      "description": "",
      "array_value": ""
    }
  ],
  "examples": [
    {
      "name": "",
      "description": "",
      "syntax": "",
      "path": "/",
      "raw_liquid": "{{ '&lt;p&gt;Text to be escaped.&lt;/p&gt;' | escape }}",
      "parameter": false,
      "display_type": "text",
      "show_data_tab": true
    }
  ],
  "summary": "Escapes special characters in HTML, such as `&lt;&gt;`, `'`, and `&amp;`, and converts characters into escape sequences. The filter doesn't effect characters within the string that don’t have a corresponding escape sequence.\".",
  "syntax": "string | escape",
  "name": "escape"
}

出典・ライセンス

Source:: Shopify/theme-liquid-docs/data/filters.json
Repository:: https://github.com/Shopify/theme-liquid-docs
License:: MIT

このコードは Shopify 著作の MIT ライセンスソースです。原本の著作権は Shopify が保有します。日本語訳は ALSEL によるものです。

escape フィルター（HTML特殊文字をエスケープ）

仕様

出典・ライセンス

関連項目

avatar フィルター（顧客アバター画像HTML生成）

default_errors フィルター（フォーム送信エラーを日本語化）

date フィルター（日付を指定形式でフォーマット）

payment_terms フィルター（Shop Pay分割払いバナーを生成）

abs フィルター（数値の絶対値を取得）

append フィルター（文字列の末尾に追加）