ブロック属性
$attributesまたは$a変数からアクセスできるのは、blockstudioプロパティに登録されたデータだけです。配置やタイポグラフィなど、標準のWordPressブロックデータにアクセスするには、$blockまたは$b変数を使用してください。
レンダリング
PHP
<h1>The block is aligned: <?php echo $block['align']; ?></h1>
<h1>The block is aligned: <?php echo $b['align']; ?></h1>
Twig
<h1>The block is aligned: {{ block.align }}</h1>
<h1>The block is aligned: {{ b.align }}</h1>
デフォルト値の設定
予約済みフィールドID
WordPressが所有する属性を、同じトップレベルIDのBlockstudioフィールドとして宣言してはいけません。anchor、className、style、lock、metadataは予約済みです。また、Blockstudioの内部blockstudio、__BLOCKSTUDIO_KEY、blockEditingMode属性も予約済みです。
有効になっているWordPress機能も、それぞれの属性名を予約します。該当する場合、align、backgroundColor、textColor、gradient、fontSize、fontFamily、layout、borderColor、shadow、ariaLabelが対象です。これらの属性をネイティブ宣言した場合も、その名前は予約されます。これにより、たとえばコアの文字列alignが選択フィールドのオプションオブジェクトで置き換えられるのを防ぎます。
競合するフィールドは登録時にスキップされ、blockstudio/error/logged(有効な場合はWordPressデバッグログ)に、ブロック名とフィールド名が記録されます。そのフィールドのエディターコントロール、保存ハンドラー、レンダリング定義は登録されません。フィールド名をheadingAlignに変更するか、presentationのような名前付きグループ内に配置してpresentation_alignを生成してください。リピーター行のフィールドは行の内部にあるため、トップレベルの競合にはなりません。通常のalignフィールドは、配置サポートが無効でネイティブのalign属性が存在しない場合も有効です。
既存のブロックを更新する際に競合がある場合は、フィールド名を変更し、保存済みのフィールド値を新しいIDに移行してください。Blockstudioは保存済みコンテンツの名前を自動的に変更したり、WordPressのサポートを削除したりしません。
ネイティブ属性のデフォルト値
WordPressプロパティ(alignなど)のデフォルト値を設定するには、attributesキー内にdefaultキーを追加します:
{
"$schema": "https://blockstudio.dev/schema/block",
"name": "blockstudio/block",
"title": "Native Block",
"icon": "star-filled",
"description": "Native Block.",
"supports": {
"align": ["left", "center", "right"]
},
"attributes": {
"align": {
"type": "string",
"default": "center"
}
},
"blockstudio": true
}
利用可能なブロックデータ
$block / $b変数には次の情報が含まれます:
| プロパティ | 説明 |
|---|---|
name |
ブロック名(e.g、my-theme/my-block) |
title |
ブロックのタイトル |
dir |
ブロックディレクトリのパス |
url |
ブロックディレクトリのURL |
align |
配置の値(supports.alignが有効な場合) |
className |
カスタムCSSクラス(supports.customClassNameが有効な場合) |
anchor |
HTMLアンカー/ID(supports.anchorが有効な場合) |
WordPressのサポート
supportsプロパティでWordPressブロック機能を有効にします:
{
"supports": {
"align": true,
"anchor": true,
"customClassName": true,
"color": {
"background": true,
"text": true
},
"spacing": {
"margin": true,
"padding": true
},
"typography": {
"fontSize": true,
"lineHeight": true
}
}
}
利用可能なオプションについては、WordPressブロックサポートのドキュメントをご覧ください。