一般
Blockstudio Registryは、ホストされたレジストリからWordPressブロックを配布、インストールするためのCLIツールです。
shadcn/uiのような仕組みですが、WordPressブロック向けです。インストールするnpmパッケージはありません。コマンドを実行すると、ブロックのソースコードがプロジェクトにコピーされ、すべてを自分で管理できます。
仕組み
- ブロックの作者が、利用可能なブロックを一覧にした
registry.jsonをURLに公開します。 - 利用したいレジストリを指定する
blocks.jsonをテーマまたはプラグインに追加します。 npx blockstudio add ui/tabsを実行すると、ブロックフォルダーがプロジェクトに配置されます。
これだけです。CLIがファイルをダウンロードし、依存関係を解決してディスクに書き込みます。変換処理は行いません。WordPressブロックフォルダーは、どこでも同じです。
サポート対象
レジストリはブロックの種類を問いません。フォルダーをコピーする仕組みなので、ディレクトリに置かれたブロックならどれでも使えます。
- Blockstudioブロック:
block.json+ PHP/Twig/Bladeテンプレート + オプションのアセット @wordpress/create-blockブロック:edit.jsやsave.jsなどを含む、ビルド済みの完全なJS出力- プレーンなPHPブロック:
register_block_type()で登録された任意のブロック - 静的ブロック:
block.jsonだけを持ち、サーバー側のレンダリングを行わないブロック
CLIはフォルダーの中身を問いません。レジストリのファイルマニフェストを読み取り、そこに記載されたファイルだけをダウンロードします。
WordPress管理画面
有効なテーマにレジストリを設定したblocks.jsonがある場合、同じレジストリがwp-admin内のツール > Blockstudio > Registryにも表示されます。
この管理画面のブラウザーでは、CLIに触れずに利用可能なブロックを確認してインポートできます。設定形式は同じです。引き続きblocks.jsonが信頼できる情報源になります。
クイックスタート
シェル
npx blockstudio init
npx blockstudio add ui/tabs
セットアップの全手順ははじめにをご覧ください。