Повноцінні сторінки, визначені в коді
Шаблони й Markdown синхронізуються з WordPress однією командою.
Колекції з файлів
Визначте pages.json, і Blockstudio знайде всі джерела в ньому. Вкладені шляхи стають вкладеними сторінками, типові параметри застосовуються до колекції, а відсутні батьківські сторінки можна створити автоматично.
Використовуйте колекції для документації, баз знань або цільових сторінок, а зовнішні папки підключайте за префіксом шляху за допомогою loader.php.
Розмістіть layout.php або макет рендерера, наприклад layout.tsx, поруч із pages.json, щоб обгорнути кожну сторінку колекції в одну оболонку, додавши blockstudio_page_tree() для бічної панелі.
{
"collection": "docs",
"title": "Documentation",
"postType": "bs_docs",
"defaults": {
"postStatus": "publish",
"templateLock": "contentOnly"
}
}---
title: Installation
order: 10
---
# Installation
Install Blockstudio from this Markdown page.<?php $current = blockstudio_current_page(); ?>
<main class="docs-layout">
<aside>
<?php foreach (blockstudio_page_tree('docs') as $item) : ?>
<?php $is_current = ($item['post_id'] ?? null) === ($current['post_id'] ?? null); ?>
<a
href="<?php echo esc_url($item['permalink'] ?? '#'); ?>"
<?php echo $is_current ? 'aria-current="page"' : ''; ?>
>
<?php echo esc_html($item['title']); ?>
</a>
<?php endforeach; ?>
</aside>
<article>
<?php echo blockstudio_page_content(); ?>
</article>
</main>Явна синхронізація
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.
<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 побудовано з компонентних сторінок.
{
"name": "legal-notice",
"title": "Legal Notice",
"slug": "legal-notice",
"postStatus": "publish",
"render": { "entry": "page.tsx", "data": "data.php" }
}add_action(
'blockstudio/pages/renderers',
static function (): void {
Blockstudio\Page_Renderers::register(
'react',
array(
'extensions' => array( 'tsx' ),
'layouts' => array( 'layout.tsx' ),
'render' => 'my_theme_render_page',
)
);
}
);Маршрути без запису
Blockstudio\Virtual_Routes::register() відображає документ без відповідного запису, наприклад довідник компонентів або каталог. Завдяки prefix і match одна реєстрація обслуговує цілу низку URL-адрес, а повернення null передає URL до WordPress.
Маршрут рендериться у вихідному буфері Blockstudio, тож його блоки отримують свої ресурси та вивід Tailwind. Шляхи в urls долучаються до статичних попередніх збірок, а Virtual_Routes::urls() повертає їх для карти сайту.
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$report = Blockstudio\Pages::reconcile();
if (0 === $report['failed']) {
// Once the release is live and verified:
Blockstudio\Pages::store_successful_source_identity(
$report['sourceIdentity']
);
}Блоки з ключами зберігають вміст
Додайте key до будь-якого блока. Під час наступної синхронізації блоки з ключами поєднують атрибути шаблону з наявним користувацьким вмістом, а блоки без ключів замінюються.
Змінюйте структуру між розгортаннями, зберігаючи клієнтський вміст.
<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>{
"name": "about",
"title": "About Us",
"slug": "about",
"templateLock": "contentOnly"
}Блокування шаблонів і режими редагування
"all" забороняє зміни, "contentOnly" блокує структуру, дозволяючи редагувати текст, а "insert" дозволяє редагувати й змінювати порядок без додавання чи видалення.
Перевизначте будь-який елемент за допомогою blockEditingMode, щоб вибірково дозволити редагування заблокованої сторінки або вимкнути окремий блок.
<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>{
"name": "landing",
"title": "Landing Page",
"slug": "landing",
"templateLock": "contentOnly",
"blockEditingMode": "contentOnly"
}Шаблони редактора сайту з файлів
Додайте template.json і шаблон до templates/ або part.json до parts/ — і ваша блокова тема отримає файлові джерела wp_template та wp_template_part.
Вони використовують той самий синтаксис, що й сторінки. Зміни в редакторі сайту мають пріоритет, доки їх не скинуть; після скидання знову використовується джерело з файлу.
<block name="core/template-part" slug="header" />
<div>
<h1>Welcome</h1>
<block name="core/post-content" />
</div>
<block name="core/template-part" slug="footer" />{
"slug": "front-page",
"title": "Front Page",
"description": "Homepage template"
}{
"slug": "header",
"title": "Header",
"area": "header"
}Вибраний вміст бази даних у git
wp bs content pull експортує дозволені записи, терміни, зв’язки й оголошені метадані у переносні файли, а push застосовує їх в іншому середовищі. Оголошені посилання, батьківські елементи та зв’язки з термінами передаються як стабільні UID.
Записи, якими керує синхронізація сторінок, можна поєднувати з includePageSyncManaged. Їхні файли містять "bodyOwner": "page-sync", тож Content Sync переносить метадані, а синхронізація сторінок зберігає основний вміст.
{
"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"
}
}wp bs content pull --dry-run
wp bs content pull
wp bs content status
wp bs content push --dry-run
wp bs content push --prune --yesБлоки з ключами
Зберігайте користувацький вміст під час оновлення шаблонів.
Режими редагування
Задавайте типові параметри сторінки й перевизначайте окремі елементи.
Прив’язки блоків
Зв’язуйте блоки з метаданими дописів, щоб вміст зберігався після синхронізації.
Шаблони типів записів
templateFor задає сторінку як початкову структуру блоків для кожного нового запису певного типу.
Закріплені ID записів
postId знову призначає той самий ID після видалення сторінки й повторної синхронізації, тож меню та посилання продовжують працювати.
Каркаси та блокування
sync: false разом із Pages::force_sync() створює сторінку один раз, щоб редактори могли керувати нею самостійно. Pages::lock() і unlock() не дають синхронізувати одну сторінку.
Власні рендерери парсера
Фільтри builder і renderer перетворюють тег блока на масив блоків стороннього блока або змінюють спосіб запису основного блока.
Відповідність елементів
Зіставте елемент HTML з іншим блоком, виберіть блок за атрибутами елемента та спрямовуйте HTML абзацу в поле вмісту.
Власні шляхи пошуку
Фільтри додають кореневі каталоги для сторінок, шаблонів блоків і шаблонів редактора сайту, наприклад із плагіна.
Логічні джерела пошуку
Попередні перегляди, накладення та згенеровані теми можуть передавати Blockstudio складений перелік файлів замість однієї теки теми.
Стабільні посилання
Задекларовані посилання на записи, терміни та вкладення перетворюються на переносні UID під час отримання та розв’язуються в локальні ID під час надсилання.
Статус перед надсиланням
wp bs content status показує для кожного об’єкта один зі статусів: без змін, буде оновлено, відсутній у базі даних, конфлікт, заблоковано або осиротілий; також попереджає про ключі метаданих, схожі на секрети.
Перевірене надсилання з визначеною областю дії
Перед записом надсилання перевіряє весь план і пропускає заблоковані об’єкти. –dry-run показує план, а –prune –yes видаляє лише об’єкти з цього набору вмісту.
Під контролем версій
Відстежуйте файли сторінок у Git і розгортайте їх у різних середовищах.
PHP API
Програмно отримуйте доступ до дерев, дочірніх елементів, метаданих, синхронізації, блокування та ідентифікаторів.
Офіційний набір розширень
Преміумшаблони сайтів, системні інструкції для ШІ та приватна спільнота Discord. Одноразова покупка, довічні оновлення.
- Понад 500 шаблонів сайтів
- Системні інструкції для ШІ
- Оновлення назавжди
- Приватна спільнота Discord