部分
<section>
-Tag參照到系統組態中的現有或新區段。
區段屬性參考
<section>
— 標籤可以有下列屬性:
屬性 | 說明 | 型別 | 必填 |
---|---|---|---|
id | 定義參考區段所使用的識別碼。 | typeId | 必填 |
translate | 定義應可翻譯的欄位。 提供label 讓標籤可翻譯。 | string | 可選 |
type | 定義轉譯HTML元素的輸入型別。 預設為text 。 | string | 可選 |
sortOrder | 定義區段的排序順序。 高數字會將區段推送至頁面底部;低數字會將區段推送至頁面頂部。 | float | 可選 |
showInDefault | 定義區段是否顯示在預設設定範圍中。 指定1 以顯示區段,指定0 隱藏區段。 | int | 可選 |
showInStore | 定義區段是否顯示在存放區層級。 指定1 以顯示區段,指定0 隱藏區段。 | int | 可選 |
showInWebsite | 定義區段是否會顯示在網站層級。 指定1 以顯示區段,指定0 隱藏區段。 | int | 可選 |
canRestore | 定義區段是否可還原成預設值。 | int | 可選 |
advanced | 自100.0.2起已棄用。 | bool | 可選 |
extends | 透過提供另一個區段的識別碼,此節點的內容將擴充您參考的區段。 | string | 可選 |
區段節點參考
<section>
— 標籤可以有下列子系:
節點 | 說明 | 型別 |
---|---|---|
label | 定義顯示在前端中的標籤。 | string |
class | 將定義的CSS類別新增至演算後的區段HTML元素。 | string |
tab | 參考關聯的索引標籤。 必須是索引標籤的ID。 | typeTabId |
header_css | 撰寫本文時既未使用也未評估。 | string |
resource | 參考ACL資源以提供此區段的許可權設定。 | typeAclResourceId |
group | 定義一或多個子群組。 | 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>
上述章節定義識別碼A_UNIQUE_SECTION_ID
,在預設設定檢視和存放區內容中可見。 label
節點是可翻譯的。 區段與ID為A_UNIQUE_ID
的索引標籤相關聯。 只有在ACL VENDOR_MODULE::path_to_the_acl_resource
中定義許可權的使用者才能存取區段。
群組
<group>
— 標籤用於將欄位分組在一起。
群組屬性參考
<group>
— 標籤可以有下列屬性:
屬性 | 說明 | 型別 | 必填 |
---|---|---|---|
id | 定義用於參考群組的識別碼。 | typeId | 必填 |
translate | 定義應可翻譯的欄位。 提供label 讓標籤可翻譯。 多個欄位應以空格分隔。 | string | 可選 |
type | 定義轉譯HTML元素的輸入型別。 預設為text 。 | string | 可選 |
sortOrder | 定義區段的排序順序。 高數字會將區段推送至頁面底部;低數字會將區段推送至頁面頂部。 | float | 可選 |
showInDefault | 定義群組是否顯示在預設設定範圍中。 指定1 以顯示群組,指定0 隱藏群組。 | int | 可選 |
showInStore | 定義群組是否顯示在存放區層級。 指定1 以顯示群組,指定0 隱藏群組。 | int | 可選 |
showInWebsite | 定義群組是否顯示在網站層級。 指定1 以顯示群組,指定0 隱藏群組。 | int | 可選 |
canRestore | 定義群組是否可還原成預設值。 | int | 可選 |
advanced | 自100.0.2起已棄用。 | bool | 可選 |
extends | 藉由提供另一個群組的識別碼,此節點的內容將會擴充您參考的區段。 | string | 可選 |
群組節點參考
<group>
— 標籤可以有下列子系:
節點 | 說明 | 型別 |
---|---|---|
label | 定義顯示在前端中的標籤。 | string |
fieldset_css | 將一或多個CSS類別新增至群組欄位集。 | string |
frontend_model | 指定不同的前端模型來變更彩現並修改輸出。 | typeModel |
clone_model | 指定指定模型以複製欄位。 | typeModel |
clone_fields | 啟用或停用欄位複製。 | int |
help_url | 無法擴充。 請參閱下文。 | typeUrl |
more_url | 無法擴充。 請參閱下文。 | typeUrl |
demo_link | 無法擴充。 請參閱下文。 | typeUrl |
comment | 在群組標籤下方新增註解。 使用<![CDATA[//]]> 可套用HTML。 | string |
hide_in_single_store_mode | 群組是否應該在單一存放區模式中可見。 1 隱藏群組;0 顯示群組。 | int |
field | 定義此群組下應可使用的一或多個欄位。 | field |
group | 定義一或多個子群組。 | unbounded |
depends | 可用於宣告對其他欄位的相依性。 只有在指定欄位的值為1 時,才會用來顯示特定欄位/群組。 此節點需要section/group/field 字串。 | depends |
attribute | 前端模型可使用自訂屬性。 通常用於讓指定的前端模型更動態。 | attribute |
include | 用於包含其他system_include.xsd 個相容的檔案。 通常用於建構大型system.xml 檔案。 | includeType |
節點
more_url
、demo_url
和help_url
是由只使用一次的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>
上述群組定義識別碼A_UNIQUE_GROUP_ID
,可在預設設定檢視和存放區內容中看到。 label
和comment
都標示為可翻譯。