コンテンツへスキップ

コンポーネント

コンポーネントはBlockstudioブロックです。属性、テンプレート、アセット、RPC、Tailwindを含む全工程を通りますが、WordPressエディターのインサーターには表示されません。プログラムからのみレンダリングする再利用可能なUI要素の構築を目的としています。

block.json

blockstudioオブジェクトでcomponentプロパティをtrueに設定します:

JSON
{
  "$schema": "https://blockstudio.dev/schema/block",
  "name": "my-theme/card",
  "title": "Card",
  "blockstudio": {
    "component": true,
    "attributes": [
      {
        "id": "title",
        "type": "text",
        "label": "Title"
      },
      {
        "id": "description",
        "type": "textarea",
        "label": "Description"
      }
    ]
  }
}

レンダリング

コンポーネントは2つの方法でレンダリングできます:

文字列レンダラー

ページテンプレートまたは投稿コンテンツで<bs:>タグを使います:

HTML
<bs:my-theme-card title="My Card" description="Card content." />

PHP

PHPテンプレートでbs_render_block()またはbs_block()を使います:

PHP
bs_render_block([
  'name' => 'my-theme/card',
  'attributes' => [
    'title' => 'My Card',
    'description' => 'Card content.',
  ],
]);

対応機能

コンポーネントはBlockstudioのすべての機能に対応しています:

  • 属性とフィールドタイプ
  • PHP、Twig、Bladeテンプレート
  • CSS/SCSSアセット(コンポーネントのレンダリング時に読み込み)
  • Tailwind CSS
  • サーバー関数(RPC)
  • スコープ付きスタイル

対象外の機能

コンポーネントはエディターに表示されないため、次の制約があります:

  • ブロックエディターのプレビューは利用できません
  • ブロックインサーターの検索対象になりません
  • コンポーネントではregisterBlockType()は呼び出されません