form_errors オブジェクト
form タグで作成したフォームのバリデーションエラーを格納するオブジェクト。エラーカテゴリ文字列と、対応するエラーメッセージ・フィールド名を取得できる。
仕様
76 行 / json{
"access": {
"global": false,
"parents": [
{
"object": "form",
"property": "errors"
}
],
"template": []
},
"deprecated": false,
"deprecation_reason": "",
"description": "The following table outlines the strings that can be returned and the reason that they would be:\n\n| Form property name | Return reason |\n| --- | --- |\n| `author` | There were issues with required name fields. |\n| `body` | There were issues with required text content fields. |\n| `email` | There were issues with required email fields. |\n| `form` | There were general issues with the form. |\n| `password` | There were issues with required password fields. |",
"properties": [
{
"deprecated": false,
"deprecation_reason": "",
"description": "You can access a specific message in the array by using a specific error from the `form_errors` array as a key.",
"examples": [],
"return_type": [
{
"type": "array",
"name": "",
"description": "",
"array_value": "string"
}
],
"summary": "The translated error messages for each value in the `form_errors` array.",
"name": "messages"
},
{
"deprecated": false,
"deprecation_reason": "",
"description": "You can access a specific field in the array by using a specific error from the `form_errors` array as a key.",
"examples": [],
"return_type": [
{
"type": "array",
"name": "",
"description": "",
"array_value": "string"
}
],
"summary": "The translated names for each value in the `form_errors` array.",
"name": "translated_fields"
}
],
"summary": "The error category strings for errors from a form created by a [`form` tag](/docs/api/liquid/tags/form).",
"name": "form_errors",
"examples": [
{
"name": "Output form errors",
"description": "You can output the name of the field related to the error, and the error message, by using the error as a key to access the `translated_fields` and `messages` properties.\n\n```liquid\n<ul>\n {% for error in form.errors %}\n <li>\n {% if error == 'form' %}\n {{ form.errors.messages[error] }}\n {% else %}\n {{ form.errors.translated_fields[error] }} - {{ form.errors.messages[error] }}\n {% endif %}\n </li>\n {% endfor %}\n</ul>\n```\n",
"syntax": "",
"path": "/",
"raw_liquid": "",
"parameter": false,
"display_type": "text",
"show_data_tab": true
}
],
"json_data": {
"path": "",
"handle": "",
"data_from_file": "{\"messages\":{},\"translated_fields\":{}}"
},
"return_type": [
{
"type": "array",
"name": "",
"description": "",
"array_value": "string"
}
]
}出典・ライセンス
- Repository:
- https://github.com/Shopify/theme-liquid-docs
- License:
- MIT
このコードは Shopify 著作の MIT ライセンスソースです。 原本の著作権は Shopify が保有します。日本語訳は ALSEL によるものです。
関連項目
content_for_header オブジェクト
Shopify が必要とするスクリプト(分析・チェックアウト・言語設定など)をすべて動的に出力するオブジェクト。theme.liquid の <head> タグ内に埋め込む必須要素。
metaobjects オブジェクト
ストア全体のメタオブジェクト定義にアクセスするグローバルオブジェクト。個別のメタオブジェクトはタイプとハンドルで参照でき、メタオブジェクト定義のエントリをループで反復処理できる。
additional_checkout_buttons オブジェクト
PayPal Express Checkout など、オフサイト決済に対応した外部決済プロバイダーがストアに設定されているかを真偽値で返す。`content_for_additional_checkout_buttons` と組み合わせて、該当するチェックアウトボタンを条件付きで表示する。
canonical_url オブジェクト
現在のページの正規 URL を取得するオブジェクト。Google などの検索エンジンに対してどのページ版が正規であるかを指定するために使用する。
content_for_index オブジェクト
ホームページに表示するセクションの内容を動的に返すオブジェクト。Liquid インデックステンプレートで必ず使用する。
content_for_additional_checkout_buttons オブジェクト
PayPal、Apple Pay、Google Pay など複数の決済プロバイダが有効になっているとき、その決済ボタンを HTML として出力するオブジェクト。`additional_checkout_buttons` で有無を判定したうえで、このオブジェクトで実際のボタンを表示する。