コンテンツへスキップ

論理的な検出ソース

Blockstudioは通常、物理テーマディレクトリからファイルを検出します。実行時ツールを使うと、これらのディレクトリを論理的なインベントリーに置き換えられます。プレビュー、オーバーレイ、生成テーマ、リモートマウントなど、関連ファイルが単一の物理ルートにまとまっていない環境で役立ちます。

Blockstudioは引き続きブロック、ページ、コレクション、パターン、フィールド、テンプレート、テンプレートパーツを解析して登録します。ソースが決めるのは、どの論理ファイルを表示するかと、表示する各ファイルをどこから読み込むかだけです。

インベントリーソース

blockstudio/discovery/sourcesフィルターを使って、デフォルトのFilesystem_Discovery_Sourceオブジェクトを置き換えます:

PHP
use Blockstudio\Inventory_Discovery_Source;

add_filter(
    'blockstudio/discovery/sources',
    function (array $sources, string $context, array $paths): array {
        if ('blocks' !== $context) {
            return $sources;
        }

        return [
            new Inventory_Discovery_Source(
                'preview:feature-card',
                '/runtime-preview/feature-card/blockstudio',
                [
                    'card/block.json' => [
                        'path' => '/theme/blockstudio/card/block.json',
                        'provenance' => [
                            'layer' => 'parent',
                            'inherited' => true,
                        ],
                    ],
                    'card/index.php' => [
                        'path' => '/runtime-preview/feature-card/blockstudio/card/index.php',
                        'provenance' => [
                            'layer' => 'preview',
                        ],
                    ],
                ],
                'parent-and-preview-fingerprint',
                ['/theme/blockstudio', '/runtime-preview/feature-card/blockstudio']
            ),
        ];
    },
    10,
    3
);

利用可能なコンテキストは次のとおりです:

  • blocks
  • fields
  • pages
  • patterns
  • site-templates
  • site-template-parts

インベントリーは最終的に表示されるツリーです。返す前に各レイヤーを合成してください:

  • 表示する論理パスごとにエントリーを1つ使用します。
  • 選択されたレイヤーから物理パスを取得します。
  • 削除された論理パスは省略します。
  • エントリーの順序は任意です。Blockstudioが論理パス順に並べ替えます。
  • ディレクトリの表示が重要な場合は、コンストラクターの任意の第6引数に空の論理ディレクトリを含めます。

Inventory_Discovery_Sourceは配列ベースのインベントリーに便利です。エントリーが遅延解決される場合や別のストレージシステムから取得される場合は、連携機能でDiscovery_Sourceインターフェースを実装できます。

兄弟ファイルの解決

論理的に隣接するファイルが異なる物理ルートに解決される場合があります。親block.jsonがオーバーレイindex.phpを使用したり、オーバーレイページが親のpages.json、ローダー、レイアウトを継承したりできます。Blockstudioは選択した物理ファイルを読み込む前に、論理パスを使ってこれらの関係を解決します。

コレクション外のローダーパスには、従来のblockstudio/pages/allow_external_loader_pathセキュリティ境界が適用されます。

IDと無効化

各ソースは次の情報を提供します:

  • 選択したランタイム用の安定したソースID。
  • 表示されるインベントリーに応じて変わるフィンガープリント。
  • ホットリロードとキャッシュ検証に使う物理的な監視対象。
  • 各エントリーの出所とメタデータ。

Blockstudioは、実行時、ページマニフェスト、サイトエディターのテンプレート、Canvas、TailwindのキャッシュIDにソースIDとフィンガープリントを含めます。

同じソース選択を複数のランタイム構成でレンダリングできる場合は、blockstudio/cache/contextを使用します:

PHP
add_filter(
    'blockstudio/cache/context',
    fn ($context, string $scope) => [
        'preview' => 'feature-card',
        'site' => get_current_blog_id(),
    ],
    10,
    2
);

コンテキスト値は、同等のリクエスト間でシリアライズ可能かつ安定している必要があります。Tailwindは直近の正常なCSSをコンテキストごとの名前空間に保持するため、あるプレビューに別のプレビューの代替CSSが渡されることはありません。

生成アセット

継承されたエントリーや読み取り専用のエントリーは、出所またはメタデータでinherited: true、readOnly: true、writable: falseとして指定します。するとBlockstudioは、親ソースの隣ではなく、設定済みのBlockstudioキャッシュルート配下にあるコンテキスト固有のgeneratedスコープへコンパイル済みアセットを書き込みます。これにより、生成アセット、Tailwindの出力、レンダリング済みドキュメント、静的プリレンダーで、書き込み可能なホスト境界が共有されます。

カスタムの実行時ルーティングには、2つのフィルターを使います:

PHP
add_filter(
    'blockstudio/generated_output/path',
    function (string $path, string $source, string $scope, array $metadata) {
        return $path;
    },
    10,
    4
);

add_filter(
    'blockstudio/files/url',
    function (string $url, string $path, string $scope) {
        return $url;
    },
    10,
    3
);

選択したファイルがwp-contentの外部にある場合や、実行時エンドポイント経由で提供される場合は、URLフィルターを使用します。