Перейти до вмісту

Логічні джерела виявлення

Зазвичай 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 включає ідентифікатори джерел і відбитки до ідентичностей кешу середовища виконання, маніфесту сторінки, шаблону Site Editor, 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 або доступні через кінцеву точку середовища виконання.