Páginas completas, definidas em código
Templates e Markdown, sincronizados com WordPress com um único comando.
Coleções a partir de arquivos
Defina pages.json e deixe Blockstudio descobrir todas as fontes abaixo dele. Caminhos aninhados se tornam páginas aninhadas, os padrões se aplicam à coleção e pais ausentes podem ser gerados.
Use coleções para documentação, bases de conhecimento ou páginas de destino, e monte pastas externas sob um prefixo de caminho com loader.php.
Coloque um layout.php ou um layout de renderizador, como layout.tsx, ao lado de pages.json para envolver cada página da coleção em uma estrutura comum, com blockstudio_page_tree() para a barra lateral.
{
"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>Sincronização explícita
wp bs pages sync aplica as alterações; páginas inalteradas não geram gravações.
Fontes Markdown
Use index.md com frontmatter ou combine o conteúdo de page.json com Markdown.
Markdown brutos
As páginas de arquivo Markdown são acessadas em seu URL mais .md, ou no URL normal para Accept: text/markdown, com um link canônico de volta para o HTML.
Carregadores de coleções
Monte pastas externas de documentação em uma coleção sob um prefixo de caminho.
Coleções de sites
Um pages.json com escopo de site aplica padrões compartilhados a toda uma árvore de páginas e a lista, sem alterar URLs nem linhas de publicações.
Auxiliares de navegação
blockstudio_page_tree(), blockstudio_page_children(), blockstudio_current_page() e blockstudio_page_content() criam barras laterais, paginadores e o corpo.
Coleções e tipos de publicação
As coleções podem registrar tipos de publicação hierárquicos dedicados.
Bloqueio de modelos
Bloqueie páginas ou blocos individuais com contentOnly, all ou insert.
Escreva HTML e obtenha blocos
Elementos padrão, como <h1>, <p> e <ul>, correspondem a blocos principais. Use <block> para todos os outros nomes de blocos e níveis de aninhamento.
Blockstudio analisa layouts de página completos e os converte em blocos WordPress reais e editáveis.
<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>Páginas renderizadas por componentes
Defina render em page.json como uma entrada, por exemplo page.tsx, e um carregador data.php; o renderizador de páginas registrado pelo seu tema ou plugin desenha a página inteira. A sincronização armazena um bloco blockstudio/page, e o conteúdo WordPress, como um shortcode, permanece no seu espaço.
Os recursos retornados pelo renderizador recebem o mesmo processamento que os recursos dos blocos e são impressos uma única vez, para que uma página pré-renderizada os inclua. O próprio blockstudio.dev é criado a partir de páginas de componentes.
{
"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',
)
);
}
);Rotas sem publicação
Blockstudio\Virtual_Routes::register() serve um documento sem uma publicação por trás, como uma referência de componente ou um catálogo. Com prefix e match, um registro atende a toda uma família de URLs, e retornar null deixa o URL para WordPress.
A rota é renderizada no buffer de saída de Blockstudio, para que seus blocos recebam os recursos e a saída de Tailwind. Os caminhos em urls são incluídos nas compilações de pré-renderização estática, e Virtual_Routes::urls() os retorna para um mapa do site.
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(),
]
);
} );Sincronize quando você decidir
Os arquivos de página só mudam WordPress quando você solicita. wp bs pages sync aplica todas as fontes alteradas, preserva o conteúdo do editor com chaves e remove páginas cujos arquivos não existem mais.
As impressões digitais abrangem manifestos, carregadores, layouts e fontes, então páginas inalteradas não geram gravações. As implantações chamam Pages::reconcile() e recebem um relatório legível por máquina.
# 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']
);
}Blocos com chaves preservam o conteúdo
Adicione key a qualquer bloco. Na próxima sincronização, os blocos com chave mesclam os atributos do template com o conteúdo existente do usuário, enquanto os blocos sem chave são substituídos.
Evolua a estrutura entre implantações, mantendo intacto o conteúdo dos clientes.
<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"
}Bloqueio de templates e modos de edição
"all" impede alterações, "contentOnly" bloqueia a estrutura e permite editar o texto, e "insert" permite editar e reordenar sem adicionar ou remover.
Substitua qualquer elemento com blockEditingMode para permitir a edição seletiva de uma página bloqueada ou desativar um bloco individual.
<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"
}Templates do Editor do site a partir de arquivos
Adicione template.json e um template a templates/, ou part.json a parts/, e seu tema de blocos terá fontes de wp_template e wp_template_part baseadas em arquivos.
Eles usam a mesma sintaxe das páginas. Uma personalização do Editor do site continua prevalecendo até ser redefinida; depois disso, a fonte do arquivo volta a ser usada.
<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"
}Conteúdo selecionado do banco de dados em git
wp bs content pull exporta publicações, termos, relações e metadados declarados permitidos para arquivos portáteis, e push os aplica a outro ambiente. Referências declaradas, relações com itens superiores e relações com termos são transferidas como UIDs estáveis.
Publicações gerenciadas pela sincronização de páginas podem ser associadas a includePageSyncManaged. Seus arquivos contêm "bodyOwner": "page-sync", então a Content Sync transfere os metadados enquanto a sincronização de páginas mantém o corpo.
{
"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 --yesBlocos com chave
Preserve o conteúdo do usuário enquanto os templates evoluem.
Modos de edição
Defina padrões para páginas e substitua elementos individuais.
Vínculos de blocos
Conecte blocos aos metadados da publicação para que o conteúdo sobreviva à sincronização.
Modelos de tipo de publicação
templateFor define uma página como a estrutura inicial de blocos de cada nova publicação de um tipo.
IDs de publicação fixados
postId recupera o mesmo ID quando uma página é excluída e sincronizada novamente, para que menus e links continuem funcionando.
Estruturas iniciais e bloqueios
sync: false com Pages::force_sync() cria uma página uma única vez para que os editores sejam responsáveis por ela. Pages::lock() e unlock() impedem que uma página seja sincronizada.
Renderizadores de analisador personalizados
Os filtros do construtor e do renderizador transformam uma tag de bloco no array de blocos de um bloco de terceiros ou alteram a forma como um bloco principal é escrito.
Mapeamento de elementos
Mapeie um elemento HTML para outro bloco, escolha o bloco com base nos atributos do elemento e direcione HTML de parágrafo para um campo de conteúdo.
Caminhos personalizados de descoberta
Os filtros adicionam raízes para páginas, padrões e modelos do Editor do site, por exemplo, provenientes de um plugin.
Fontes lógicas de descoberta
Pré-visualizações, sobreposições e temas gerados podem fornecer a Blockstudio um inventário de arquivos composto, em vez de uma única pasta de tema.
Referências estáveis
Referências declaradas a publicações, termos e anexos tornam-se UIDs portáteis ao baixar e são resolvidas para IDs locais ao enviar.
Status antes do envio
wp bs content status informa cada entidade como inalterada, seria atualizada, ausente no banco de dados, em conflito, bloqueada ou órfã, e alerta sobre chaves de metadados que parecem conter segredos.
Envios validados e com escopo definido
O envio valida todo o plano antes de gravar e ignora entidades bloqueadas. –dry-run mostra o plano, e –prune –yes remove somente as entidades deste conjunto de conteúdo.
Sob controle de versão
Acompanhe arquivos de página em Git e implante-os em vários ambientes.
PHP API
Acesse árvores, itens filhos, metadados, sincronização, bloqueios e IDs por meio de código.
O kit oficial de extensões
Modelos premium de site, instruções de sistema para IA e uma comunidade privada Discord. Compra única, atualizações vitalícias.
- 500+ modelos de sites
- Instruções de sistema para IA
- Atualizações vitalícias
- Comunidade privada de Discord