theme.json Version 3 リファレンス (最新)

この文書は theme.json バージョン3の現在の仕様です。このバージョンは、WordPress 6.6以降と最新の Gutenberg プラグインで動作します。

関連ドキュメントとして以下があります。

このリファレンスガイドは、theme.json スキーマで定義された設定 (settings) とスタイル (styles) プロパティの一覧です。テーマ内での theme.json で使用する例や指針については、theme.json ガイド を参照してください。

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 を使用した開発を参照してください。

Top ↑

settings

ブロックエディターと個々のブロックの設定。以下が含まれます。

  • ユーザーが利用できるカスタマイズオプション。
  • ユーザーが利用できるデフォルトの色、フォントサイズ …。
  • スタイルで使用される CSS カスタムプロパティとクラス名。
  • エディターのデフォルトレイアウト (幅と利用可能な配置)。

Top ↑

useRootPaddingAwareAlignments

ルートブロックの代わりに全幅ブロックのコンテンツに、ルートパディング (styles.spacing.padding の値) を適用することを可能にします。

注意: この設定を使用する場合は styles.spacing.paddingは常に toprightbottomleft の値を個別に宣言したオブジェクトとして設定してください。

注意: 最上位レベルのプロパティ。ブロックでは利用不可。


Top ↑

appearanceTools

以下のUIツールを有効にする設定。

  • background: backgroundImage, backgroundSize
  • border: color, radius, style, width
  • color: link, heading, button, caption
  • dimensions: aspectRatio, minHeight
  • position: sticky
  • spacing: blockGap, margin, padding
  • typography: lineHeight

Top ↑

background

背景関連の設定。

PropertyDescriptionTypeDefault
backgroundImage背景画像の設定booleanfalse
backgroundSize背景画像のサイズに関する値、サイズ、位置、リピートコントロールなどの設定booleanfalse

Top ↑

border

ボーダー関連の設定。

PropertyDescriptionTypeDefault
colorカスタムボーダー色の設定booleanfalse
radiusカスタムボーダー角丸半径の設定booleanfalse
styleカスタムボーダースタイルの設定booleanfalse
widthカスタムボーダー幅の設定booleanfalse

Top ↑

color

色関連の設定。

PropertyDescriptionTypeDefault
background背景色の設定booleantrue
customカスタム色の選択booleantrue
customDuotoneカスタムデュオトーンフィルターの作成booleantrue
customGradientカスタムグラデーションの作成booleantrue
defaultDuotoneデフォルトデュオトーンフィルタープリセットからフィルターを選択booleantrue
defaultGradientsデフォルトグラデーションから色を選択booleantrue
defaultPaletteデフォルトパレットから色を選択booleantrue
duotoneデュオトーンピッカーのデュオトーンプリセット[ { name, slug, colors } ]
gradientsグラデーションピッカーのグラデーションプリセット[ { name, slug, gradient } ]
linkブロック内のリンク色の設定booleanfalse
paletteカラーピッカーのカラーパレットプリセット[ { name, slug, color } ]
textブロック内のテキスト色の設定booleantrue
headingブロック内の見出し色の設定booleantrue
buttonブロック内のボタン色の設定booleantrue
captionブロック内のキャプション色の設定booleantrue

Top ↑

dimensions

寸法関連の設定。

PropertyDescriptionTypeDefault
aspectRatioアスペクト比の設定booleanfalse
defaultAspectRatiosアスペクト比のデフォルトセットからアスペクト比を選択booleantrue
aspectRatiosいくつかのブロックでアスペクト比を定義[ { name, slug, ratio } ]
minHeightカスタム最小高を設定booleanfalse

Top ↑

layout

レイアウト関連の設定。

PropertyDescriptionTypeDefault
contentSizeコンテンツの max-width を設定string
wideSize幅広 (.alignwide) コンテンツの max-width の設定。フルードフォントサイズ計算時の maximum viewport としても使用されるstring
allowEditingレイアウト UI コントロールの無効化booleantrue
allowCustomContentAndWideSizeカスタムコンテントとサイズコントロールの有効化、無効化booleantrue

Top ↑

lightbox 関連の設定。

PropertyDescriptionTypeDefault
enabledlightbox が有効化されているかどうかの定義boolean
allowEditingブロックエディター内で Lightbox UI を表示するかどうかの定義。false に設定すると、ユーザーはブロックエディター内で lightbox の設定を変更できないboolean

Top ↑

position

位置関連の設定。

PropertyDescriptionTypeDefault
sticky位置固定の設定booleanfalse

Top ↑

shadow

シャドー関連の設定

PropertyDescriptionTypeDefault
defaultPresetsデフォルトシャドープリセットからシャドーを選択booleantrue
presetsシャドーピッカーのシャドープリセット[ { name, slug, shadow } ]

Top ↑

spacing

スペース関連の設定。

PropertyDescriptionTypeDefault
blockGapstyles.spacing.blockGap から --wp--style--block-gap の生成を有効化booleannullnull
marginカスタムマージンの設定booleanfalse
paddingカスタムパディングの設定booleanfalse
unitsスペース値に利用可能な単位のリスト[ string ]["px","em","rem","vh","vw","%"]
customSpacingSizeカスタムスペースサイズの設定booleantrue
defaultSpacingSizesデフォルトスペースサイズプリセットからスペースサイズを選択booleantrue
spacingSizesスペースサイズセレクタのスペースサイズプリセット[ { name, slug, size } ]
spacingScaleスペースサイズセレクタの自動生成スペースサイズプリセットの設定{ operator, increment, steps, mediumStep, unit }

Top ↑

typography

タイポグラフィ関連の設定。

PropertyDescriptionTypeDefault
defaultFontSizesデフォルトのフォントサイズプリセットからフォントサイズを選択booleantrue
customFontSizeカスタムフォントサイズを設定booleantrue
fontStyleカスタムフォントスタイルを設定booleantrue
fontWeightカスタムフォントウエイトを設定booleantrue
fluidフルードタイポグラフィの有効化とグローバルフルードタイポグラフィパラメータの設定boolean{ minFontSize, maxViewportWidth, minViewportWidth }false
letterSpacingカスタム文字スペースの設定booleantrue
lineHeightカスタム行高の設定booleanfalse
textAlignテキスト配置の設定booleantrue
textColumnsテキストカラム数の設定booleanfalse
textDecorationカスタムテキスト装飾の設定booleantrue
writingMode執筆モードの設定booleanfalse
textTransformカスタムテキスト変換の設定booleantrue
dropCapドロップキャップの有効化booleantrue
fontSizesフォントサイズセレクタのフォントサイズプリセット[ { name, slug, size, fluid } ]
fontFamiliesフォントファミリーセレクタのフォントファミリープリセット[ { name, slug, fontFamily, fontFace } ]

Top ↑

custom

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


Top ↑

styles

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

Top ↑

background

背景のスタイル。

PropertyDescriptionType
backgroundImagebackground-image CSS プロパティの設定string{ ref }{ url }
backgroundPositionbackground-position CSS プロパティの設定string{ ref }
backgroundRepeatbackground-repeat CSS プロパティの設定string{ ref }
backgroundSizebackground-size CSS プロパティの設定string{ ref }
backgroundAttachmentbackground-attachment CSS プロパティの設定string{ ref }

Top ↑

border

ボーダーのスタイル。

PropertyDescriptionType
colorborder-color CSS プロパティの設定string{ ref }
radiusborder-radius CSS プロパティの設定string{ ref }{ topLeft, topRight, bottomLeft, bottomRight }
styleborder-style CSS プロパティの設定string{ ref }
widthborder-width CSS プロパティの設定string{ ref }
top{ color, style, width }
right{ color, style, width }
bottom{ color, style, width }
left{ color, style, width }

Top ↑

color

色のスタイル。

PropertyDescriptionType
backgroundbackground-color CSS プロパティの設定string{ ref }
gradientbackground CSS プロパティの設定string{ ref }
textcolor CSS プロパティの設定string{ ref }

Top ↑

css

カスタム CSS を設定します。他の theme.json プロパティではカバーされないスタイルを適用できます。


Top ↑

dimensions

寸法のスタイル。

PropertyDescriptionType
aspectRatioaspect-ratio CSS プロパティの設定string{ ref }
minHeightmin-height CSS プロパティの設定string{ ref }

Top ↑

filter

CSS と SVG フィルターのスタイル。

PropertyDescriptionType
duotoneデュオトーンフィルターの設定string{ ref }

Top ↑

outline

アウトラインのスタイル。

PropertyDescriptionType
coloroutline-color CSS プロパティの設定string{ ref }
offsetoutline-offset CSS プロパティの設定string{ ref }
styleoutline-style CSS プロパティの設定string{ ref }
widthoutline-width CSS プロパティの設定string{ ref }

Top ↑

shadow

ボックスシャドーのスタイル。


Top ↑

spacing

スペースのスタイル。

PropertyDescriptionType
blockGapsettings.spacing.blockGap が true のときの --wp--style--block-gap CSS プロパティの設定string{ ref }
marginマージンスタイル{ top, right, bottom, left }
paddingパディングスタイル{ top, right, bottom, left }

Top ↑

typography

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

PropertyDescriptionType
fontFamilyfont-family CSS プロパティの設定string{ ref }
fontSizefont-size CSS プロパティの設定string{ ref }
fontStylefont-style CSS プロパティの設定string{ ref }
fontWeightfont-weight CSS プロパティの設定string{ ref }
letterSpacingletter-spacing CSS プロパティの設定string{ ref }
lineHeightline-height CSS プロパティの設定string{ ref }
textAligntext-align CSS プロパティの設定string{ ref }
textColumnscolumn-count CSS プロパティの設定string{ ref }
textDecorationtext-decoration CSS プロパティの設定string{ ref }
writingModewriting-mode CSS プロパティの設定string{ ref }
textTransformtext-transform CSS プロパティの設定string{ ref }

Top ↑

customTemplates

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

PropertyDescriptionType
nameテンプレートフォルダ内のテンプレートのファイル名。拡張子なしstring
titleテンプレートのタイトル。翻訳可string
postTypesこのカスタムテンプレートを使える投稿タイプのリスト[ string ]

Top ↑

templateParts

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

PropertyDescriptionType
nameパーツフォルダ内のテンプレートのファイル名。拡張子なしstring
titleテンプレートのタイトル。翻訳可string
areaテンプレートパーツが使用されるエリア。header 値と footer 値のブロックバリエーションが存在し、エリアがそのどちらかと設定された際に使用されるstring

Top ↑

patterns

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

型: [ string ]

原文

最終更新日: