コンテンツへスキップ

CLI

Blockstudioは、ターミナルからブロック、ファイルベースのページ、データベースレコード、RPC関数、cronジョブ、設定、WPML言語設定を管理するWP-CLIコマンドを登録します。

ブロック

すべてのブロックを一覧表示

シェル
wp bs blocks list
コード
+----------------------------+---------------------+-----------+------------------------+
| name                       | title               | component | category               |
+----------------------------+---------------------+-----------+------------------------+
| my-theme/hero              | Hero                |           | my-theme               |
| my-theme/card              | Card                | yes       | my-theme               |
| my-theme/newsletter        | Newsletter          |           | my-theme               |
+----------------------------+---------------------+-----------+------------------------+

コンポーネントのみに絞り込む

シェル
wp bs blocks list --components

JSON形式で出力

シェル
wp bs blocks list --format=json

保存済みフィールドを検証する

シェル
wp bs blocks validate 42
wp bs blocks validate 42 57 --format=json

指定した投稿IDの保存済みコンテンツを、ネストされたinnerBlocksも含めてbs_validate_block()を使用して確認します。 ブロックのレンダリング、同期パターン参照の展開、投稿の変更は行いません。 Blockstudio拡張機能のない不明なブロックはスキップされます。

既定のテーブルには、投稿ID、ゼロ始まりのブロックパス、ブロック名、検出コード、フィールドパス、ソース、メッセージが表示されます。JSONには元のvalue値とexpected値も含まれます。ネストされたブロックでは、ブロックパスが0/1、フィールドパスがcards/2/styleとなる場合があります。これらは別々のパスです。

検出事項がない場合、コマンドは0で終了し、検出事項がある場合は1で終了します。 JSON出力は成功時の[]も含めたプレーンなリストなので、コマンドが1で終了した場合でも自動化処理で読み取れます。投稿が見つからない場合、IDがない場合、tableまたはjson以外の形式を指定した場合はエラーです。検証を始める前に、すべてのIDを確認します。

ブロックをレンダリングする

シェル
wp bs blocks render
wp bs blocks render my-theme/hero my-theme/card
wp bs blocks render my-theme/card --attributes='{"variant":"wide"}'
wp bs blocks render my-theme/card --attributes=@card.json --format=json

ページと同じ方法で登録済みブロックをレンダリングし、テンプレートが出すPHP通知、警告、非推奨通知、スローされたエラーをすべて報告します。テーマでは、CIでコマンドを実行して、インストール済みのBlockstudioに対するブロックのスモークテストを行えます。名前を指定しない場合は、コンポーネントも含め、登録済みのすべてのブロックがレンダリングされます。

各ブロックはdo_blocks()を通じて、ブロックコメントからレンダリングされます。blockstudio.attributesはエディターが保存する形式であり、挿入画面のプレビューではなくWP-CLIのフロントエンドコンテキストで使用されます。レンダリング用にクエリ対象の投稿は設定されません。動的アイランドはプレースホルダーだけでなく実際のテンプレート本文をレンダリングし、付随的なテンプレート出力はレポートに含めません。

コマンド自体は投稿やフィールド値を保存しませんが、通常のPHPと同様にテンプレートやレンダリングフックを実行します。これらはデータを書き込んだり、外部サービスを呼び出したり、その他の副作用を起こしたりする可能性があります。信頼できるコードを専用のテストサイトで実行してください。これは読み取り専用のサンドボックスではありません。

レンダリングに使う属性はブロックごとに選択されます。

ケース 属性
example ブロックのblock.jsonにあるexample.attributes、つまり挿入画面のプレビューで使われる値です。
defaults 各フィールドのdefault。example.attributesのないブロックで使用され、コマンドはそれぞれのフィールドについて1行を出力します。
attributes 例を置き換える、--attributesの値です。

--attributesには、ストレージキーをキーとするフィールド値のJSONオブジェクト、または@とそのオブジェクトを含むファイルのパスを指定します。ブロック名は1つだけ指定する必要があります。例では表示されないテンプレート分岐(バリアントなど)の確認に使います。挿入画面のプレビューでプレースホルダー画像だけを生成する例の値はスキップされ、例のinnerBlocksはレンダリングされません。

コード
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+
| block               | case     | level      | message                                                                       | file                                                                         | line |
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+
| smoke/deprecated    | defaults | Deprecated | strlen(): Passing null to parameter #1 ($string) of type string is deprecated | /wordpress/wp-content/themes/smoke-theme/blockstudio/deprecated/index.php    | 1    |
| smoke/undefined-key | example  | Warning    | Undefined array key "subtitle"                                                | /wordpress/wp-content/themes/smoke-theme/blockstudio/undefined-key/index.php | 2    |
+---------------------+----------+------------+-------------------------------------------------------------------------------+------------------------------------------------------------------------------+------+

テーブルには問題ごとに1行が表示されます。JSON出力は、問題のないブロックも含め、レンダリングされたブロックごとに1つのエントリを含むリストです。そのため、どのケースが使われたかを自動化処理で読み取れます。

JSON
[
  {
    "block": "smoke/branch",
    "case": "attributes",
    "problems": [
      {
        "level": "Warning",
        "message": "Undefined array key \"width\"",
        "file": "/wordpress/wp-content/themes/smoke-theme/blockstudio/branch/index.php",
        "line": 2
      }
    ]
  }
]

levelはNotice、Warning、Deprecated、またはErrorです。同じファイルと行で繰り返し発生する問題(ループ内での発生など)は、ブロックごとに1回報告されます。@で無効化した問題は報告されません。WordPressが独自に出す非推奨通知(_deprecated_function()の通知など)は、WP_DEBUGが有効な場合にのみ報告されます。

問題が見つからない場合、コマンドは0で終了し、それ以外の場合は1で終了します。不明なブロック名、読み取り不能または無効な--attributes、tableまたはjson以外の形式はエラーです。最初のブロックをレンダリングする前に、すべての名前を確認します。

ページ

ファイルベースのページ同期は明示的に実行します。通常のWordPressリクエストでは、ページ全体の検出やページ投稿の書き込みは行いません。コールドランタイムでは、コンテンツを同期せずにルートを復元するため、コレクションのマニフェストを一度読み取ることがあります。

シェル
wp bs pages sync

コマンドは、必要なインベントリ全体を照合し、検出、作成、更新、変更なし、ロック、保持、削除、失敗の各ページ数を報告します。フィンガープリントが一致する場合、投稿や投稿メタデータへの書き込みは発生しません。

テーブル出力では、変更、ロック、コンテンツ保持、削除されたページとその投稿IDが示されます。JSONには、ページ名、キー、投稿ID、クリーンアップ操作を記載したpages.<name>.preserved、pages.<name>.overwritten、removedPagesの各エントリが含まれます。キーによるマージ後に投稿が同一であれば、変更なしとして報告され、リビジョンの作成や更新日時の変更は行われません。

既存の公開ステータスは保持されます。ファイル所有のタイトルやスラッグを置き換える場合は、警告として表示されます。投稿フィールドの所有権を参照してください。

キー付きのエディターコンテンツを保持せず管理対象コンテンツで置き換えるには--authoritativeを使います。また、保存されたソース識別情報にかかわらず、処理を完全な調整として報告するには--fullを使います。どちらの場合も、毎回インベントリ全体を比較します。

シェル
wp bs pages sync --authoritative --full

完全なレポートが必要なデプロイスクリプトでは、次を使用します。

シェル
wp bs pages sync --format=json

このコマンドが解析する各ページでは、ブロックが保存するもののレンダリングしない属性を確認します。たとえば、Blockstudioブロックがフィールドとして宣言せず、ルート要素にも渡さない属性(未宣言のclassなど)です。テーブル出力にはページとブロックごとに警告を表示し、dropped列には件数を表示し、JSONレポートにはpages.<name>.droppedAttributesの下に詳細を列挙します。ソースが変更されていないページは再解析されないため、次回の変更時、またはパーサーを変更するアップグレード後の最初の同期時に報告されます。

検出または調整でエラーが報告されると、コマンドは失敗を示す終了ステータスを返します。PHPAPIとデプロイ時の識別情報の仕様については、ページを参照してください。

データベース

スキーマを一覧表示

シェル
wp bs db schemas
コード
+-------------------+-------------+---------+---------------------+
| block             | schema      | storage | fields              |
+-------------------+-------------+---------+---------------------+
| my-theme/app      | subscribers | table   | email, name, plan   |
| my-theme/app      | logs        | jsonc   | action, details     |
| my-theme/app      | events      | storh   | title, status       |
+-------------------+-------------+---------+---------------------+

CRUD操作

シェル
# List records
wp bs db list my-theme/app subscribers

# List with filters
wp bs db list my-theme/app subscribers --plan=pro --limit=10

# Get a single record
wp bs db get my-theme/app subscribers 1

# Create a record
wp bs db create my-theme/app subscribers --email=a@b.com --plan=pro

# Update a record
wp bs db update my-theme/app subscribers 1 --plan=enterprise

# Delete a record
wp bs db delete my-theme/app subscribers 1

スキーマが1つだけのブロックでは、スキーマ名のデフォルトはdefaultです。

シェル
wp bs db list my-theme/leads

JSONCレコードをStorhに移行

スキーマにdb/{schema}.jsoncファイルがすでにあり、レコードをStorhファイルバックエンドに移行する場合は、migrateを使用します。

シェル
wp bs db migrate my-theme/app subscribers --to=storh

単一スキーマのブロックの場合:

シェル
wp bs db migrate my-theme/app --to=storh

このコマンドは整数のレコードIDを維持し、uploads/blockstudio/db/{block-scope}/{schema}/に書き込み、Storhインデックスを再構築して、移行先のストアを検証します。移行元の.jsoncファイルはそのまま残します。

出力形式

すべての一覧コマンドは、--format=table(デフォルト)、--format=json、--format=csvに対応しています。

シェル
wp bs db list my-theme/app subscribers --format=json

RPC

すべての関数を一覧表示

シェル
wp bs rpc list
コード
+-------------------+-------------+--------+----------------+---------+
| block             | function    | public | capability     | methods |
+-------------------+-------------+--------+----------------+---------+
| my-theme/app      | subscribe   | yes    |                | POST    |
| my-theme/app      | stats       |        | edit_posts     | POST    |
| my-theme/app      | get_status  |        |                | GET,POST|
+-------------------+-------------+--------+----------------+---------+

関数を呼び出す

シェル
wp bs rpc call my-theme/app subscribe --email=user@example.com

出力形式はJSONです。

JSON
{
  "success": true
}

パラメーターは--key=valueフラグとして渡します。

シェル
wp bs rpc call my-theme/app load_more --offset=10 --limit=5

Cron

すべてのジョブを一覧表示

シェル
wp bs cron list
コード
+-------------------+----------+----------+---------------------+
| block             | job      | schedule | next_run            |
+-------------------+----------+----------+---------------------+
| my-theme/app      | cleanup  | daily    | 2026-03-17 00:00:00 |
| my-theme/app      | sync     | hourly   | 2026-03-16 15:00:00 |
+-------------------+----------+----------+---------------------+

ジョブを手動で実行

シェル
wp bs cron run my-theme/app cleanup

スケジュールに関係なく、コールバックをただちに実行します。テストやデバッグに便利です。

設定

すべての設定を表示

シェル
wp bs settings list

特定の設定を取得

シェル
wp bs settings get tailwind/enabled
wp bs settings get assets/enqueue

Tailwind

HTMLをCSSにコンパイル

シェル
wp bs tailwind compile '<div class="flex items-center p-4">'

ファイルからコンパイル

シェル
wp bs tailwind compile --file=template.html

キャッシュ管理

シェル
wp bs tailwind cache path    # show cache directory
wp bs tailwind cache clear   # clear compiled cache

SCSS

SCSSをCSSにコンパイル

シェル
wp bs scss compile '$color: red; .test { color: $color; }'

ファイルからコンパイル

シェル
wp bs scss compile --file=styles.scss

カスタムフィールド

登録済みのカスタムフィールドをすべて一覧表示

シェル
wp bs fields list
コード
+-------+----------------+---------------------------+
| name  | title          | fields                    |
+-------+----------------+---------------------------+
| hero  | Hero Section   | heading, description, cta |
| card  | Card           | title, image, link        |
+-------+----------------+---------------------------+

アセット

すべてのアセットを一覧表示

シェル
wp bs assets list

タイプで絞り込む

シェル
wp bs assets list --type=global
wp bs assets list --type=admin
wp bs assets list --type=editor
wp bs assets list --type=registered

スクリプト

すべてのコマンドは、パイプで簡単に連携できる--format=jsonに対応しています。

シェル
# Export all subscribers as JSON
wp bs db list my-theme/app subscribers --format=json > subscribers.json

# Count records
wp bs db list my-theme/app subscribers --format=json | jq length

# Batch delete
wp bs db list my-theme/app logs --format=json | \
  jq -r '.[].id' | \
  xargs -I {} wp bs db delete my-theme/app logs {}

コンテンツ同期

Content Syncでは、許可リストに登録されたWordPressコンテンツをファイルに書き出し、それらのファイルをデータベースに反映します。明示的なCLI駆動の仕組みであり、ページ読み込み時や管理画面の初期化時には同期しません。

設定、ファイル形式、データベースコンテンツにファイルベースの方式が適している状況については、Content Syncを参照してください。

データベースのコンテンツをファイルに取り込む

シェル
wp bs content pull

取り込み対象を設定済みの投稿タイプまたはタクソノミー1つに限定します:

シェル
wp bs content pull --post-type=team_member
wp bs content pull --taxonomy=category

UIDやファイルを書き込まずにプレビューします:

シェル
wp bs content pull --dry-run

ファイルをデータベースに反映する

シェル
wp bs content push

書き込みを行わずに適用計画をプレビューします:

シェル
wp bs content push --dry-run

ファイルに存在しなくなった、コンテンツセットが所有するデータベースの投稿とタームを削除します:

シェル
wp bs content push --prune --yes

--prune を指定すると、Blockstudio はまずすべてのファイル変更を適用し、その後ファイルに存在しなくなったコンテンツセット所有のエンティティを削除します。--yes が指定されていない場合、破壊的な削除は実行されません。

ステータスを確認する

シェル
wp bs content status

この表では、ファイルに対応する各エンティティを unchanged、would-update、missing-db、conflict、locked、または orphaned として報告します。

静的プリレンダリング

キャッシュについては 静的プリレンダリング を参照してください。これらのコマンドはキャッシュを操作します。

古いエントリーをウォームアップする

シェル
wp bs prerender warm

古くなった公開URLをキューに追加し、永続ウォームキューから最大warm.concurrency件のジョブを再レンダリングして、JSON、queued、processed、warmed、skippedの件数を含むfailedサマリーを出力します。コンテンツやサイトに変更があると、置き換え用のジョブが自動的にキューに追加されます。大きなキューを処理するには、コマンドを再度実行するか、スケジュール済みウォーマーに任せてください。レンダリングに失敗したURLは古い状態のまま残り、次回の実行時に再びキューに追加されます。graphモードでは、URLごとのウォーマーは無効になり、このコマンドは何もキューに追加しません。

キャッシュの状態を報告する

シェル
wp bs prerender status

現在のID、ファイル、バイト数、グラフレコード、キューの状態、早期配信マップのレポート、およびスコープごとのヒット/ミス/ビルド/失敗の件数を報告します。

キャッシュを消去する

シェル
wp bs prerender purge

現在のサイトのプリレンダリング済みドキュメントを削除します。次の匿名リクエストまたはウォームアップ処理で再構築されます。

早期配信マップを確認して整理する

シェル
wp bs prerender map status
wp bs prerender map prune --dry-run
wp bs prerender map prune

map status はインストール全体の早期配信マップについて、エントリーとルート、存在しないルートのドキュメント、サイトがなくなったorphanedエントリー、ディレクトリがなくなったdeadエントリーを報告します。map prune は孤立したエントリーと無効なエントリーを削除し、それぞれ削除理由とともに表示します。--dry-run は書き込みを行わず同じレポートを表示します。他のツールが所有するマップには触れません。

WPML

言語設定を生成する

シェル
wp bs wpml config
wp bs wpml config --file=wp-content/themes/my-theme/wpml-config.xml

登録済みのすべてのwpml-config.xmlのテキストフィールドを翻訳対象として宣言し、ファイルフィールドを添付ファイルIDとして記載したものを出力するか、--fileで書き込みます。既存のファイルでは、Blockstudioマーカー間のセクションのみが置き換えられます。宣言内容とファイルを最新の状態に保つ方法については、WPMLをご覧ください。

ブロックタグの移行

スタンドアロンスクリプトで、プレフィックス形式とエイリアス形式の省略記法を正規の<bs:namespace-slug>表記に書き換えます。WordPressは読み込まず、--applyが明示的に指定されない限り書き込みません:

シェル
php vendor/blockstudio/blockstudio/bin/migrate-block-tags.php \
  --root="$PWD" \
  --prefix-map=/tmp/project-prefixes.json \
  --known-blocks=/tmp/project-blocks.json \
  --aliases=/tmp/project-aliases.json \
  --report=/tmp/blockstudio-tag-migration.json \
  --dry-run

プレフィックスファイルでは、呼び出し側が所有するプレフィックスを順序付きの名前空間に対応付けます。既知のブロックファイルは、登録済みブロック名のJSONリストです。エイリアスの完全一致設定は任意です。レポートには、決定的なマッピング、変更前後のハッシュ、未知のタグ、あいまいなエイリアス、動的タグ、およびコメント、コードフェンス、<pre>、<code>の範囲で見つかった例が含まれます。

スキャナーは、PHP文字列内のリテラルタグを含め、対になったタグ、ネストされたタグ、自己終了タグを処理します。属性を保持し、タグ名だけを変更します。コメントとコード例はレポートのみの対象です。無関係なカスタム要素は無視されます。未知、あいまい、または動的なケースが残っている間は、呼び出し側が意図的に--allow-unresolvedを渡さない限り、移行を適用できません。 正規の出力に対してコマンドを再実行しても、変更は発生しません。

正規表記が存在する理由と、それによって解決される問題については、移行 を参照してください。

アンインストール

シェル
wp bs teardown

インストールが所有するcronイベントと静的プリレンダーの状態を削除します。対象は、現在のサイトの早期配信マップのエントリー、および最後の所有エントリーがなくなった時点での共有advanced-cache.phpドロップインとWP_CACHE宣言です。 Composerに同梱され、プラグイン無効化フックがないインストール環境では、これを使ってクリーンに削除できます。設定ファイルは変更されません。