タブ属性リファレンス

<tab> タグには、次の属性を含めることができます。

属性説明タイプ必須
idセクションを参照するために使用する識別子を定義します。typeId必須
translate翻訳可能にするフィールドを定義します。 ラベルを翻訳可能にする label を指定します。stringoptional
sortOrderセクションの並べ替え順を定義します。 数値が大きい場合はセクションがページの下部にプッシュされ、数値が小さい場合はセクションが上部にプッシュされます。floatoptional
class定義済みの CSS クラスを、レンダリングされたタブHTML要素に追加します。stringoptional

タブノードのリファレンス

<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要素に適用されます。
値が 10sortOrder 属性は、レンダリング時のすべてのタブのリスト内のタブの位置を定義します。

セクション

<section> タグは、システム設定の既存または新しいセクションを参照します。

セクション属性リファレンス

<section> タグには、次の属性を含めることができます。

属性説明タイプ必須
idセクションを参照するために使用する識別子を定義します。typeId必須
translate翻訳可能にするフィールドを定義します。 ラベルを翻訳可能にする label を指定します。stringoptional
typeレンダリングされるHTML要素の入力タイプを定義します。 デフォルトは text です。stringoptional
sortOrderセクションの並べ替え順を定義します。 数値が大きい場合はセクションがページの下部に移動し、数値が小さい場合はセクションが上部に移動します。floatoptional
showInDefaultセクションを既定の構成範囲に表示するかどうかを定義します。 1 を指定してセクションを表示し、0 を指定してセクションを非表示にします。intoptional
showInStoreセクションをストアレベルで表示するかどうかを定義します。 1 を指定してセクションを表示し、0 を指定してセクションを非表示にします。intoptional
showInWebsiteセクションを web サイトレベルで表示するかどうかを定義します。 1 を指定してセクションを表示し、0 を指定してセクションを非表示にします。intoptional
canRestoreセクションをデフォルトに復元できるかどうかを定義します。intoptional
advanced100.0.2 以降で非推奨。booloptional
extends別のセクションの識別子を指定すると、このノードのコンテンツによって、参照したセクションが拡張されます。stringoptional

断面ノード リファレンス

<section> タグには、次の子を含めることができます。

ノード説明タイプ
labelフロントエンドに表示されるラベルを定義します。string
class定義された CSS クラスを、レンダリングされたセクションHTML要素に追加します。string
tab関連付けられたタブを参照します。 では、タブの ID が想定されます。typeTabId
header_cssこのドキュメントの作成時には使用も評価もされません。string
resourceこのセクションの権限設定を提供する ACL リソースを参照します。typeAclResourceId
group1 つ以上のサブグループを定義します。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 を指定します。 複数のフィールドはスペースで区切る必要があります。stringoptional
typeレンダリングされるHTML要素の入力タイプを定義します。 デフォルトは text です。stringoptional
sortOrderセクションの並べ替え順を定義します。 数値が大きい場合はセクションがページの下部に移動し、数値が小さい場合はセクションが上部に移動します。floatoptional
showInDefaultグループを既定の構成範囲に表示するかどうかを定義します。 グループを表示する場合は 1 を指定し、グループを非表示にする場合は 0 を指定します。intoptional
showInStoreグループをストアレベルで表示するかどうかを定義します。 グループを表示する場合は 1 を指定し、グループを非表示にする場合は 0 を指定します。intoptional
showInWebsiteグループを web サイトレベルで表示するかどうかを定義します。 グループを表示する場合は 1 を指定し、グループを非表示にする場合は 0 を指定します。intoptional
canRestoreグループをデフォルトに復元できるかどうかを定義します。intoptional
advanced100.0.2 以降で非推奨。booloptional
extends別のグループの識別子を指定すると、このノードのコンテンツによって、参照したセクションが拡張されます。stringoptional

グループノード参照

<group> タグには、次の子を含めることができます。

ノード説明タイプ
labelフロントエンドに表示されるラベルを定義します。string
fieldset_css1 つ以上の 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
group1 つ以上のサブグループを定義します。unbounded
depends他のフィールドへの依存関係を宣言するために使用できます。 特定のフィールドの値が 1 の場合にのみ特定のフィールドやグループを表示するために使用されます。 このノードには section/group/field 文字列が必要です。depends
attributeカスタム属性は、フロントエンドモデルで使用できます。 通常、特定のフロントエンドモデルをより動的にするために使用されます。attribute
include追加の system_include.xsd 互換ファイルを含めるために使用されます。 通常、大きな system.xml ファイルを構造化するために使用します。includeType
警告
ノード more_urldemo_urlhelp_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 を定義し、デフォルトの設定ビューおよびストアコンテキストに表示されます。 labelcomment の両方が翻訳可能としてマークされます。

フィールド

<field>-Tag は、特定の設定値を定義するために <group>-Tags 内で使用されます。

フィールド属性リファレンス

<field> タグには、次の属性を含めることができます。

属性説明タイプ必須
idフィールドを参照するために使用する識別子を定義します。typeId必須
translate翻訳可能なフィールドを定義します。 ラベルを翻訳可能にする label を指定します。 複数のフィールドはスペースで区切る必要があります。stringoptional
typeレンダリングされるHTML要素の入力タイプを定義します。 デフォルトは text です。stringoptional
sortOrderセクションの並べ替え順を定義します。 数値が大きい場合はセクションがページの下部にプッシュされ、数値が小さい場合はセクションが上部にプッシュされます。floatoptional
showInDefaultデフォルトの設定範囲にフィールドを表示するかどうかを定義します。 1 を指定してフィールドを表示し、0 を指定してフィールドを非表示にします。intoptional
showInStoreフィールドをストアレベルで表示するかどうかを定義します。 1 を指定してフィールドを表示し、0 を指定してフィールドを非表示にします。intoptional
showInWebsiteWeb サイトレベルでフィールドを表示するかどうかを定義します。 1 を指定してフィールドを表示し、0 を指定してフィールドを非表示にします。intoptional
canRestoreフィールドをデフォルトに復元できるかどうかを定義します。intoptional
advanced100.0.2 以降で非推奨。booloptional
extends別のフィールドの識別子を指定すると、このノードのコンテンツは、参照したセクションを拡張します。stringoptional