settings_schema.json 文件控制着主题编辑器中主题设置区域的组织和内容。主题编辑器中的所有设置选项都保存在 settings_data.json 文件中。
位置
settings_schema.json 文件位于主题的 config 目录中:
└── theme
...
├── config
├── settings_data.json
└── settings_schema.json
└── locales
Schema
settings_schema.json 文件是一个代表设置类别的对象数组。每个对象都需要具备以下属性:
属性 | 描述 | 必须 |
name | 设置类别的名称 | 是 |
settings | 相关设置的数组 | 是 |
settings_schema.json 文件应遵循以下基本格式:
[
{
"name": "Category",
"settings": [
...
]
},
...
]
settings_schema.json 文件是一个 JSON 文件,因此所有内容都必须是有效的 JSON。此外,请确保根据所需设置使用适当的语法。
应用
在使用 settings_schema.json 文件时,请熟悉以下内容:
- 设置类型
- 访问设置
- 添加主题元数据
设置类型
有两类设置:
分类 | 描述 |
Input settings | 可保存值的设置,可由应用程序用户配置。 |
Sidebar settings | 不能保留数值的设置,应用程序用户无法配置。它们是信息元素,可用于提供输入设置的细节。 |
访问设置
主题设置可通过设置对象访问。
添加主题元数据
作为主题作者,您可以在主题编辑器的 “主题操作 “菜单中为主题添加其他元数据。该菜单位于主题编辑器顶部栏的左侧:

要添加这些元数据,可以在 settings_schema.json 文件中包含一个 theme_info 对象。该对象必须包含以下属性:
属性 | 描述 | 必须 |
name | 该属性的值必须是 theme_info | 是 |
theme_name | 主题名称 | 是 |
theme_author | 主题的作者 | 是 |
theme_version | 主题的版本号 | 是 |
theme_documentation_url | 商家可以找到主题文档的 URL | 是 |
theme_support_email | 商家可联系以获得主题支持的电子邮件地址。 | |
theme_support_url | 商家可以找到主题支持的 URL |
注意事项
上述所有属性都是必需的。但是,您只需指定 theme_support_email 或 theme_support_url,而不能同时指定这两个属性。包含这两个属性或不包含任何其他属性都会导致错误。
例如
[
{
"name": "theme_info",
"theme_name": "Dawn",
"theme_author": "Shopify",
"theme_version": "1.0.0",
"theme_documentation_url": "https:\/\/help.shopify.com\/manual\/online-store\/themes\/os20\/themes-by-shopify\/dawn",
"theme_support_url": "https:\/\/support.shopify.com\/",
},
...
]
发表回复