タブ属性リファレンス
<tab>
タグには、次の属性を含めることができます。
属性 | 説明 | タイプ | 必須 |
---|---|---|---|
id | セクションを参照するために使用する識別子を定義します。 | typeId | 必須 |
translate | 翻訳可能にするフィールドを定義します。 ラベルを翻訳可能にする label を指定します。 | string | optional |
sortOrder | セクションの並べ替え順を定義します。 数値が大きい場合はセクションがページの下部にプッシュされ、数値が小さい場合はセクションが上部にプッシュされます。 | float | optional |
class | 定義済みの CSS クラスを、レンダリングされたタブHTML要素に追加します。 | string | optional |
タブノードのリファレンス
<tab>
-Tag は次の子を持つことができます。
ノード | 説明 | タイプ |
---|---|---|
label | フロントエンドに表示されるラベルを定義します。 | string |
例:タブの作成
次のコードスニペットは、サンプルデータを使用して新しいタブを作成する方法を示しています。
<?xml version="1.0" ?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
<system>
<tab id="A_UNIQUE_ID" translate="label" class="a-custom-css-class-to-style-this-tab" sortOrder="10">
<label>A meaningful label</label>
</tab>
</system>
</config>
上記のスニペットは、識別子が A_UNIQUE_ID
の新しいタブを作成します。 translate
属性が定義され、ラベルを参照すると、label
ノードが翻訳可能になります。 レンダリングプロセス中に、CSS クラス a-custom-css-class-to-style-this-tab
がこのタブ用に作成されたHTML要素に適用されます。
値が 10
の sortOrder
属性は、レンダリング時のすべてのタブのリスト内のタブの位置を定義します。
セクション
<section>
タグは、システム設定の既存または新しいセクションを参照します。
セクション属性リファレンス
<section>
タグには、次の属性を含めることができます。
属性 | 説明 | タイプ | 必須 |
---|---|---|---|
id | セクションを参照するために使用する識別子を定義します。 | typeId | 必須 |
translate | 翻訳可能にするフィールドを定義します。 ラベルを翻訳可能にする label を指定します。 | string | optional |
type | レンダリングされるHTML要素の入力タイプを定義します。 デフォルトは text です。 | string | optional |
sortOrder | セクションの並べ替え順を定義します。 数値が大きい場合はセクションがページの下部に移動し、数値が小さい場合はセクションが上部に移動します。 | float | optional |
showInDefault | セクションを既定の構成範囲に表示するかどうかを定義します。 1 を指定してセクションを表示し、0 を指定してセクションを非表示にします。 | int | optional |
showInStore | セクションをストアレベルで表示するかどうかを定義します。 1 を指定してセクションを表示し、0 を指定してセクションを非表示にします。 | int | optional |
showInWebsite | セクションを web サイトレベルで表示するかどうかを定義します。 1 を指定してセクションを表示し、0 を指定してセクションを非表示にします。 | int | optional |
canRestore | セクションをデフォルトに復元できるかどうかを定義します。 | int | optional |
advanced | 100.0.2 以降で非推奨。 | bool | optional |
extends | 別のセクションの識別子を指定すると、このノードのコンテンツによって、参照したセクションが拡張されます。 | string | optional |
断面ノード リファレンス
<section>
タグには、次の子を含めることができます。
ノード | 説明 | タイプ |
---|---|---|
label | フロントエンドに表示されるラベルを定義します。 | string |
class | 定義された CSS クラスを、レンダリングされたセクションHTML要素に追加します。 | string |
tab | 関連付けられたタブを参照します。 では、タブの ID が想定されます。 | typeTabId |
header_css | このドキュメントの作成時には使用も評価もされません。 | string |
resource | このセクションの権限設定を提供する ACL リソースを参照します。 | typeAclResourceId |
group | 1 つ以上のサブグループを定義します。 | typeGroup |
frontend_model | レンダリングを変更し、出力を変更する別のフロントエンドモデルを指定します。 | typeModel |
include | 追加の system_include.xsd 互換ファイルを含めるために使用されます。 通常、大きな system.xml ファイルを構造化するために使用します。 | includeType |
例:セクションを作成してタブに割り当てる
次のコードスニペットは、新しいセクションを作成する際の基本的な使用方法を示しています。
<?xml version="1.0" ?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
<system>
<tab id="A_UNIQUE_ID" translate="label" class="a-custom-css-class-to-style-this-tab" sortOrder="10">
<label>A meaningful label</label>
</tab>
<section id="A_UNIQUE_SECTION_ID" showInDefault="1" showInWebsite="0" showInStore="1" sortOrder="10" translate="label">
<label>A meaningful section label</label>
<tab>A_UNIQUE_ID</tab>
<resource>VENDOR_MODULE::path_to_the_acl_resource</resource>
</section>
</system>
</config>
上記の節では、ID A_UNIQUE_SECTION_ID
を定義します。この ID は、デフォルトの設定表示およびストアコンテキストに表示されます。 label
ノードは翻訳可能です。 セクションは、ID が A_UNIQUE_ID
のタブに関連付けられています。 セクションは、ACL VENDOR_MODULE::path_to_the_acl_resource
で権限が定義されているユーザーのみがアクセスできます。
グループ
<group>
-Tag は、フィールドをグループ化するために使用されます。
グループ属性参照
<group>
タグには、次の属性を含めることができます。
属性 | 説明 | タイプ | 必須 |
---|---|---|---|
id | グループを参照するために使用する識別子を定義します。 | typeId | 必須 |
translate | 翻訳可能なフィールドを定義します。 ラベルを翻訳可能にする label を指定します。 複数のフィールドはスペースで区切る必要があります。 | string | optional |
type | レンダリングされるHTML要素の入力タイプを定義します。 デフォルトは text です。 | string | optional |
sortOrder | セクションの並べ替え順を定義します。 数値が大きい場合はセクションがページの下部に移動し、数値が小さい場合はセクションが上部に移動します。 | float | optional |
showInDefault | グループを既定の構成範囲に表示するかどうかを定義します。 グループを表示する場合は 1 を指定し、グループを非表示にする場合は 0 を指定します。 | int | optional |
showInStore | グループをストアレベルで表示するかどうかを定義します。 グループを表示する場合は 1 を指定し、グループを非表示にする場合は 0 を指定します。 | int | optional |
showInWebsite | グループを web サイトレベルで表示するかどうかを定義します。 グループを表示する場合は 1 を指定し、グループを非表示にする場合は 0 を指定します。 | int | optional |
canRestore | グループをデフォルトに復元できるかどうかを定義します。 | int | optional |
advanced | 100.0.2 以降で非推奨。 | bool | optional |
extends | 別のグループの識別子を指定すると、このノードのコンテンツによって、参照したセクションが拡張されます。 | string | optional |
グループノード参照
<group>
タグには、次の子を含めることができます。
ノード | 説明 | タイプ |
---|---|---|
label | フロントエンドに表示されるラベルを定義します。 | string |
fieldset_css | 1 つ以上の CSS クラスをグループフィールドセットに追加します。 | string |
frontend_model | レンダリングを変更し、出力を変更する別のフロントエンドモデルを指定します。 | typeModel |
clone_model | フィールドを複製する特定のモデルを指定します。 | typeModel |
clone_fields | フィールドのクローン作成を有効または無効にしました。 | int |
help_url | 拡張可能ではありません。 以下を参照してください。 | typeUrl |
more_url | 拡張可能ではありません。 以下を参照してください。 | typeUrl |
demo_link | 拡張可能ではありません。 以下を参照してください。 | typeUrl |
comment | グループラベルの下にコメントを追加します。 HTMLを使用 <![CDATA[//]]> て適用することができます。 | string |
hide_in_single_store_mode | グループを単一ストアモードで表示するかどうかを指定します。 1 はグループを非表示にし、0 はグループを表示します。 | int |
field | このグループで使用できるフィールドを 1 つ以上定義します。 | field |
group | 1 つ以上のサブグループを定義します。 | unbounded |
depends | 他のフィールドへの依存関係を宣言するために使用できます。 特定のフィールドの値が 1 の場合にのみ特定のフィールドやグループを表示するために使用されます。 このノードには section/group/field 文字列が必要です。 | depends |
attribute | カスタム属性は、フロントエンドモデルで使用できます。 通常、特定のフロントエンドモデルをより動的にするために使用されます。 | attribute |
include | 追加の system_include.xsd 互換ファイルを含めるために使用されます。 通常、大きな system.xml ファイルを構造化するために使用します。 | includeType |
more_url
、demo_url
、help_url
は、1 回だけ使用される PayPal フロントエンドモデルによって定義されます。 これらのノードは再利用できません。例:特定のセクションのグループを作成する
次のコードスニペットは、新しいグループを作成する際の基本的な使用方法を示しています。
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:module:Magento_Config:etc/system_file.xsd">
<system>
<tab id="A_UNIQUE_ID" translate="label" class="a-custom-css-class-to-style-this-tab" sortOrder="10">
<label>A meaningful label</label>
</tab>
<section id="A_UNIQUE_SECTION_ID" showInDefault="1" showInWebsite="0" showInStore="1" sortOrder="10" translate="label">
<label>A meaningful section label</label>
<tab>A_UNIQUE_ID</tab>
<resource>VENDOR_MODULE::path_to_the_acl_resource</resource>
<group id="A_UNIQUE_GROUP_ID" translate="label comment" sortOrder="10" showInDefault="1" showInWebsite="0" showInStore="1">
<label>A meaningful group label</label>
<comment>An additional comment helping users to understand the effect when configuring the fields defined in this group.</comment>
<!-- Add your fields here. -->
</group>
</section>
</system>
</config>
上記のグループは ID A_UNIQUE_GROUP_ID
を定義し、デフォルトの設定ビューおよびストアコンテキストに表示されます。 label
と comment
の両方が翻訳可能としてマークされます。
フィールド
<field>
-Tag は、特定の設定値を定義するために <group>
-Tags 内で使用されます。
フィールド属性リファレンス
<field>
タグには、次の属性を含めることができます。
属性 | 説明 | タイプ | 必須 |
---|---|---|---|
id | フィールドを参照するために使用する識別子を定義します。 | typeId | 必須 |
translate | 翻訳可能なフィールドを定義します。 ラベルを翻訳可能にする label を指定します。 複数のフィールドはスペースで区切る必要があります。 | string | optional |
type | レンダリングされるHTML要素の入力タイプを定義します。 デフォルトは text です。 | string | optional |
sortOrder | セクションの並べ替え順を定義します。 数値が大きい場合はセクションがページの下部にプッシュされ、数値が小さい場合はセクションが上部にプッシュされます。 | float | optional |
showInDefault | デフォルトの設定範囲にフィールドを表示するかどうかを定義します。 1 を指定してフィールドを表示し、0 を指定してフィールドを非表示にします。 | int | optional |
showInStore | フィールドをストアレベルで表示するかどうかを定義します。 1 を指定してフィールドを表示し、0 を指定してフィールドを非表示にします。 | int | optional |
showInWebsite | Web サイトレベルでフィールドを表示するかどうかを定義します。 1 を指定してフィールドを表示し、0 を指定してフィールドを非表示にします。 | int | optional |
canRestore | フィールドをデフォルトに復元できるかどうかを定義します。 | int | optional |
advanced | 100.0.2 以降で非推奨。 | bool | optional |
extends | 別のフィールドの識別子を指定すると、このノードのコンテンツは、参照したセクションを拡張します。 | string | optional |