Desenvolvedores

Referência de habilidades do Page Builder Sandwich

O Page Builder Sandwich registra suas ações com a API de Habilidades do WordPress. As mesmas habilidades são ferramentas MCP no próprio servidor do site e rotas REST sob /wp-json/wp-abilities/v1. Esta página é gerada a partir do próprio registro do plugin.

Guia do usuário: conectar um aplicativo de IA

Endpoints

HabilidadeREST
MCP via HTTP (streamable)/wp-json/pbs/v1/mcp
MCP via WP-CLI (entrada e saída padrão)wp mcp-adapter serve --server=page-builder-sandwich --user=<login>
REST: listar as habilidades/wp-json/wp-abilities/v1/abilities?category=page-builder-sandwich
REST: executar uma habilidade/wp-json/wp-abilities/v1/abilities/<name>/run (GET com ?input= para habilidades somente leitura, POST {"input": {...}} caso contrário)

Autenticação e permissões

As requisições HTTP autenticam com uma senha de aplicativo do WordPress (HTTP Basic). Conectar-se ao servidor MCP requer a capacidade mostrada abaixo; cada habilidade verifica então sua própria permissão, por objeto. Habilidades somente leitura são executadas com GET e sua entrada na query string; as demais com POST e um corpo JSON ‘{“input”: {…}}’.

uma senha de aplicativo do WordPress (HTTP) ou --user (WP-CLI); o usuário precisa da capacidade que cada habilidade especifica · Configurações: Permitir agentes de IA (MCP), ativado por padrão

Todas as habilidades

HabilidadeEdiçãoRESTPermissãoParâmetros
pbs/activate-custom-font
Disponibiliza uma fonte personalizada enviada (um arquivo de fonte na biblioteca de mídia, por id) nos seletores de fontes.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/activate-custom-font/runedit_theme_options (verificação própria da rota REST)id inteiro (obrigatório)
pbs/add-local-font
Baixa uma família de fontes do Google Fonts (família, pesos, itálico) e a disponibiliza a partir deste site.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/add-local-font/runmanage_options (verificação própria da rota REST)family texto (obrigatório)
weights array
italic booleano
pbs/add-section
Adiciona uma seção pronta a uma página: no início, no final ou após a seção em uma determinada posição.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/add-section/runedit_post nessa páginaid inteiro (obrigatório)
section texto (obrigatório)
position texto: start, end, after
after inteiro
pbs/add-shop-block
Adiciona um bloco do WooCommerce ao final de um post: um elemento do produto (part: title, gallery, image, price, rating, excerpt, description, add_to_cart, meta, tabs, related, upsells, sale_badge, stock; productId, ou 0 para o produto visualizado no momento) ou um minicarrinho (label).
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/add-shop-block/runedit_post (verificação própria da rota REST)post inteiro (obrigatório)
block texto (obrigatório): product-element, mini-cart
part texto: title, gallery, image, price, rating, excerpt, add_to_cart, meta, tabs, related, upsells, sale_badge, stock, description
productId inteiro
label texto
pbs/ai-check-accessibility
Lista os problemas de acessibilidade de uma página: imagens sem texto alternativo, cabeçalhos que pulam níveis, links cujo texto não tem significado isolado e links sem texto. Cada um indica se pode ser corrigido automaticamente.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/ai-check-accessibility/runedit_post na páginapost_id inteiro (obrigatório)
pbs/ai-create-block
Cria um componente reutilizável a partir de uma descrição (um cartão de preços, um cartão de equipe, um banner) e o salva como um padrão sincronizado em “Meus padrões” no editor, com cada texto editável por inserção. Retorna seu id e o bloco que o insere.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/ai-create-block/runedit_posts e publish_posts; regras de função e gastos das configurações de IAdescription texto (obrigatório)
title texto
pbs/ai-css-help
Explica, escreve ou corrige o CSS personalizado de um elemento, onde `selector` representa o elemento. Retorna o CSS e uma explicação; nada é salvo.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/ai-css-help/runedit_posts e a permissão de código do construtoraction texto (obrigatório): explain, write, fix
css texto
instruction texto
block texto
pbs/ai-design-from
Recria o layout de uma captura de tela (uma imagem na biblioteca de mídia) ou de uma página web pública (seu endereço) como blocos editáveis em uma nova página de rascunho: as mesmas seções, colunas, cabeçalhos, textos, listas e botões. Logotipos e imagens não são copiados.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/ai-design-from/runedit_pages (edit_post na captura de tela); regras de função e gastos das configurações de IAattachment_id inteiro
url texto
title texto
instruction texto
pbs/ai-edit-page
Modifica uma página conforme solicitado em linguagem natural (“encurte o texto do banner”, “adicione um FAQ sobre entregas após os preços”, “traduza a página para o alemão”). A IA responde com operações de edição que são verificadas em relação aos blocos da página e suas configurações antes de aplicar qualquer alteração; as operações recusadas são listadas com o motivo. Uma revisão é salva primeiro e seu id é retornado como undo_revision.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/ai-edit-page/runedit_post na página; regras de função e gastos das configurações de IApost_id inteiro (obrigatório)
instruction texto (obrigatório)
pbs/ai-fix-accessibility
Corrige os problemas de acessibilidade que podem ser resolvidos (todos ou os ids dos problemas listados): texto alternativo gerado pela análise de cada imagem, níveis de cabeçalho corrigidos, textos de links vagos reescritos. Uma revisão é salva primeiro e seu id é retornado como undo_revision.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/ai-fix-accessibility/runedit_post na página; regras de função e gastos das configurações de IApost_id inteiro (obrigatório)
issues array
pbs/ai-generate-image
Cria uma imagem a partir de uma descrição com o modelo de imagem do site (OpenAI ou Google) e salva na biblioteca de mídia com texto alternativo. Retorna o ID e o endereço.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/ai-generate-image/runupload_files; função e regras de gastos das configurações de IAprompt string (obrigatório)
size string: square, landscape, portrait
alt string
title string
post_id integer
pbs/ai-generate-section
Transforma uma descrição de uma frase em uma seção pronta (blocos reais e editáveis no estilo da marca do site) com texto escrito para ela. Retorna a marcação do bloco e a adiciona ao início ou ao final de uma página quando um post_id é informado (uma revisão mantém o que existia antes).
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/ai-generate-section/runedit_posts; edit_post para adicionar a uma página; função e regras de gastos das configurações de IAdescription string (obrigatório)
section string
post_id integer
position string: start, end
pbs/ai-plan-site
A partir da descrição do negócio, lista as páginas necessárias para o site (página inicial primeiro, contato por último), cada uma com título e um resumo para a página. Nada é criado; cada página pode ser criada depois a partir do resumo.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/ai-plan-site/runedit_pages; função e regras de gastos das configurações de IAbrief string (obrigatório)
pbs/ai-save-seo-meta
Salva o título e a descrição meta no plugin de SEO que o site usa (Yoast SEO, Rank Math, SEOPress ou All in One SEO) e informa quais foram gravados.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/ai-save-seo-meta/runedit_post na páginapost_id integer (obrigatório)
title string (obrigatório)
description string (obrigatório)
pbs/ai-suggest-seo-meta
Lê uma página e sugere um título meta (até 60 caracteres) e uma descrição meta (até 155), opcionalmente com base em uma palavra-chave de foco. Nada é salvo.
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/ai-suggest-seo-meta/runedit_post na página; função e regras de gastos das configurações de IApost_id integer (obrigatório)
keyword string
pbs/ai-undo
Restaura uma página para o estado anterior a uma alteração por IA, a partir do undo_revision retornado pela alteração.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/ai-undo/runedit_post na páginapost_id integer (obrigatório)
revision integer (obrigatório)
pbs/ai-write-alt-text
Examina imagens e salva o texto alternativo para elas: uma imagem (attachment_id) ou todas as imagens sem texto alternativo em uma página (post_id). No máximo 20 imagens por chamada; a resposta informa quantas restam.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/ai-write-alt-text/runupload_files e edit_post na imagem ou página; função e regras de gastos das configurações de IAattachment_id integer
post_id integer
only_missing boolean
language string
pbs/ai-write-text
Escreve novos textos ou aprimora, encurta, expande, altera o tom ou corrige a gramática de um trecho de texto, usando o próprio provedor de IA do site. Retorna o novo texto; nada no site é alterado.
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/ai-write-text/runedit_posts (edit_post quando post_id for informado); função e regras de gastos das configurações de IAaction string (obrigatório): write, improve, shorten, expand, tone, fix, custom
text string
tone string: professional, friendly, confident, playful, formal, simple
instruction string
context string
pbs/apply-brand-kit
Aplica as cores e fontes do kit de marca salvo ao design do site.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/apply-brand-kit/runedit_theme_options (verificação própria da rota REST)nenhum
pbs/apply-kit
Importa as páginas de um kit de site (todas ou apenas as indicadas), podendo opcionalmente publicá-las, definir a página inicial e adicioná-las a um menu. Importar novamente atualiza as mesmas páginas.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/apply-kit/runedit_pages e publish_pages; manage_options para definir a página inicial; edit_theme_options para criar um menuslug string (obrigatório)
pages array
publish boolean
front boolean
menu boolean
pbs/apply-replace
Aplica uma tarefa pré-visualizada. Cada post alterado mantém um backup para que a tarefa possa ser desfeita.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/apply-replace/runmanage_options (verificação própria da rota REST)id string (obrigatório)
pbs/build-landing-page
Um fluxo de trabalho guiado: o agente escolhe seções adequadas ao seu negócio, cria a página como rascunho e escreve o texto.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/build-landing-page/runedit_pagesbusiness string (obrigatório)
pbs/build-pages
Cria até 50 páginas em uma única chamada, cada uma a partir de seções e/ou conteúdo de blocos. Cada página é verificada e criada individualmente; a resposta lista todas as páginas criadas e recusadas, com o motivo.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/build-pages/runedit_pages; cada página é verificada individualmente (publish_pages para publicar)pages (obrigatório)
pbs/check-performance
Informa o quanto o conteúdo de uma página contribui para o seu peso: suas imagens (bytes, as superdimensionadas e o tamanho menor que serviria), as folhas de estilo dos blocos utilizados e suas incorporações de terceiros, com a solução para cada problema.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/check-performance/runedit_post na páginapost_id (obrigatório)
pbs/connect-adobe-fonts
Conecta um projeto web do Adobe Fonts (Typekit) pelo ID do kit, para que as fontes apareçam nos seletores de fontes.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/connect-adobe-fonts/runedit_theme_options (verificação própria da rota REST)kit (obrigatório)
pbs/connect-marketing-service
Conecta um serviço de lista de e-mails usando sua chave de API (service, key; account quando o serviço exigir), ou desconecta-o com uma chave vazia.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/connect-marketing-service/runmanage_options (verificação própria da rota REST)service (obrigatório)
key
account
pbs/connect-support
Conecta este site ao suporte da Zinn Digital® (name, email, consent).
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/connect-support/runmanage_options (verificação própria da rota REST)email (obrigatório)
name
consent (obrigatório)
pbs/convert-builder-export
Converte um arquivo de exportação (builder: elementor, divi, beaver ou wpbakery; content: o texto exportado) em um novo rascunho de página feito com blocos, copiando opcionalmente as imagens para a biblioteca de mídia (media). Responde com o rascunho e um relatório da conversão.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/convert-builder-export/runedit_pages (verificação própria da rota REST)builder (obrigatório): elementor, divi, beaver, wpbakery
content (obrigatório)
title
media
dryRun
status: draft, pending, private, publish
pbs/convert-builder-page
Converte uma página criada com Elementor, Divi, Beaver Builder ou WPBakery (id) em um novo rascunho composto por blocos, mantendo seu layout, tipografia, cores e imagens; a página original não é alterada. Responde com o rascunho e um relatório do que foi convertido, aproximado ou não convertido. dryRun converte sem salvar.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/convert-builder-page/runedit_pages e edit_post (verificação própria da rota REST)id (obrigatório)
dryRun
status: draft, pending, private, publish
pbs/convert-post
Converte uma página da versão 5.x para blocos (com backup prévio).
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/convert-post/runverificação de permissão própria por item da rota RESTid (obrigatório)
pbs/create-ab-test
Adiciona um teste entre duas versões de uma seção ao final de um post (post, name, a, b; split e goal são opcionais).
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-ab-test/runedit_post (verificação própria da rota REST)post (obrigatório)
name
a (obrigatório)
b (obrigatório)
split
goal
pbs/create-class
Cria uma classe de estilo global reutilizável: rótulo, slug e seus estilos (s).
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-class/runedit_theme_options (verificação própria da rota REST)label (obrigatório)
slug
s
cat
pbs/create-cookie-banner
Cria um modelo pronto de banner de consentimento para começar.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-cookie-banner/runmanage_options (verificação própria da rota REST)nenhum
pbs/create-form
Cria um formulário (contato, orçamento, cadastro ou em várias etapas: campos, etapas, configurações e ações como e-mail, salvar, webhook ou lista de e-mails), em uma nova página ou ao final de um post existente (post).
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-form/runedit_pages (verificação própria da rota REST)title
fields (obrigatório)
steps
actions
submitText
successMessage
redirectUrl
trackEvent
post
pageTitle
status: draft, publish, private
pbs/create-page
Cria uma página a partir de seções da biblioteca e/ou conteúdo de blocos. Uma nova página é criada como rascunho, a menos que outro status seja solicitado.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/create-page/runedit_pages; publish_pages para publicar ou tornar privadotitle string (obrigatório)
status string: draft, pending, publish, private
sections array
content string
pbs/create-popup
Cria um pop-up, slide-in ou barra: seu conteúdo, gatilho (intenção de saída, rolagem, tempo, clique), frequência e as páginas em que aparece.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-popup/runedit_pages (verificação própria da rota REST)title string (obrigatório)
content string (obrigatório)
status string: draft, publish
settings object
pbs/create-query-loop
Adiciona um laço de consulta com um cartão pronto, em uma nova página (pageTitle, status) ou no final de um post (post): source posts|users|terms|field, postType (product para uma grade de loja), perPage, columns, orderBy, order, pagination e filtros dinâmicos [{type: search|taxonomy|meta|sort|price|onsale|instock, taxonomy, key, label, ui}].
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-query-loop/runedit_post e edit_posts (verificação própria da rota REST)post integer
pageTitle string
status string: draft, publish, private
source string: posts, users, terms, field
postType string
perPage integer
columns integer
orderBy string
order string: ASC, DESC
pagination string: none, numbers, prevnext
taxonomy string
fieldKey string
filters array
pbs/create-team
Cria uma biblioteca de equipe (name) na qual outros sites podem entrar usando um código de convite.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-team/runmanage_options (verificação própria da rota REST)name string (obrigatório)
pbs/create-theme-template
Cria um modelo (title, type) que substitui essa parte de cada página correspondente, em temas clássicos e de blocos. Sem conteúdo, começa a partir de um design pronto para seu tipo. include/exclude são regras de condição de exibição ({kind, values, key, value, from, to, days}, os tipos que o construtor de temas deste site oferece); priority desempata; status publish (no ar) ou draft.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/create-theme-template/runverificação própria de permissão por item da rota RESTtitle string (obrigatório)
type string (obrigatório)
content string
include array
exclude array
priority integer
status string: publish, draft
pbs/deactivate-custom-font
Remove uma fonte personalizada (por slug) dos seletores de fonte.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/deactivate-custom-font/runedit_theme_options (verificação própria da rota REST)slug string (obrigatório)
pbs/delete-class
Exclui uma classe global. Os elementos que a usavam mantêm seu conteúdo e perdem seus estilos.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/delete-class/runedit_theme_options (verificação própria da rota REST)id string (obrigatório)
pbs/delete-icon
Remove um ícone enviado; os blocos que o usavam mantêm sua própria cópia.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/delete-icon/rundelete_post (verificação própria da rota REST)id string (obrigatório)
pbs/delete-library-item
Exclui um design da biblioteca na nuvem.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/delete-library-item/runedit_posts (verificação própria da rota REST)item string (obrigatório)
team string
pbs/delete-page
Move uma página para a lixeira. É possível restaurá-la de Páginas, Lixeira por 30 dias.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/delete-page/rundelete_post nessa páginaid integer (obrigatório)
pbs/delete-team
Exclui uma equipe e todos os designs de sua biblioteca.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/delete-team/runmanage_options (verificação própria da rota REST)team string (obrigatório)
pbs/delete-theme-template
Move um modelo (id) para a lixeira; o design padrão do tema volta a ser exibido onde ele se aplicava. Restaurável a partir da lixeira.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/delete-theme-template/runverificação própria de permissão por item da rota RESTid string (obrigatório)
pbs/disconnect-support
Desconecta este site do suporte.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/disconnect-support/runmanage_options (verificação própria da rota REST)nenhum
pbs/duplicate-class
Duplica uma classe global com um novo id.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/duplicate-class/runedit_theme_options (verificação própria da rota REST)id string (obrigatório)
pbs/duplicate-page
Copia uma página (título, conteúdo e modelo) para um novo rascunho.
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/duplicate-page/runedit_post na página e edit_pagesid número inteiro (obrigatório)
title texto
pbs/export-design
Retorna o arquivo de design do site: categorias, classes globais, variáveis, espaçamentos, escalas de arredondamento e sombras, e cores personalizadas (formato page-builder-sandwich-design, versão 1).
ProGET /wp-json/wp-abilities/v1/abilities/pbs/export-design/runedit_theme_options (verificação própria da rota REST)nenhum
pbs/export-designs
Exporta os modelos e padrões escolhidos (ids) e, opcionalmente, as configurações como um único pacote para outro site.
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/export-designs/runmanage_options (verificação própria da rota REST)ids array
settings booleano
pbs/find-builder-pages
Lista as páginas e posts criados com Elementor, Divi, Beaver Builder ou WPBakery (page, per_page), cada um com seu construtor e, caso já tenha sido convertido antes, o rascunho convertido.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/find-builder-pages/runedit_pages (verificação própria da rota REST)page número inteiro
per_page número inteiro
pbs/generate-page
Cria uma página a partir de seções (fornecidas ou escolhidas por IA da biblioteca de seções) e usa IA para reescrever todo o texto com base no seu briefing, mantendo o design. Usa o provedor de IA configurado nas opções de IA do plugin. A página fica como rascunho, a menos que outro status seja solicitado.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/generate-page/runedit_pages; publish_pages para publicar; regras de papel e gastos das configurações de IAbrief texto (obrigatório)
title texto
sections array
status texto: draft, pending, publish, private
pbs/get-block
Retorna as configurações de um bloco (atributos com seus tipos, opções e padrões), suporte oferecido, blocos que pode conter e um exemplo pronto para uso na marcação de bloco.
GratuitoGET /wp-json/wp-abilities/v1/abilities/pbs/get-block/runedit_postsname texto (obrigatório)
pbs/get-breakpoints
Retorna as larguras para tablet e celular (e pontos de quebra personalizados no Pro) que os controles responsivos usam.
GratuitoGET /wp-json/wp-abilities/v1/abilities/pbs/get-breakpoints/runedit_theme_options (verificação própria da rota REST)nenhum
pbs/get-conversion-tracking
Retorna as configurações do Google Analytics 4, Google Tag Manager e Meta Pixel, além de quais cliques e envios de formulário são enviados.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-conversion-tracking/runmanage_options (verificação própria da rota REST)nenhum
pbs/get-cookie-banner
Retorna o banner de consentimento: se está ativo, seu texto e design, as categorias e onde se aplica.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-cookie-banner/runmanage_options (verificação própria da rota REST)nenhum
pbs/get-design-globals
Retorna as cores e fontes globais (títulos e corpo) que todos os blocos usam, conforme exibido na tela de design do site.
GratuitoGET /wp-json/wp-abilities/v1/abilities/pbs/get-design-globals/runedit_theme_options (verificação própria da rota REST)nenhum
pbs/get-design-system
Retorna o sistema de design Pro: classes globais, variáveis, design tokens, modo escuro, kit de marca e fontes personalizadas.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-design-system/runedit_theme_options (verificação própria da rota REST)nenhum
pbs/get-diagnostics
Retorna as informações de diagnóstico que acompanham um chamado de suporte: versões, plugins ativos, limites e erros recentes.
GratuitoGET /wp-json/wp-abilities/v1/abilities/pbs/get-diagnostics/runmanage_options (verificação própria da rota REST)nenhum
pbs/get-figma-connection
Retorna se o site tem um token de acesso pessoal do Figma, a conta do Figma à qual ele pertence e seus últimos quatro caracteres. O token em si nunca é retornado.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-figma-connection/runmanage_options (verificação própria da rota REST)nenhum
pbs/get-library-account
Retorna o uso de armazenamento da biblioteca na nuvem, a cota do plano e dados da equipe.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-library-account/runedit_posts (verificação própria da rota REST)nenhum
pbs/get-library-item
Retorna um design salvo, pronto para inserir neste site (com imagens importadas para a biblioteca de mídia).
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-library-item/runedit_posts (verificação própria da rota REST)item texto (obrigatório)
team texto
pbs/get-library-storage
Retorna as configurações de armazenamento próprio R2/S3 (a chave secreta nunca é retornada).
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-library-storage/runmanage_options (verificação própria da rota REST)nenhum
pbs/get-licence
Retorna o plano do Page Builder Sandwich deste site, o status da licença, a data de renovação e o que o plano inclui.
GratuitoGET /wp-json/wp-abilities/v1/abilities/pbs/get-licence/runmanage_options (verificação própria da rota REST)nenhum
pbs/get-maintenance
Retorna o modo de manutenção / em breve: modo, página, retry-after e quais funções ainda veem o site.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-maintenance/runmanage_options (verificação própria da rota REST)nenhum
pbs/get-migration
Retorna o progresso e o relatório da conversão de conteúdo da versão 5.x.
GratuitoGET /wp-json/wp-abilities/v1/abilities/pbs/get-migration/runverificação própria de permissão por item da rota RESTnenhum
pbs/get-motion-options
Retorna todas as configurações de movimento (animação de entrada, duração e atraso, efeito de rolagem, efeito ao passar o mouse, manter na visualização, paralaxe, seguir o ponteiro) com suas opções ou intervalos, e os pontos de quebra do site.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-motion-options/runedit_posts (verificação própria da rota REST)nenhum
pbs/get-newsletter-keys
Informa se uma chave do Mailchimp está salva (a chave em si nunca é retornada).
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-newsletter-keys/runedit_posts (verificação própria da rota REST)nenhum
pbs/get-page
Retorna o título, status, links e conteúdo em blocos de uma página, além das seções (blocos de nível superior) que a compõem.
GratuitoGET /wp-json/wp-abilities/v1/abilities/pbs/get-page/runedit_post nessa páginaid número inteiro (obrigatório)
pbs/get-replace-job
Retorna as correspondências de uma tarefa, página por página, para revisão antes de aplicar.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-replace-job/runmanage_options (verificação própria da rota REST)id texto (obrigatório)
pbs/get-reviews-sources
Retorna as fontes do Google e da Trustpilot exibidas pelo bloco Avaliações.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-reviews-sources/runmanage_options (verificação própria da rota REST)nenhum
pbs/get-roles
Retorna quais funções podem usar o construtor, design, código e modelos (modo cliente).
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-roles/runmanage_options (verificação própria da rota REST)nenhum
pbs/get-settings
Retorna o prefixo de classe do front-end, o status de atualizações beta e se agentes de IA (MCP) são permitidos.
GratuitoGET /wp-json/wp-abilities/v1/abilities/pbs/get-settings/runmanage_options (verificação própria da rota REST)nenhum
pbs/get-structured-data
Lista os dados estruturados do schema.org exibidos pelos blocos de uma página (Perguntas frequentes, Passo a passo, Produto, Avaliação, Navegação estrutural) e quais tipos são deixados para o plugin de SEO do site para que nada seja exibido duas vezes.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-structured-data/runedit_post na páginapost_id número inteiro (obrigatório)
pbs/get-support-connection
Informa se este site está conectado ao suporte da Zinn Digital® e sob qual usuário.
GratuitoGET /wp-json/wp-abilities/v1/abilities/pbs/get-support-connection/runmanage_options (verificação própria da rota REST)refresh booleano
pbs/get-theme-builder-options
Retorna os tipos de modelo, os tipos de condição de exibição (página, tipo de post, termo, arquivo, pesquisa, 404, conectado, função, dispositivo, data, hora, parâmetro de URL, referenciador, idioma, carrinho) com suas opções neste site (funções, idiomas, tipos de post, taxonomias) e o atributo de bloco (pbswConditions: {match, rules}) que exibe ou oculta qualquer bloco.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-theme-builder-options/runedit_posts (verificação própria da rota REST)nenhum
pbs/get-white-label
Retorna as configurações de white label: ativado ou desativado, o nome exibido e quais usuários ainda veem o original.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/get-white-label/runmanage_options (verificação própria da rota REST)nenhum
pbs/import-design
Valida um arquivo de design do site (file) e, com apply false, retorna o que merge ou replace (mode) adicionaria, alteraria e removeria; com apply true, grava as alterações.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/import-design/runedit_theme_options (verificação própria da rota REST)file objeto (obrigatório)
mode texto: merge, replace
apply booleano
pbs/import-designs
Importa um pacote de design do Page Builder Sandwich (dryRun primeiro para ver o que mudaria; mode: skip ou replace; media; settings).
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/import-designs/runmanage_options (verificação própria da rota REST)package objeto (obrigatório)
mode texto: skip, replace, duplicate
settings booleano
media booleano
dryRun booleano
pbs/import-figma-frame
Importa um frame do Figma (url: o link do frame, com seu node-id) em uma nova página de rascunho feita de blocos: o layout automático se torna contêineres flex e grid, o texto mantém suas fontes e tamanhos, as imagens são copiadas para a biblioteca de mídia. Usa o próprio token do Figma do site. Responde com o rascunho e um relatório de conversão.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/import-figma-frame/runedit_pages e upload_files (verificação própria da rota REST)url string (obrigatório)
title string
dryRun boolean
status string: draft, pending, private, publish
pbs/invite-team-member
Cria um código de convite de uso único (função: read ou write; rótulo; dias de validade). O código é exibido uma única vez.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/invite-team-member/runmanage_options (verificação própria da rota REST)team string (obrigatório)
role string: read, write
days integer
label string
pbs/join-team
Entra em uma biblioteca de equipe com um código de convite.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/join-team/runmanage_options (verificação própria da rota REST)code string (obrigatório)
pbs/leave-team
Sai da biblioteca de equipe da qual este site faz parte.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/leave-team/runmanage_options (verificação própria da rota REST)nenhum
pbs/list-ab-tests
Lista os testes A/B com os visitantes e conversões de cada versão, e qual delas está ganhando.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-ab-tests/runedit_pages (verificação própria da rota REST)nenhum
pbs/list-blocks
Lista todos os blocos do Page Builder Sandwich que este site pode usar (blocos Pro também, quando o Pro estiver ativo): nome, título, categoria e descrição.
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-blocks/runedit_postssearch string
pbs/list-dynamic-sources
Retorna com o que um bloco pode ser preenchido (post, author, site, archive, custom field, product) com os campos de cada fonte, os plugins de campos neste site (ACF, Meta Box, Pods, JetEngine, Toolset, post meta) e os campos de um tipo de post (postType). Um bloco é vinculado a uma fonte por meio de attributes.metadata.bindings, um {source, args} por atributo.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-dynamic-sources/runedit_posts (verificação própria da rota REST)postType string
pbs/list-extensions
Lista o que outros plugins adicionaram ao Page Builder Sandwich por meio de sua API de desenvolvedor: blocos, fontes de dados dinâmicos, condições de exibição e ações de formulário, cada um com seu nome, rótulo e plugin.
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-extensions/runedit_postsnenhum
pbs/list-form-submissions
Lista o que os visitantes enviaram através dos formulários que salvam envios (form restringe o resultado), uma página por vez.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-form-submissions/runverificação de permissão própria por item da rota RESTform string
per_page integer
page integer
pbs/list-forms
Lista os formulários criados com o bloco Formulário e os plugins de formulário que ele pode incorporar.
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-forms/runedit_posts (verificação própria da rota REST)nenhum
pbs/list-kits
Lista os kits de site (um conjunto de páginas prontas para um tipo de negócio) que este site pode importar.
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-kits/runedit_pages e publish_pagesrefresh boolean
pbs/list-library-items
Lista os designs salvos na biblioteca na nuvem (kind: section, page ou pattern; team: biblioteca de uma equipe).
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-library-items/runedit_posts (verificação própria da rota REST)team string
kind string: , section, page, style
pbs/list-local-fonts
Lista as fontes do Google que este site hospeda localmente (baixadas uma vez, servidas pelo próprio site, sem requisições ao Google).
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-local-fonts/runmanage_options (verificação própria da rota REST)nenhum
pbs/list-lottie
Lista as animações Lottie enviadas.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-lottie/runedit_posts (verificação própria da rota REST)nenhum
pbs/list-marketing-connections
Lista os serviços de lista de e-mails (Mailchimp, Brevo, MailerLite, Kit, ActiveCampaign) e quais estão conectados. As chaves nunca são retornadas.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-marketing-connections/runmanage_options (verificação própria da rota REST)nenhum
pbs/list-marketing-forms
Lista todos os formulários criados com o construtor de formulários: a página em que está, seus campos e o que acontece quando ele é enviado.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-marketing-forms/runedit_pages (verificação própria da rota REST)nenhum
pbs/list-marketing-lists
Lista os públicos ou listas de um serviço de lista de e-mails conectado, para a ação de inscrição de um formulário.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-marketing-lists/runedit_posts (verificação própria da rota REST)service string (obrigatório)
pbs/list-pages
Lista as páginas que você pode editar, as mais recentes primeiro, com uma busca opcional.
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-pages/runedit_pages; apenas as páginas que você pode editar são listadassearch string
status string: any, draft, pending, publish, private
page integer
per_page integer
pbs/list-popups
Lista os popups, slide-ins e barras com seus gatilhos, regras de frequência e onde aparecem.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-popups/runedit_pages (verificação própria da rota REST)nenhum
pbs/list-replace-jobs
Lista as tarefas de busca e substituição em todo o site e seus estados.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-replace-jobs/runmanage_options (verificação própria da rota REST)nenhum
pbs/list-sections
Lista as seções prontas (hero, recursos, FAQ, depoimentos, chamada para ação e muito mais) que podem ser adicionadas a uma página.
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-sections/runedit_pagessearch string
pbs/list-team-members
Lista os sites em uma equipe e seus acessos.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-team-members/runmanage_options (verificação própria da rota REST)team string (obrigatório)
pbs/list-teams
Lista as equipes às quais este site pertence ou das quais é proprietário.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-teams/runmanage_options (verificação própria da rota REST)nenhum
pbs/list-theme-templates
Lista os modelos do construtor de temas (cabeçalho, rodapé, post único, arquivo, pesquisa, 404 e, com o WooCommerce, produto, loja, carrinho, finalização de compra, página de agradecimento e Minha conta): tipo de cada um, onde é exibido (regras de inclusão/exclusão), prioridade, status e blocos.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/list-theme-templates/runverificação própria de permissão por item da rota RESTnenhum
pbs/list-transferable
Lista os modelos, padrões e configurações que podem ser exportados para outro site.
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-transferable/runmanage_options (verificação própria da rota REST)nenhum
pbs/list-uploaded-icons
Lista os ícones SVG enviados para a biblioteca de ícones, os mais recentes primeiro.
FreeGET /wp-json/wp-abilities/v1/abilities/pbs/list-uploaded-icons/runedit_posts (verificação própria da rota REST)page integer
per_page integer
pbs/move-section
Move uma seção de uma página de uma posição para outra (baseado em 0, na ordem em que a página as lista).
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/move-section/runedit_post nessa páginaid integer (obrigatório)
from integer (obrigatório)
to integer (obrigatório)
pbs/open-support-ticket
Abre um chamado de suporte (assunto, mensagem, tipo, e-mail), com os diagnósticos deste site quando houver concordância da administração. Nunca cria ou envia credenciais de login.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/open-support-ticket/runmanage_options (verificação própria da rota REST)subject string (obrigatório)
message string (obrigatório)
kind string: help, bug, feedback, feature_request
email string
name string
diagnostics boolean
pbs/preview-dynamic-value
Retorna o que uma associação exibe em um post (post, fonte e campo ou provedor + chave, como text|url), para verificar uma associação antes ou depois de adicioná-la.
ProGET /wp-json/wp-abilities/v1/abilities/pbs/preview-dynamic-value/runedit_post (verificação própria da rota REST)post integer (obrigatório)
source string (obrigatório)
field string
provider string
key string
as string: text, url
pbs/record-support-consent
Registra o consentimento da administração para enviar diagnósticos com chamados de suporte.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/record-support-consent/runmanage_options (verificação própria da rota REST)consent boolean (obrigatório)
pbs/refresh-reviews
Obtém as avaliações mais recentes do Trustpilot agora, em vez de esperar pela atualização diária.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/refresh-reviews/runmanage_options (verificação própria da rota REST)nenhum
pbs/remove-block
Remove um bloco (uma seção inteira ou um bloco dentro de uma) de uma página, localizado pelo seu caminho. A versão anterior da página permanece nas revisões dela.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/remove-block/runedit_post nessa páginaid integer (obrigatório)
path array (obrigatório)
pbs/remove-library-storage
Remove as configurações de armazenamento próprio; o armazenamento do plano volta a ser usado.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/remove-library-storage/runmanage_options (verificação própria da rota REST)nenhum
pbs/remove-local-font
Exclui os arquivos de uma família de fontes hospedada localmente.
FreePOST /wp-json/wp-abilities/v1/abilities/pbs/remove-local-font/runmanage_options (verificação própria da rota REST)family (obrigatório)
pbs/remove-team-member
Remove um site de uma equipe.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/remove-team-member/runmanage_options (verificação própria da rota REST)team (obrigatório)
member (obrigatório)
pbs/reset-ab-test
Zera as contagens de um teste e o reinicia (test).
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/reset-ab-test/runedit_pages (verificação própria da rota REST)test (obrigatório)
pbs/save-library-item
Salva a estrutura do bloco (title, kind, markup, styles, tags) na sua biblioteca na nuvem ou da equipe; imagens são empacotadas junto.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/save-library-item/runedit_posts (verificação própria da rota REST)team
kind (obrigatório): section, page, style
title (obrigatório)
tags
markup
styles
pbs/set-block-motion
Define ou remove (null) as configurações de movimento em um bloco de uma página, localizado pelo caminho, em um ponto de interrupção (base por padrão). Funciona em qualquer bloco, incluindo blocos nativos cujo HTML está salvo na página. Visitantes que solicitam redução de movimento nunca veem a animação.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-block-motion/runedit_post (verificação própria da rota REST)post (obrigatório)
path (obrigatório)
breakpoint
motion (obrigatório)
pbs/set-library-storage
Salva o armazenamento próprio: provider (r2 ou s3), bucket, region, endpoint, prefix, key_id, secret, enabled.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-library-storage/runmanage_options (verificação própria da rota REST)enabled
provider: r2, s3, other
endpoint
region
bucket
prefix
keyId
secret
pathStyle
pbs/set-maintenance
Ativa ou desativa o modo de manutenção (503) ou em breve (mode), com a página a exibir (page_id), retry_after e as funções que o ignoram.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-maintenance/runmanage_options (verificação própria da rota REST)mode: off, maintenance, coming_soon
page_id
roles
retry_after
pbs/set-newsletter-keys
Salva (ou, com valor vazio, remove) a chave de API do Mailchimp que o bloco de newsletter usa.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-newsletter-keys/runmanage_options (verificação própria da rota REST)mailchimp (obrigatório)
pbs/set-reviews-sources
Define o local do Google e a empresa no Trustpilot que o bloco Avaliações lê.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-reviews-sources/runmanage_options (verificação própria da rota REST)google
trustpilot
pbs/set-roles
Define por função o que o construtor permite (roles), por exemplo, uma função de cliente apenas para conteúdo.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-roles/runmanage_options (verificação própria da rota REST)roles (obrigatório)
pbs/set-white-label
Ativa ou desativa o white label e define o nome que os clientes veem (enabled, name, agency_users).
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/set-white-label/runmanage_options (verificação própria da rota REST)enabled
name
studio_name
author
author_url
description
menu_icon
hide_plugin
agency_users
pbs/site-health-clean
Limpa um tipo de item encontrado: revisões (mantém as 5 mais recentes de cada post, exclui as mais antigas), padrões (move padrões sincronizados não utilizados para a lixeira), imagens (uma cópia dimensionada que o WordPress usa; a original é mantida), classes (remove classes de design não utilizadas, mantidas para restauração). Cada execução limpa um lote; “more” é verdadeiro enquanto restarem itens.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/site-health-clean/runmanage_optionswhat (obrigatório): revisions, patterns, images, classes
pbs/site-health-report
Encontra revisões antigas, padrões sincronizados não usados por nada, imagens originais pesadas e classes de design que nenhuma página usa. Funciona em etapas curtas: cada execução continua de onde a última parou enquanto o status for “scanning”; reiniciar começa do início.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/site-health-report/runmanage_optionsrestart boolean
pbs/start-migration
Inicia (ou reinicia) a conversão de cada página 5.x para blocos; cada post é salvo em backup antes.
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/start-migration/runa própria verificação de permissão por item da rota RESTnenhum
pbs/start-replace
Inicia uma busca e substituição segura para blocos (find, replace, kind: texto, link ou cor; match_case; types). Nada muda até que a tarefa pré-visualizada seja aplicada.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/start-replace/runmanage_options (a própria verificação da rota REST)find string (obrigatório)
replace string
kind string: text, link, colour
types array
match_case boolean
pbs/start-trial
Inicia o período de teste de 14 dias do Page Builder Sandwich Pro para este site (nenhum pagamento necessário).
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/start-trial/runmanage_options (a própria verificação da rota REST)nenhum
pbs/test-library-storage
Grava, lê e exclui um objeto de teste em seu próprio armazenamento e relata cada etapa.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/test-library-storage/runmanage_options (a própria verificação da rota REST)nenhum
pbs/undo-convert-post
Restaura uma página convertida a partir do seu backup.
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/undo-convert-post/runa própria verificação de permissão por item da rota RESTid string (obrigatório)
pbs/undo-migration
Restaura cada post convertido a partir do seu backup.
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/undo-migration/runa própria verificação de permissão por item da rota RESTnenhum
pbs/undo-replace
Restaura os posts alterados por uma tarefa (um post editado desde então mantém sua edição).
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/undo-replace/runmanage_options (a própria verificação da rota REST)id string (obrigatório)
pbs/update-block
Altera as configurações (atributos) de um bloco dentro de uma página, localizado pelo seu caminho; os atributos enviados são mesclados aos atuais. Funciona em blocos que o site renderiza a partir de suas configurações; um bloco cujo HTML está salvo na página é alterado substituindo a marcação da página.
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/update-block/runedit_post nessa páginaid integer (obrigatório)
path array (obrigatório)
attributes object (obrigatório)
pbs/update-brand-kit
Salva o kit de marca: nome, logotipo, cores, fontes de título e corpo, e o tom de voz da marca usado pela escrita por IA.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-brand-kit/runedit_theme_options (a própria verificação da rota REST)name string
logo integer
colors array
headingFont string
bodyFont string
voice string
pbs/update-breakpoints
Altera as larguras de tablet e celular em pixels; com o Pro, pontos de quebra extras personalizados.
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/update-breakpoints/runedit_theme_options (a própria verificação da rota REST)tablet integer
mobile integer
custom array
pbs/update-class
Altera o rótulo, o slug ou os estilos de uma classe global; cada elemento que a usa é atualizado.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-class/runedit_theme_options (a própria verificação da rota REST)id string (obrigatório)
label string
slug string
s object
cat string
pbs/update-conversion-tracking
Altera as configurações do Google Analytics 4, Google Tag Manager e Meta Pixel e quais eventos são enviados.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-conversion-tracking/runmanage_options (a própria verificação da rota REST)ga4 string
gtm string
pixel string
loadTags boolean
formEvent string
pbs/update-cookie-banner
Altera o banner de consentimento. Enquanto estiver ativo, os scripts de rastreamento aguardam o consentimento do visitante.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-cookie-banner/runmanage_options (a própria verificação da rota REST)enabled boolean
popup integer
handles array
cookieDays integer
optOutOutsideEu boolean
pbs/update-dark-mode
Define o modo escuro (modo: desativado, automático ou alternar) e suas cores.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-dark-mode/runedit_theme_options (a própria verificação da rota REST)mode string (obrigatório): device, light, dark
colors object
pbs/update-design-categories
Substitui uma lista de categorias (group: classes ou tokens; items: uma lista de slug e nome). Itens associados a uma categoria removida ficam sem categoria.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-design-categories/runedit_theme_options (verificação própria da rota REST)group string (obrigatório): classes, tokens
items array (obrigatório)
pbs/update-design-globals
Altera as cores (colors) e fontes (fonts, headingFont, bodyFont) globais do site. Todas as páginas aplicam a alteração; o arquivo theme.json do tema é mantido sincronizado.
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/update-design-globals/runedit_theme_options (verificação própria da rota REST)colors object
fonts object
bodyFont string
headingFont string
pbs/update-form
Altera um formulário (post, form): configurações e ações são combinadas com o que já existe; campos (e etapas) substituem os campos.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-form/runedit_post (verificação própria da rota REST)post string (obrigatório)
form string (obrigatório)
title string
fields array
steps array
actions object
submitText string
successMessage string
redirectUrl string
trackEvent string
pbs/update-page
Altera o título, status ou conteúdo de blocos de uma página. O conteúdo enviado substitui o conteúdo da página.
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/update-page/runedit_post nessa página; publish_pages para publicar ou tornar privadaid integer (obrigatório)
title string
status string: draft, pending, publish, private
sections array
content string
pbs/update-popup
Altera um popup, slide-in ou barra (id): conteúdo, gatilho, frequência ou onde é exibido.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-popup/runedit_post (verificação própria da rota REST)id string (obrigatório)
title string
content string
status string: draft, publish
settings object
pbs/update-settings
Altera o prefixo de classe no front-end (de 1 a 8 letras minúsculas ou dígitos, começando com uma letra) e/ou ativa ou desativa agentes de IA (MCP) (mcp: false remove todas as habilidades e o endpoint MCP).
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/update-settings/runmanage_options (verificação própria da rota REST)prefix string
mcp boolean
pbs/update-theme-template
Altera um modelo (id): qualquer um dentre título, tipo, conteúdo (marcação de bloco), inclusão, exclusão, prioridade ou status. Apenas o que você envia é alterado.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-theme-template/runverificação de permissão própria por item da rota RESTid string (obrigatório)
title string
type string
content string
include array
exclude array
priority integer
status string: publish, draft
pbs/update-tokens
Altera as escalas de espaçamento, raio e sombra (space, radius, shadow), ou as redefine (reset).
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-tokens/runedit_theme_options (verificação própria da rota REST)space array
radius array
shadow array
reset boolean
pbs/update-variables
Substitui as variáveis de design do site (variables: uma lista de name e value).
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/update-variables/runedit_theme_options (verificação própria da rota REST)variables array (obrigatório)
pbs/upload-icon
Adiciona um ícone SVG (name, marcação svg) à biblioteca de ícones; o SVG é sanitizado primeiro.
GratuitoPOST /wp-json/wp-abilities/v1/abilities/pbs/upload-icon/runupload_files (verificação própria da rota REST)name string (obrigatório)
svg string (obrigatório)
pbs/upload-lottie
Valida um documento JSON do Lottie (json, name) e o publica como arquivo estático para o bloco Lottie.
ProPOST /wp-json/wp-abilities/v1/abilities/pbs/upload-lottie/runupload_files (verificação própria da rota REST)name string (obrigatório)
json string (obrigatório)

Gerado a partir do abilities.json do plugin, que por sua vez é gerado a partir de um site em execução; um teste falha quando os dois divergem.

Comandos WP-CLI

Execute estes comandos no servidor com o WP-CLI. Cada comando verifica as mesmas permissões que as telas do plugin; os exemplos foram extraídos do próprio texto de ajuda do plugin.

ComandoO que fazEdição
wp pbs export [--types=<types>] [--no-settings] [--file=<name>]Exporta modelos, padrões e configurações para um arquivo.Gratuita
wp pbs import <file> [--mode=<mode>] [--no-settings] [--media] [--dry-run]Importa um arquivo de exportação.Gratuita
wp pbs importers runConverte conteúdo legado: todos os posts ou um específico.Gratuita
wp pbs importers statusMostra o status da migração.Gratuita
wp pbs importers undoDesfaz conversões a partir dos backups: todos os posts ou um específico.Gratuita
wp pbs migrate runConverte conteúdo legado: todos os posts ou um específico.Gratuita
wp pbs migrate statusMostra o status da migração.Gratuita
wp pbs migrate undoDesfaz conversões a partir dos backups: todos os posts ou um específico.Gratuita
wp pbs replace <find> <replace> [--kind=<kind>] [--types=<types>] [--ignore-case] [--dry-run] [--undo=<job>]Localiza e substitui em todo o site.Pro
wp pbsw fonts download <family> [--weights=<weights>] [--italic]Baixa uma família do Google Fonts para este site.Gratuita
wp pbsw fonts listLista as famílias salvas.Gratuita
wp pbsw fonts remove <family>Remove uma família salva e seus arquivos.Gratuita

Ações e filtros

Cada hook que o plugin oferece, com a descrição do seu código-fonte. Filtros alteram um valor; ações permitem executar código em determinado momento; pontos de entrada são ações que você dispara para solicitar que o plugin faça algo.

GanchoTipoO que fazParâmetrosEdição
pbs_assets_changedAçãoÉ acionado quando os arquivos de front-end publicados do PBS mudam e os caches de página acessíveis foram esvaziados: use-o para limpar o que o PBS não alcança (uma CDN, um proxy, o cache da hospedagem).nenhumGratuita
pbs_enqueue_scriptsAçãoAção legada: enfileira scripts que chamam window.pbsAddInspector().nenhumGratuita
pbs_shortcodesFiltroFiltro legado: tag do shortcode => {label, desc, options[]} (Shortcode-API.md).array $shortcodesGratuita
pbsw_admin_dataFiltroFiltra os dados com os quais o app de administração inicializa. A camada premium o usa para informar sua edição; nada confidencial deve ficar aqui, pois é impresso na página.nenhumGratuita
pbsw_admin_enqueueAçãoÉ acionado após o script da tela de administração ser enfileirado, para que um módulo possa enfileirar um script que adiciona um painel pelo filtro JavaScript `pbs.admin.panels` (deve depender desse identificador; a tela renderiza no DOM ready, após todos os scripts do rodapé serem executados).string $handleGratuita
pbsw_ai_enqueueAçãoÉ acionado após o pacote do editor de IA ser enfileirado, para que uma extensão (e a camada Pro) possa enfileirar seus próprios painéis de IA depois dele.string $handleGratuita
pbsw_ai_messagesFiltroFiltra as mensagens de cada solicitação de IA que o plugin envia, com seu contexto (tarefa, finalidade, provedor, modelo, usuário); o kit de marca do Pro adiciona sua marca aqui.array $messages
array $context
Gratuita
pbsw_ai_pro_featuresFiltroFiltra os recursos de IA do Pro que o editor oferece (a camada premium adiciona seus nomes: agent, site, block, design, image, css, a11y).nenhumGratuita
pbsw_ai_seo_pluginsFiltroFiltra em quais plugins de SEO o assistente de SEO com IA grava o título e a descrição meta.nenhumGratuita
pbsw_ai_seo_writeFiltroFiltra se outro plugin de SEO recebeu o título e a descrição meta. Um plugin adicionado em `pbsw_ai_seo_plugins` os salva aqui, à sua maneira, e retorna true.bool $written
string $plugin
int $post_id
string $title
string $description
Gratuita
pbsw_asset_sourcesFiltroTodas as origens do front-end: deste arquivo, as que a camada de desempenho registra com add_source() (CSS por bloco, módulos de visualização) e as que a camada premium adiciona para si por `pbsw_asset_sources` (seus arquivos ficam em seu próprio diretório, incluído apenas no pacote premium). Apenas caminhos relativos simples `.css`/`.js` dentro do plugin são aceitos, sob uma chave de segmentos em letras minúsculas (`legacy.css`, `block/row.css`, `module/tabs.js`).nenhumGratuita
pbsw_breakpoints_changedAçãoÉ acionado quando os pontos de quebra mudam (as folhas de página compiladas são reconstruídas na próxima visualização, pois os pontos de quebra fazem parte de sua assinatura).nenhumGratuita
pbsw_cache_purgedAçãoÉ acionado após o PBS limpar um post dos plugins de cache ativos.int $post_idGratuita
pbsw_cache_purgersFiltroFiltra os limpadores extras executados quando os arquivos publicados mudam: nome => chamável. Uma hospedagem adiciona os seus próprios (uma CDN, um proxy); se um lançar exceção, é ignorado e não é informado como limpo.nenhumGratuita
pbsw_code_blocksFiltroFiltra os nomes de blocos tratados como código personalizado (apenas funções com a permissão `code` podem adicioná-los ou alterá-los).nenhumPro
pbsw_consent_countryFiltroFiltra o país do visitante (ISO 3166-1 alfa-2) para a regra regional do banner de cookies. O plugin nunca consulta um país; retorne ” quando for desconhecido.string $countryPro
pbsw_content_onlyFiltroFiltra se um usuário pode editar apenas texto e imagens, com o layout bloqueado.bool $content_only
int $user_id
Gratuita
pbsw_design_class_cssFiltroFiltra o CSS compilado de uma classe global antes de consultar o motor de design. Retorne uma string para usá-la em vez disso.string|null $css
string $selector
Pro
pbsw_design_custom_breakpointsFiltroFiltra se pontos de quebra personalizados estão disponíveis (pbs-d3, Pro).bool $allowedGratuita
pbsw_design_element_cssFiltroFiltra se o CSS personalizado por elemento é compilado (a camada premium o ativa, d8).bool $enabledGratuita
pbsw_design_layout_suffixFiltroFiltra o sufixo do seletor do elemento de layout para um bloco (” = o próprio elemento do bloco).string $suffix
string $prefix
Gratuita
pbsw_design_propsFiltroFiltra as propriedades de design (a camada premium adiciona as suas próprias).nenhumGratuita
pbsw_dynamic_editor_sourcesFiltroMais fontes no editor (campos de produtos do WooCommerce).nenhumPro
pbsw_dynamic_fieldsFiltroCatálogo de campos para provedores sem API de listagem que este plugin leia (JetEngine, Toolset): as chaves dos campos são digitadas no editor ou adicionadas aqui.string $post_typePro
pbsw_dynamic_sourcesFiltroMais fontes (produtos do WooCommerce): nome → rótulo; os valores vêm de `pbsw_dynamic_value`.nenhumPro
pbsw_dynamic_valueFiltroUm valor de outra fonte (WooCommerce).string|null $value
string $source
Pro
pbsw_form_submittedAçãoDisparada após o envio de um formulário passar pela validação e suas ações serem executadas.nenhumPro
pbsw_frontend_prefixFiltroFiltra o prefixo neutro de classe no front-end.string $prefixGratuito
pbsw_fs_loadedAçãoDisparada quando o SDK de licenciamento for carregado (no arquivo principal, antes de qualquer código do Page Builder Sandwich). Conecte aqui para se comunicar com `pbsw_fs()`.nenhumGratuito
pbsw_is_agencyFiltroFiltra se os recursos do plano Agency estão disponíveis neste site.bool $agencyGratuito
pbsw_is_proFiltroFiltra se a camada premium está ativa. Apenas a camada premium responde a ele.bool $proGratuito
pbsw_kit_api_baseFiltroFiltra a base da API Zinn Digital® chamada pelas telas de suporte.string $baseGratuito
pbsw_kit_diagnosticsFiltroFiltra o diagnóstico antes que quem gerencia o site possa vê-lo. Um plugin adiciona suas próprias informações em `extra`. ⛔ Isso roda ANTES da pré-visualização, nunca entre ela e o envio.nenhumGratuito
pbsw_kit_footprint_freeFiltroFiltra se este site é livre de rastros (footprint-free), para que o Zinn® Ads nunca seja promovido nele.bool $footprint_freeGratuito
pbsw_kit_importedAçãoDisparada após a importação de um kit.int $frontGratuito
pbsw_kit_promotionsFiltroFiltra o registro de promoções antes de ser resolvido. Adicione uma linha para promover outro produto: `id`, `kind` (hosting|marketplace|platform|plugin|bundle|ads), `slot` (promo|cross-sell) e `url` ou (para um plugin) `name`, `site`, `main_files`.nenhumGratuito
pbsw_kit_tierFiltroFiltra o nível do plano que o kit informa para este plugin (testes e staging; a licença define em produção).string $tierGratuito
pbsw_lcp_foldFiltroA distância até onde o conteúdo é considerado a primeira dobra da tela, em pixels CSS a partir do topo. Blocos que começam acima disso são tratados como acima da dobra: suas imagens carregam imediatamente e a imagem com maior probabilidade de ser a LCP recebe `fetchpriority=”high”`; blocos abaixo carregam sob demanda (lazy-load). Aumente para um hero alto, diminua para um cabeçalho compacto.int $foldGratuito
pbsw_legacy_body_classesFiltroFiltra as classes de body legadas. A camada premium adiciona as classes responsivas legadas do premium aqui (diretriz 5: esse comportamento não está no plugin gratuito).nenhumGratuito
pbsw_legacy_script_enqueuedAçãoUm post legado foi examinado quanto ao comportamento no front-end (a camada premium adiciona o seu).int $post_id
string $content
string|null $handle
Gratuito
pbsw_library_tokenFiltroFiltra o token bearer enviado com as requisições de kits (a biblioteca em nuvem premium o fornece).string $tokenGratuito
pbsw_link_baseFiltroFiltra o caminho sob o qual os links curtos ficam (`/go/<slug>/`).string $basePro
pbsw_list_servicesFiltroFiltra os serviços de listas de e-mails nos quais os formulários podem inscrever usuários.nenhumPro
pbsw_loop_query_argsFiltroA consulta do loop (WooCommerce: faixa de preço, em promoção, em estoque, ordenações por preço/popularidade/avaliação).nenhumPro
pbsw_loop_sortsFiltroOpções de ordenação (o WooCommerce adiciona preço, popularidade e avaliação).nenhumPro
pbsw_mcp_abilitiesAçãoDisparada após os recursos gratuitos serem registrados: o Page Builder Sandwich Pro registra os seus aqui (sua inicialização só se conecta a isso quando a licença permite o código premium).nenhumGratuito
pbsw_migration_batch_sizeFiltroQuantos posts legados (5.x) uma etapa de migração em segundo plano converte. Cada etapa é uma ação do Action Scheduler; um lote menor é ideal para hospedagens lentas ou com pouca memória, um maior para hospedagens rápidas com muitos posts. Valores abaixo de 1 são tratados como 1.int $sizeGratuito
pbsw_migration_post_typesFiltroFiltra os tipos de post que a migração de versões legadas converte.list<string> $typesGratuito
pbsw_nav_menu_item_classesFiltroFiltra as classes de um item (as opções de item do Pro adicionam `nav-menu__item–hide-mobile` e `–hide-desktop`). Somente as classes `nav-menu__item–<name>` são mantidas.int $depthGrátis
pbsw_nav_menu_item_labelFiltroFiltra o rótulo de um item, que é HTML com escape (as opções de item do Pro adicionam um ícone, um emblema e a descrição). Um retorno de chamada deve retornar HTML com escape.string $label
int $depth
string $prefix
Grátis
pbsw_nav_menu_toggleFiltroFiltra o HTML do botão Menu: o designer da barra de alternância do Pro o coloca em uma barra com logotipo, caixa de pesquisa, links… (exibido somente quando o menu estiver recolhido). Um resultado que não contenha o botão inalterado é ignorado, para que o menu nunca o perca.string $toggle
string $prefix
Grátis
pbsw_newsletter_form_settingsFiltroAs configurações de um formulário que não seja da versão 5.x (data-* ⇒ valor), ou uma matriz vazia.int $post_id
string $form
Grátis
pbsw_newsletter_providersFiltroOs serviços de newsletter aos quais este site pode se inscrever: service ⇒ callable( string $email, array $settings ): array{ok: bool, message: string}. A camada premium adiciona os três da versão 5.x.nenhumGrátis
pbsw_page_css_changedAçãoAcionado quando a folha de estilos compilada de um post for alterada (plugins de cache limpam com base nela).int $post_idGrátis
pbsw_page_css_enqueuedAçãoAcionado após a folha de estilos compilada de uma página ser enfileirada (a camada premium de CSS crítico se conecta aqui).string $handle
int $post_id
Grátis
pbsw_page_css_extraFiltroFiltra o CSS anexado à folha compilada de uma página após as folhas de estilo dos próprios blocos (pbs-p4: as regras `.<prefix>-s-<id>` do sistema de design). Compilado, não minificado aqui: um ouvinte retorna seu CSS pronto para uso.string $extra
string $prefix
int $post_id
Grátis
pbsw_page_css_signatureFiltroFiltra o que mais mantém um estado compilado atualizado (pbs-p4: os pontos de quebra).string $extra
\WP_Post $post
Grátis
pbsw_page_css_stateFiltroFiltra o estado compilado de um post antes de ser armazenado (o pbs-p4 registra quais regras de design a folha carrega, para que o filtro de renderização não as imprima novamente).int $post_idGrátis
pbsw_permissionFiltroFiltra se um usuário pode usar uma capacidade do construtor. O plugin gratuito permite a todos; o gerenciador de funções do Pro responde por função. Administradores devem ter permissão sempre.bool $allowed
string $what
int $user_id
Grátis
pbsw_popup_forceFiltroPop-ups exibidos em todas as páginas, independentemente da segmentação (o banner de cookies).nenhumPro
pbsw_replace_post_typesFiltroFiltra os tipos de post em que o localizar e substituir pesquisa por padrão.nenhumPro
pbsw_schema_skipFiltroFiltra os tipos de dados estruturados que o Page Builder Sandwich omite porque o plugin de SEO do site já os exibe para esta página.string $contentPro
pbsw_site_design_dataFiltroFiltra os dados de inicialização do Site design. A camada premium relata sua edição e adiciona os dados de que suas seções precisam.nenhumGrátis
pbsw_site_design_depsFiltroFiltra as dependências dos pacotes do Site design. A camada premium adiciona seu próprio script aqui, para que suas seções sejam registradas antes da primeira renderização do painel.string $handleGrátis
pbsw_site_health_keep_revisionsFiltroFiltra quantas revisões mais recentes de cada post a limpeza mantém (o padrão é 5).int $keepPro
pbsw_style_at_rulesFiltroFiltra as predefinições de at-rules que o construtor de estilos oferece em Estilo › Condição: uma lista de `array( ‘id’ => ‘narrow-card’, ‘label’ => ‘Narrow card’, ‘type’ => ‘container’, ‘query’ => ‘card (max-width:400px)’ )`, onde `type` é `media`, `container` ou `supports`. Valores definidos sob uma condição são impressos como `@<type> <query>{…}` após as regras de tamanho de tela. As predefinições integradas são impressão, esquema de cores escuras, movimento reduzido e mouse ou trackpad; uma predefinição inválida é descartada e nomeada na ação `pbsw_style_at_rules_invalid`.nenhumGrátis
pbsw_style_at_rules_invalidAçãoAcionado quando predefinições de `pbsw_style_at_rules` foram descartadas por serem inválidas.nenhumGrátis
pbsw_template_content_locationFiltroUma localização de conteúdo mais específica (WooCommerce: single_product, product_archive, cart…).string $locationPro
pbsw_template_resolvedFiltroOs modelos escolhidos para um local.string $typePro
pbsw_template_typesFiltroMais tipos de modelo (páginas do WooCommerce).nenhumPro
pbsw_theme_builder_editor_dataFiltroMais dados do editor (fontes de dados dinâmicos e plugins de campos, os elementos do WooCommerce).nenhumPro
pbsw_theme_globals_savedAçãoEsta ação está documentada abaixo.nenhumGratuito
pbsw_transfer_importedAçãoExecutada após a importação de um pacote, para que os caches criados a partir de modelos e configurações (os estilos por página, a folha de estilos do site) possam ser reconstruídos.nenhumGratuito
pbsw_transfer_meta_keysFiltroFiltra as chaves de metadados do post que a importação e a exportação transferem com cada item.nenhumGratuito
pbsw_transfer_optionsFiltroFiltra as opções que a importação e a exportação podem mover entre sites. Apenas opções `pbsw_` são aceitas; tudo o mais é descartado para que um pacote nunca possa gravar uma opção do núcleo ou de terceiros.nenhumGratuito
pbsw_transfer_post_typesFiltroFiltra os tipos de post que a importação e a exportação podem mover entre sites.nenhumGratuito
pbsw_visitor_countryFiltroFiltra o país do visitante para o controle de idade e avisos de jogo responsável, em sites que obtêm essa informação de outra forma (um plugin de geolocalização, um perfil de membro).string $countryPro
pbsw_white_label_mapFiltroFiltra as substituições de white-label (texto de origem => texto exibido).nenhumPro