Перейти к содержимому

Источники логического обнаружения

Обычно 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

Перечень — это окончательное видимое дерево. Объедините слои перед возвратом:

  • Используйте одну запись для каждого видимого логического пути.
  • Пусть выбранный слой указывает физический путь.
  • Не включайте удаленные логические пути.
  • Записи можно возвращать в любом порядке. Blockstudio сортирует их по логическому пути.
  • Если важно отображать каталоги, добавьте пустые логические каталоги в шестой необязательный аргумент конструктора.

Inventory_Discovery_Source удобен для перечней, представленных массивами. Интеграции могут реализовать интерфейс Discovery_Source, если записи разрешаются по запросу или поступают из другой системы хранения.

Разрешение соседних файлов

Логические соседние файлы могут находиться в разных физических корневых каталогах. Родительский block.json может использовать наложение index.php, а страница наложения может наследовать родительский pages.json, загрузчик или макет. Blockstudio определяет эти связи по логическому пути перед чтением выбранных физических файлов.

Пути загрузчика за пределами коллекции сохраняют существующие границы безопасности blockstudio/pages/allow_external_loader_path.

Идентификация и инвалидация

Каждый источник предоставляет:

  • Стабильный идентификатор источника для выбранной среды выполнения.
  • Отпечаток, который меняется вместе с видимым перечнем.
  • Физические пути для отслеживания при горячей перезагрузке и проверке кэша.
  • Происхождение и метаданные каждой записи.

Blockstudio включает идентификаторы источников и отпечатки в идентификаторы кэша среды выполнения, манифеста страницы, шаблона редактора сайта, Canvas и Tailwind.

Используйте 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 записывает скомпилированные ресурсы в область generated для текущего контекста под настроенным корневым каталогом кэша Blockstudio, а не рядом с родительским источником. Поэтому сгенерированные ресурсы, вывод Tailwind, документы рендеринга и статические пререндеры используют одну и ту же доступную для записи границу хоста.

Два фильтра отвечают за пользовательскую маршрутизацию среды выполнения:

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
);

Используйте фильтр URL, если выбранные файлы находятся вне wp-content или обслуживаются через конечную точку среды выполнения.