2024
01/12

ブロックエディタ以前しか知らないWordPress老人がtheme.jsonについて学ぶ

前回の記事に引き続き、今回はtheme.jsonについて調べました。

ADs

theme.jsonとは何か

theme.jsonはテーマ全体の設定ファイルで、そのテーマのルートディレクトリに「theme.json」という名前のファイルを置きます。

theme.jsonは中身が空であっても存在するだけでエディタに影響を及ぼします。

theme.jsonが存在することで起きる違い

まず呼ばれるCSSのクエリが異なります。

そしてwindow._wpLoadBlockEditorという関数内の引数が異なります。

これによってブロックエディタの挙動やインターフェイスが異なります。

記事編集画面
theme.jsonがあるとき
theme.jsonがないとき
サイトエディター
theme.jsonがあるとき
theme.jsonがないとき

theme.jsonの有無で管理画面がどのように変わるかはエビスコム様の記事が非常に詳しいです。
WordPressのテーマにtheme.jsonを追加したら起きること | エビスコム - EBISUCOM

theme.jsonの中身

それではtheme.jsonの中身を見ていきます。
https://schemas.wp.org/trunk/theme.jsonを読みながら解読しましたので最新バージョンのWordPress(記事執筆時は6.4)で問題なく動作すると思います。

$schemaとversion

この2行を書いておくことでVSCodeなどのエディタでオートコンプリートやツールチップの表示などの入力支援が使えるようになります。
$schemaはなくてもかまいませんがversionは必須です。

patterns

WordPressのパターンディレクトリで公開されているパターンを読み込み、エディタの「パターン」欄に表示することができます。もちろん選択すればそのパターンを記事中で使用することができます。配列でパターンのスラッグを指定します。

たとえば「quote-ja」はこのパターンのことです。

settings

すべてのブロックに対する設定を定義します。後述のblocksセクションで各ブロック個別に設定を上書きすることもできます。

settings.appearanceTools

trueにすることでブロックエディタの各種機能が有効になります。

settingsセクションで以下の設定をすることと同じ意味合いになります(settingsの各項目は後述)

主に装飾関連の機能が有効になりますので、ブロックエディタを採用するなら基本的にはtrueでいいと思います。

settings.useRootPaddingAwareAlignments

true二設定するとルートブロック(bodyのこと)の代わりに全幅ブロックの内容に、ルートパディング (styles.spacing.paddingの値) を適用します。

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

要はstyles.spacing.paddingの値をbodyではなく全幅ブロックに適用するという設定です。
これによって幅いっぱいのブロックを使いたいけどbodyのpaddingがあるから全幅にならない、という問題を回避できます。

以下の記事が詳しく参考になりました。
【WordPress6.1】theme.json の変更点#settings.useRootPaddingAwareAlignments

settings.border

枠線を有効にします。

settings.shadow

影(box-shadow)のプリセットを設定します。

defaultPresets・・・デフォルトのプリセットを表示するかどうか
presets・・・プリセットとして表示させる項目。配下オブジェクトはname,slug,shadowの項目を持ちます。

settings.color

色選択時のパレットに関する設定をします。

background・・・背景色指定を有効にするかどうか
custom・・・色選択で好きな色を選択できるようにするかどうか
customDuotone・・・デュオトーン(画像のフィルタ)設定時に好きな色を選択できるようにするかどうか
customGradient・・・グラデーション選択時に好きな色を選択できるようにするかどうか

defaultDuotone・・・デュオトーンのデフォルトプリセットを表示するかどうか
defaultPalette・・・カラーパレットのデフォルトプリセットを表示するかどうか
defaultGradients・・・グラデーションパレットのデフォルトプリセットを表示するかどうか

もしdefault…の設定をfalseにした場合、以下のようにプリセットの選択肢が表示されません。プリセットが必要な場合は後述のduotone / gradients / paletteで自前で定義する必要があります。

duotone / gradients / palette
デュオトーン・グラデーション・カラーパレットで使用する色を設定します。

link・・・リンク文字色を指定できるかどうか
text・・・文字色を指定できるかどうか
heading・・・見出し文字色を指定できるかどうか
button・・・ボタンの色を指定できるかどうか

settings.background

背景画像を有効にします。

現時点(WordPress 6.4)ではsettings.background配下はbackgroundImageだけです。

settings.dimensions

min-heightを指定できるようにするかを設定します。

現時点(WordPress 6.4)ではsettings.dimensions配下はminHeightだけです。

settings.layout

コンテンツ幅を設定します。

contentSizeとwideSizeについては、CSSでは

と指定されるため(–wp–style–global–content-sizeがcontentSizeにあたる)、この設定値を有効とするにはコンテンツ全体を囲うis-layout-constrainedというクラスのdivを配置する必要があります。

allowEditing・・・コンテンツ幅をエディタ上で変更できるようにするかどうか
allowCustomContentAndWideSize・・・カラム幅の設定を可能にするかどうか

settings.lightbox

画像に対し、ライトボックスで開く機能を有効にするかどうかを設定します。

enabled・・・有効/無効をtrue/falseで指定
allowEditing・・・エディタ上に編集画面を表示するかどうかをtrue/falseで指定

settings.position

位置指定で張り付き(sticky)を選択可能にするかどうかを設定します。

settings.spacing

マージン・パディング・ブロックの間隔で使用するサイズの選択値や単位を定義します。

blockGap・・・ブロックの間隔を使用するかどうか
margin・・・マージンを使用するかどうか
padding・・・パディングを使用するかどうか

units・・・スペース関連で使用する単位。
customSpacingSize・・・trueにするとspacingSizesで設定したプリセットを選択肢として使用できます。

spacingSizes.settings.spacing

スペースの選択肢として使用できるプリセットを定義します。
name・・・表示名称
size・・・適用される値
slug・・・プリセットのスラッグ。10,20,30…と10ごとの数値が推奨されています。

settings.spacing.spacingScale

スペースの選択肢で使用するプリセット値を自動で生成します。

operator・・・「+」なら加算、「*」なら乗算
increment・・・増加する割合
steps・・・生成する選択肢の数
mediumStep・・・中間値
unit・・・単位

たとえば極端な例ですがマージンやパディングで5,50,500remの選択肢を用意したい場合は以下のようになります。

settings.typography

フォントや文字サイズなどタイポグラフィの選択肢を設定します。

customFontSize・・・カスタムフォントサイズを使用するかどうか
dropCap・・・ドロップキャップを有効にするかどうか
fluid・・・ウインドウサイズによる流動的なフォントサイズをサポートするかどうか
fontStyle・・・外観(イタリック)を有効にするかどうか
fontWeight・・・フォントウェイトを有効にするかどうか
letterSpacing・・・文字間隔を有効にするかどうか
lineHeight・・・行間を有効にするかどうか
textColumns・・・column-countを有効にするかどうか
textDecoration・・・テキスト装飾(アンダーラインや取り消し線)を有効にするかどうか
textTransform・・・大文字小文字を有効にするかどうか
writingMode・・・文字の方向(縦書き・横書き)を有効にするかどうか

settings.typography.fontFamilies

選択できるフォントの種類を配列で指定します。

fontFaceの各項目
fontFaceはウェイトやスタイルが違うフォントを指定します。Webフォントでウェイト別・スタイル別にフォントファイルを読み込ませる必要がある場合に使用します。
fontFamilysrcが必須です。

ウェイト・スタイル別のフォントファイル読み込みが不要な場合はfontFaceセクションは必要ありません。
fontFamilyにCSS、nameに表示名称、slugにユニークな名前(ケバブケースで書く)を設定します。

ascentOverride・・・ascentOverrideの値
descentOverride・・・descentOverrideの値

※それぞれこちらを参照

以下はCSSの値をそのまま入力します。

fontDisplay・・・font-displayの値。’auto’, ‘block’, ‘fallback’, ‘swap’, ‘optional’のどれか
fontFamily・・・font-familyの値。
fontFeatureSettings・・・font-feature-settingsの値
fontStretch・・・font-stretchの値
fontStyle・・・font-styleの値
fontVariant・・・font-variantの値
fontVariationSettings・・・font-variation-settingsの値
fontWeight・・・font-weightの値。
lineGapOverride・・・line-gap-overrideの値。
sizeAdjust・・・size-adjustの値。
unicodeRange・・・unicode-rangeの値。

以下はWebフォント用の設定です。

src・・・フォントファイルのパスを入力します。配列か文字列が許容されます。
例:

preview・・・フォントのプレビュー用画像のパスです。文字列で入力します。

styles

サイトやブロックに適用するCSSを設定します。
styleセクションに書いた設定はbodyに適用され(settings.useRootPaddingAwareAlignmentsがfalseの場合)、styles.blocks.[ブロック名]セクションに書いた設定は各ブロック個別に適用されます。

たとえば以下のように書くと、bodyに

が適用されます。

適用できる設定は以下の通りです。

このスタイルの書き方は後述のelementsでも使用します。

styles.typography

文字関連のCSSを設定します。styles.typographyの場合はbodyに適用されます。

styles.elements

button、link(テキストリンク)、heading、caption、cite、h1~h6のスタイルを設定します。

styles.elements.button

styles.elements.caption
styles.elements.cite
styles.elements.h1~h6
styles.elements.heading

stylesと全く同じです。

styles.elements.link

styles.blocks

ブロック個別にスタイルを設定したい場合はstyles.blocks.[ブロック名]として記述します。

styles.blocks.[ブロック名].elements

ブロック内に含まれるbutton、link(テキストリンク)、heading、caption、cite、h1~h6にスタイルを適用したいときにエレメント名を指定して記載します。
styles.elementsでの指定より優先されます。

たとえばカレンダー内のh2は赤文字にしたい場合

とします。

styles.blocks.[ブロック名].variations

variationsという項目は既存のブロックのスタイルを上書きするために使います。
variations配下のスタイルがそのブロックのCSSに追加するかたちで適用されます。

なお、標準ブロックの名称は以下のとおりです

core/archives
core/audio
core/avatar
core/block
core/button
core/buttons
core/calendar
core/categories
core/code
core/column
core/columns
core/comment-author-avatar
core/comment-author-name
core/comment-content
core/comment-date
core/comment-edit-link
core/comment-reply-link
core/comments
core/comments-pagination
core/comments-pagination-next
core/comments-pagination-numbers
core/comments-pagination-previous
core/comments-title
core/comment-template
core/cover
core/details
core/embed
core/file
core/freeform
core/gallery
core/group
core/heading
core/home-link
core/html
core/image
core/latest-comments
core/latest-posts
core/list
core/list-item
core/loginout
core/media-text
core/missing
core/more
core/navigation
core/navigation-link
core/navigation-submenu
core/nextpage
core/page-list
core/page-list-item
core/paragraph
core/post-author
core/post-author-biography
core/post-author-name
core/post-comment
core/post-comments-count
core/post-comments-form
core/post-comments-link
core/post-content
core/post-date
core/post-excerpt
core/post-featured-image
core/post-navigation-link
core/post-template
core/post-terms
core/post-time-to-read
core/post-title
core/preformatted
core/pullquote
core/query
core/query-no-results
core/query-pagination
core/query-pagination-next
core/query-pagination-numbers
core/query-pagination-previous
core/query-title
core/quote
core/read-more
core/rss
core/search
core/separator
core/shortcode
core/site-logo
core/site-tagline
core/site-title
core/social-link
core/social-links
core/spacer
core/table
core/table-of-contents
core/tag-cloud
core/template-part
core/term-description
core/text-columns
core/verse
core/video
core/widget-area
core/legacy-widget
core/widget-group

templateParts

parts配下にHTMLファイルを置くことでサイトエディターの「テンプレートパーツ」上で選択できるようになりますが、そのときに表示する名称を指定します。

area(任意)・・・テンプレートパーツを使用するエリア(headerかfooter)
name(必須)・・・ファイル名から拡張子を除いた名称
title(任意)・・・エディタ上に表示される名称

customTemplates

templates 配下にHTMLファイルを置くことでサイトエディターの「テンプレート」で選択できるようになりますが、そのときに表示する名称を指定します。

name(必須)・・・ファイル名から拡張子を除いた名称
postTypes(任意)・・・テンプレートが使用できる投稿タイプを配列で指定([‘page’,’post’]など)
title(必須)・・・エディタ上に表示される名称

まとめ

くぅ~疲れましたw 本当に疲れた…。

見ての通りtheme.jsonの設定可能な項目は非常に多いですが、デフォルトのままでいい内容も多く、さらに一度作成すれば使い回しができると思いますので、サイト制作の度にtheme.jsonが大きな負担になることはないと思います(思いたい)。

ということで、次回はいよいよオリジナルなブロックの作成に挑戦してみようと思います。

ADs

Post Comments

メールアドレスが公開されることはありません。

Comments

コメントはまだありません。