JSON スキーマ

このドキュメントは、theme.json の JSON スキーマから生成されました。

Gutenberg プラグインからの最新の変更を含むバージョン 3 の最新スキーマは https://schemas.wp.org/trunk/theme.json で入手できます。

各 WordPress バージョンの theme.json スキーマは https://schemas.wp.org/wp/{{version}}/theme.json で入手できます。

たとえば、WordPress 5.8 のスキーマは https://schemas.wp.org/wp/5.8/theme.json で入手できます。

エディタで JSON スキーマを使用する方法については、theme.json を使用した開発 を参照してください。

設定

ブロックエディタおよび個々のブロックの設定。これには次のようなものが含まれます:

– ユーザーに利用可能なカスタマイズオプション。

– ユーザーに利用可能なデフォルトの色、フォントサイズ…

– スタイルで使用される CSS カスタムプロパティとクラス名。

– エディタのデフォルトレイアウト（幅と利用可能な配置）。

useRootPaddingAwareAlignments

ルートパディング（styles.spacing.padding の値）をフル幅ブロックの内容に適用できるようにします。

この設定を使用する場合、styles.spacing.padding は常に top、right、bottom、left の値が別々に宣言されたオブジェクトとして設定する必要があります。

注意: トップレベル専用のプロパティ。ブロックでは利用できません。

appearanceTools

次の UI ツールを有効にする設定:

  • 背景: backgroundImage, backgroundSize
  • ボーダー: color, radius, style, width
  • 色: link, heading, button, caption
  • 寸法: aspectRatio, minHeight
  • 位置: sticky
  • スペーシング: blockGap, margin, padding
  • タイポグラフィ: lineHeight

背景

背景に関連する設定。

プロパティ 説明 タイプ デフォルト
backgroundImage ユーザーが背景画像を設定できるようにします。 boolean false
backgroundSize ユーザーが背景画像のサイズ、位置、リピートコントロールに関連する値を設定できるようにします。 boolean false

ボーダー

ボーダーに関連する設定。

プロパティ 説明 タイプ デフォルト
color ユーザーがカスタムボーダー色を設定できるようにします。 boolean false
radius ユーザーがカスタムボーダー半径を設定できるようにします。 boolean false
style ユーザーがカスタムボーダースタイルを設定できるようにします。 boolean false
width ユーザーがカスタムボーダー幅を設定できるようにします。 boolean false

色

色に関連する設定。

プロパティ 説明 タイプ デフォルト
background ユーザーが背景色を設定できるようにします。 boolean true
custom ユーザーがカスタム色を選択できるようにします。 boolean true
customDuotone ユーザーがカスタムデュオトーンフィルターを作成できるようにします。 boolean true
customGradient ユーザーがカスタムグラデーションを作成できるようにします。 boolean true
defaultDuotone ユーザーがデフォルトのデュオトーンフィルタープリセットからフィルターを選択できるようにします。 boolean true
defaultGradients ユーザーがデフォルトのグラデーションから色を選択できるようにします。 boolean true
defaultPalette ユーザーがデフォルトのパレットから色を選択できるようにします。 boolean true
duotone デュオトーンピッカー用のデュオトーンプリセット。 [ { name, slug, colors } ]
gradients グラデーションピッカー用のグラデーションプリセット。 [ { name, slug, gradient } ]
link ユーザーがブロック内のリンク色を設定できるようにします。 boolean false
palette カラーピッカー用のカラーパレットプリセット。 [ { name, slug, color } ]
text ユーザーがブロック内のテキスト色を設定できるようにします。 boolean true
heading ユーザーがブロック内の見出し色を設定できるようにします。 boolean true
button ユーザーがブロック内のボタン色を設定できるようにします。 boolean true
caption ユーザーがブロック内のキャプション色を設定できるようにします。 boolean true

寸法

寸法に関連する設定。

プロパティ 説明 タイプ デフォルト
aspectRatio ユーザーがアスペクト比を設定できるようにします。 boolean false
defaultAspectRatios ユーザーがデフォルトのアスペクト比セットからアスペクト比を選択できるようにします。 boolean true
aspectRatios ユーザーがいくつかのブロックのアスペクト比を定義できるようにします。 [ { name, slug, ratio } ]
minHeight ユーザーがカスタム最小高さを設定できるようにします。 boolean false

レイアウト

レイアウトに関連する設定。

プロパティ 説明 タイプ デフォルト
contentSize コンテンツの最大幅を設定します。 string
wideSize ワイド（.alignwide）コンテンツの最大幅を設定します。流動的なフォントサイズを計算する際の最大ビューポートとしても使用されます。 string
allowEditing レイアウト UI コントロールを無効にします。 boolean true
allowCustomContentAndWideSize カスタムコンテンツとワイドサイズコントロールを有効または無効にします。 boolean true

ライトボックス

ライトボックスに関連する設定。

プロパティ 説明 タイプ デフォルト
enabled ライトボックスが有効かどうかを定義します。 boolean
allowEditing ブロックエディタにライトボックス UI を表示するかどうかを定義します。false に設定されている場合、ユーザーはブロックエディタでライトボックス設定を変更できません。 boolean

位置

位置に関連する設定。

プロパティ 説明 タイプ デフォルト
sticky ユーザーがスティッキーポジションを設定できるようにします。 boolean false

影

影に関連する設定。

プロパティ 説明 タイプ デフォルト
defaultPresets ユーザーがデフォルトの影プリセットから影を選択できるようにします。 boolean true
presets 影ピッカー用の影プリセット。 [ { name, slug, shadow } ]

スペーシング

スペーシングに関連する設定。

プロパティ 説明 タイプ デフォルト
blockGap styles.spacing.blockGap から生成される --wp--style--block-gap を有効にします。 boolean, null null
margin ユーザーがカスタムマージンを設定できるようにします。 boolean false
padding ユーザーがカスタムパディングを設定できるようにします。 boolean false
units ユーザーがスペーシング値に使用できる単位のリスト。 [ string ] ["px","em","rem","vh","vw","%"]
customSpacingSize ユーザーがカスタムスペースサイズを設定できるようにします。 boolean true
defaultSpacingSizes ユーザーがデフォルトのスペースサイズプリセットからスペースサイズを選択できるようにします。 boolean true
spacingSizes スペースサイズセレクター用のスペースサイズプリセット。 [ { name, slug, size } ]
spacingScale スペースサイズセレクター用のスペースサイズプリセットを自動生成する設定。 { operator, increment, steps, mediumStep, unit }

タイポグラフィ

タイポグラフィに関連する設定。

プロパティ 説明 タイプ デフォルト
defaultFontSizes ユーザーがデフォルトのフォントサイズプリセットからフォントサイズを選択できるようにします。 boolean true
customFontSize ユーザーがカスタムフォントサイズを設定できるようにします。 boolean true
fontStyle ユーザーがカスタムフォントスタイルを設定できるようにします。 boolean true
fontWeight ユーザーがカスタムフォントウェイトを設定できるようにします。 boolean true
fluid 流動的なタイポグラフィを有効にし、ユーザーがグローバルな流動的タイポグラフィパラメータを設定できるようにします。 boolean, { minFontSize, maxViewportWidth, minViewportWidth } false
letterSpacing ユーザーがカスタム文字間隔を設定できるようにします。 boolean true
lineHeight ユーザーがカスタム行の高さを設定できるようにします。 boolean false
textAlign ユーザーがテキストの整列を設定できるようにします。 boolean true
textColumns ユーザーがテキストの列数を設定できるようにします。 boolean false
textDecoration ユーザーがカスタムテキスト装飾を設定できるようにします。 boolean true
writingMode ユーザーが書き込みモードを設定できるようにします。 boolean false
textTransform ユーザーがカスタムテキスト変換を設定できるようにします。 boolean true
dropCap ドロップキャップを有効にします。 boolean true
fontSizes フォントサイズセレクター用のフォントサイズプリセット。 [ { name, slug, size, fluid } ]
fontFamilies フォントファミリーセレクター用のフォントファミリープリセット。 [ { name, slug, fontFamily, fontFace } ]

カスタム

カスタム CSS カスタムプロパティを --wp--custom--{key}--{nested-key}: {value}; の形式で生成します。 camelCased のキーは、CSS プロパティ命名スキーマに従って kebab-case に変換されます。異なる深さレベルのキーは -- で区切られるため、キーには名前に -- を含めるべきではありません。

スタイル

CSS プロパティを設定するための整理された方法。トップレベルのスタイルは body セレクターに追加されます。

背景

背景スタイル。

プロパティ 説明 タイプ
backgroundImage background-image CSS プロパティを設定します。 string, { ref }, { url }
backgroundPosition background-position CSS プロパティを設定します。 string, { ref }
backgroundRepeat background-repeat CSS プロパティを設定します。 string, { ref }
backgroundSize background-size CSS プロパティを設定します。 string, { ref }
backgroundAttachment background-attachment CSS プロパティを設定します。 string, { ref }

ボーダー

ボーダースタイル。

プロパティ 説明 タイプ
color border-color CSS プロパティを設定します。 string, { ref }
radius border-radius CSS プロパティを設定します。 string, { ref }, { topLeft, topRight, bottomLeft, bottomRight }
style border-style CSS プロパティを設定します。 string, { ref }
width border-width CSS プロパティを設定します。 string, { ref }
top { color, style, width }
right { color, style, width }
bottom { color, style, width }
left { color, style, width }

色

色スタイル。

プロパティ 説明 タイプ
background background-color CSS プロパティを設定します。 string, { ref }
gradient background CSS プロパティを設定します。 string, { ref }
text color CSS プロパティを設定します。 string, { ref }

CSS

他の theme.json プロパティでカバーされていないスタイリングを適用するためのカスタム CSS を設定します。

寸法

寸法スタイル。

プロパティ 説明 タイプ
aspectRatio aspect-ratio CSS プロパティを設定します。 string, { ref }
minHeight min-height CSS プロパティを設定します。 string, { ref }

フィルター

CSS および SVG フィルタースタイル。

プロパティ 説明 タイプ
duotone デュオトーンフィルターを設定します。 string, { ref }

アウトライン

アウトラインスタイル。

プロパティ 説明 タイプ
color outline-color CSS プロパティを設定します。 string, { ref }
offset outline-offset CSS プロパティを設定します。 string, { ref }
style outline-style CSS プロパティを設定します。 string, { ref }
width outline-width CSS プロパティを設定します。 string, { ref }

影

ボックスシャドウスタイル。

スペーシング

スペーシングスタイル。

プロパティ 説明 タイプ
blockGap settings.spacing.blockGap が true の場合、--wp--style--block-gap CSS カスタムプロパティを設定します。 string, { ref }
margin マージンスタイル。 { top, right, bottom, left }
padding パディングスタイル。 { top, right, bottom, left }

タイポグラフィ

タイポグラフィスタイル。

プロパティ 説明 タイプ
fontFamily font-family CSS プロパティを設定します。 string, { ref }
fontSize font-size CSS プロパティを設定します。 string, { ref }
fontStyle font-style CSS プロパティを設定します。 string, { ref }
fontWeight font-weight CSS プロパティを設定します。 string, { ref }
letterSpacing letter-spacing CSS プロパティを設定します。 string, { ref }
lineHeight line-height CSS プロパティを設定します。 string, { ref }
textAlign text-align CSS プロパティを設定します。 string, { ref }
textColumns column-count CSS プロパティを設定します。 string, { ref }
textDecoration text-decoration CSS プロパティを設定します。 string, { ref }
writingMode writing-mode CSS プロパティを設定します。 string, { ref }
textTransform text-transform CSS プロパティを設定します。 string, { ref }

カスタムテンプレート

テンプレートフォルダーで定義されたカスタムテンプレートの追加メタデータ。

プロパティ 説明 タイプ
name テンプレートフォルダー内のテンプレートの拡張子なしのファイル名。 string
title テンプレートのタイトル、翻訳可能。 string
postTypes このカスタムテンプレートを使用できる投稿タイプのリスト。 [ string ]

テンプレートパーツ

パーツフォルダーで定義されたテンプレートパーツの追加メタデータ。

プロパティ 説明 タイプ
name パーツフォルダー内のテンプレートの拡張子なしのファイル名。 string
title テンプレートのタイトル、翻訳可能。 string
area テンプレートパーツが使用されるエリア。header および footer の値に対するブロックバリエーションが存在し、それが設定されると使用されます。 string

パターン

パターンディレクトリから登録されるパターンスラッグの配列。

タイプ: [ string ].