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

Полные страницы, заданные в коде

Шаблоны и Markdown синхронизируются с WordPress одной командой.

Коллекции из файлов

Определите pages.json, и Blockstudio обнаружит все исходные файлы внутри. Вложенные пути станут вложенными страницами, для коллекции будут применены настройки по умолчанию, а недостающие родительские страницы можно будет создать.

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

Поместите layout.php или макет рендерера, например layout.tsx, рядом с pages.json, чтобы обернуть каждую страницу коллекции в общую оболочку, добавив blockstudio_page_tree() для боковой панели.

pages/docs/pages.json
{
  "collection": "docs",
  "title": "Documentation",
  "postType": "bs_docs",
  "defaults": {
    "postStatus": "publish",
    "templateLock": "contentOnly"
  }
}

Явная синхронизация

Команда wp bs pages sync применяет изменения; для неизмененных страниц не требуется ни одной операции записи.

Источники Markdown

Используйте index.md с метаданными в начале файла или сочетайте page.json с содержимым Markdown.

Необработанный Markdown

Markdown обслуживает страницы файлов по адресу URL плюс .md либо по обычному URL при Accept: text/markdown; на HTML ведёт каноническая ссылка.

Загрузчики коллекций

Подключайте внешние папки с документацией к коллекции по префиксу пути.

Коллекции сайта

pages.json с областью действия site применяет общие настройки по умолчанию ко всему дереву страниц и перечисляет его, не меняя URL или строки записей.

Помощники навигации

blockstudio_page_tree(), blockstudio_page_children(), blockstudio_current_page() и blockstudio_page_content() создают боковые панели, постраничную навигацию и основное содержимое.

Коллекции и типы записей

Коллекции могут регистрировать отдельные иерархические типы записей.

Блокировка шаблона

Блокируйте страницы или отдельные блоки с помощью contentOnly, all или insert.

Пишите HTML, получайте блоки

Стандартные элементы, такие как <h1>, <p> и <ul>, соответствуют основным блокам. Для всех остальных имен блоков и уровней вложенности используйте <block>.

Blockstudio разбирает целые макеты страниц и преобразует их в настоящие редактируемые блоки WordPress.

index.php
<div>
  <h1 blockEditingMode="contentOnly">About Us</h1>
  <p>We build tools for WordPress developers.</p>
  <img src="/team.jpg" alt="Our team" />
</div>

<block name="core/columns">
  <block name="core/column"><h2>Our Mission</h2></block>
  <block name="core/column"><h2>Our Stack</h2></block>
</block>

Страницы, отрисованные компонентами

Укажите render в page.json как запись, например page.tsx, и загрузчик data.php — тогда зарегистрированный вашей темой или плагином рендерер страницы отрисует её целиком. Синхронизация сохраняет один блок blockstudio/page, а содержимое WordPress, например шорткод, остаётся в своей области.

Ресурсы, возвращаемые рендерером, обрабатываются так же, как ресурсы блоков, и выводятся один раз, поэтому пререндеренная страница содержит их. Сам blockstudio.dev формируется из страниц компонентов.

pages/legal-notice/page.json
{
  "name": "legal-notice",
  "title": "Legal Notice",
  "slug": "legal-notice",
  "postStatus": "publish",
  "render": { "entry": "page.tsx", "data": "data.php" }
}

Маршруты без записи

Blockstudio\Virtual_Routes::register() обслуживает документ без связанной записи, например справочник компонентов или каталог. С помощью prefix и match одна регистрация охватывает целое семейство URL, а возврат null оставляет URL для WordPress.

Маршрут рендерится в буфер вывода Blockstudio, поэтому его блоки получают свои ресурсы и вывод Tailwind. Пути из urls включаются в сборки статического пререндеринга, а Virtual_Routes::urls() возвращает их для карты сайта.

functions.php
add_action( 'init', function () {
    Blockstudio\Virtual_Routes::register(
        'components',
        function ( $component, string $rest ) {
            get_header();
            echo my_component_page( $component );
            get_footer();
        },
        [
            'prefix' => true,
            'match'  => fn ( string $rest ) => '' === $rest ? 'index' : my_component( $rest ),
            'title'  => fn ( $component ) => my_component_title( $component ),
            'urls'   => fn () => my_component_paths(),
        ]
    );
} );

Синхронизация только по вашему запросу

Файлы страниц изменяют WordPress только по вашему запросу. wp bs pages sync применяет все изменения в исходных файлах, сохраняет содержимое редактора с ключами и удаляет страницы, файлы которых отсутствуют.

Отпечатки включают манифесты, загрузчики, макеты и исходные файлы, поэтому для неизмененных страниц не требуется ни одной операции записи. Развертывание вызывает Pages::reconcile() и получает машиночитаемый отчет.

Терминал
# Apply changed sources, keep keyed edits
wp bs pages sync

# Replace managed content from the files
wp bs pages sync --authoritative

# Compare every page and report as JSON
wp bs pages sync --full --format=json

Именованные блоки сохраняют содержимое

Добавьте key к любому блоку. При следующей синхронизации атрибуты шаблона объединяются с содержимым пользователя в блоках с ключами, а блоки без ключей заменяются.

Меняйте структуру при развертывании, сохраняя содержимое клиентов.

index.php
<h1 key="title">About Us</h1>
<block name="core/cover" key="hero" url="/hero.jpg">
  <h2>Welcome to our company</h2>
  <p>Edit this content freely.</p>
</block>
<block name="core/columns" key="team">
  <block name="core/column"><h3>Our Team</h3></block>
</block>

Блокировка шаблонов и режимы редактирования

"all" запрещает изменения, "contentOnly" блокирует структуру, но разрешает редактировать текст, а "insert" позволяет редактировать и менять порядок без добавления или удаления элементов.

Переопределяйте любой элемент с помощью blockEditingMode, чтобы выборочно разрешить редактирование заблокированной страницы или отключить отдельный блок.

index.php
<h1>Welcome to Our Product</h1>
<p>The best solution for your needs.</p>
<block name="core/cover" blockEditingMode="disabled" url="/static-banner.jpg">
  <p>Promotional banner</p>
</block>
<block name="core/group" blockEditingMode="default">
  <h2>Customizable Section</h2>
</block>

Шаблоны редактора сайта из файлов

Добавьте template.json и шаблон в templates/ либо part.json в parts/, чтобы ваша блочная тема получила источники wp_template и wp_template_part на основе файлов.

В них используется тот же синтаксис, что и на страницах. Настройка редактора сайта продолжает действовать, пока ее не сбросят; после этого снова используется источник из файла.

templates/front-page/index.php
<block name="core/template-part" slug="header" />

<div>
  <h1>Welcome</h1>
  <block name="core/post-content" />
</div>

<block name="core/template-part" slug="footer" />

Выбранное содержимое базы данных в git

wp bs content pull экспортирует разрешённые записи, термины, связи и объявленные метаданные в переносимые файлы, а push применяет их в другой среде. Объявленные ссылки, родительские элементы и связи терминов передаются в виде стабильных UID.

Записи, управляемые синхронизацией страниц, можно объединить с includePageSyncManaged. В их файлах содержится "bodyOwner": "page-sync", поэтому Content Sync переносит метаданные, а синхронизация страниц сохраняет основное содержимое.

blockstudio.json
{
  "content": {
    "enabled": true,
    "id": "default",
    "path": "content",
    "postTypes": ["team_member"],
    "taxonomies": ["category"],
    "meta": {
      "include": ["_my_*"],
      "references": {
        "_thumbnail_id": { "kind": "attachment" },
        "_related_posts": { "kind": "post", "path": "*" }
      }
    },
    "media": "manifest"
  }
}

Блоки с ключами

Сохраняйте пользовательское содержимое при изменении шаблонов.

Режимы редактирования

Задавайте настройки страниц по умолчанию и переопределяйте их для отдельных элементов.

Привязки блоков

Связывайте блоки с метаданными записей, чтобы содержимое сохранялось при синхронизации.

Шаблоны типов записей

templateFor задаёт структуру блоков, с которой начинается каждая новая запись данного типа.

Закреплённые ID записей

postId повторно использует тот же ID, если страницу удалили и синхронизировали заново, поэтому меню и ссылки продолжают работать.

Заготовки и блокировки

sync: false вместе с Pages::force_sync() создаёт страницу один раз, чтобы редакторы могли управлять ею. Pages::lock() и unlock() исключают одну страницу из синхронизации.

Пользовательские рендереры парсера

Фильтры сборщика и рендерера преобразуют тег блока в массив блоков стороннего блока или меняют способ записи основного блока.

Сопоставление элементов

Сопоставьте элемент HTML с другим блоком, выберите блок по атрибутам элемента и направьте содержимое абзаца HTML в поле содержимого.

Пользовательские пути поиска

Фильтры добавляют корневые каталоги для страниц, паттернов и шаблонов редактора сайта, например из плагина.

Логические источники для поиска

Предварительные просмотры, наложения и сгенерированные темы могут передать Blockstudio составной перечень файлов вместо одной папки темы.

Стабильные ссылки

Объявленные ссылки на записи, термины и вложения при загрузке становятся переносимыми UID, а при отправке разрешаются в локальные ID.

Статус перед отправкой

wp bs content status сообщает для каждой сущности одно из состояний: без изменений, будет обновлена, отсутствует в БД, конфликт, заблокирована или осиротела; также он предупреждает о ключах метаданных, похожих на секреты.

Проверенные отправки с заданной областью действия

Перед записью push проверяет весь план и пропускает заблокированные сущности. –dry-run показывает план, а –prune –yes удаляет только сущности из этого набора содержимого.

Под контролем версий

Отслеживайте файлы страниц в Git и развертывайте их в разных средах.

PHP API

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

Plus

Официальный набор расширений

Премиум-шаблоны сайтов, системные инструкции для ИИ и закрытое сообщество Discord. Разовая покупка, обновления навсегда.

  • 500+ шаблонов сайтов
  • Системные инструкции для ИИ
  • Пожизненные обновления
  • Закрытое сообщество Discord