Hooks de PHP
A seguir, você encontrará uma lista de todos os hooks disponíveis de PHP que podem ser usados para ampliar ou ajustar a funcionalidade do plugin.
Caminho
Este filtro permite ajustar o caminho da pasta do bloco. Por padrão, esse caminho fica em blockstudio no tema ativo no momento. Como alternativa, é possível criar uma nova instância para vários diretórios de código-fonte.
add_filter('blockstudio/path', function() {
$path = get_stylesheet_directory() . '/blocks';
return $path;
});
Inicialização
global
Esta ação é disparada depois que o plugin registra todos os blocos.
add_action('blockstudio/init', function($blocks) {
// All blocks have been registered
});
instância
Esta ação é disparada depois que o plugin registra todos os blocos de uma instância específica.
O segmento $instance é o caminho da instância relativo a wp-content.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/$instance", function() {
// All blocks of this instance have been registered
});
global/before
Esta ação é disparada antes que o plugin registre todos os blocos.
add_action('blockstudio/init/before', function() {
// Before blocks are registered
});
global/before/$instance
Esta ação é disparada antes que o plugin registre todos os blocos de uma instância específica.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/before/$instance", function() {
// Before blocks of this instance are registered
});
Blocos
renderização
Este filtro permite ajustar a saída de um bloco antes que ele seja renderizado.
add_filter('blockstudio/blocks/render', function($content, $block, $attributes) {
// Modify the block content
return $content;
}, 10, 3);
metadados
Este filtro permite ajustar os dados do arquivo block.json antes de ele ser registrado.
add_filter('blockstudio/blocks/meta', function($meta, $block) {
if (str_starts_with($block['name'], 'marketing')) {
$meta['icon'] = 'megaphone';
}
return $meta;
}, 10, 2);
O código acima alteraria o ícone de todos os blocos cujo nome começa com marketing.
condições
Este filtro permite adicionar condições personalizadas que podem ser usadas em blocos. Cada tipo de condição corresponde a um valor que o editor compara com o value da condição. Consulte Condições personalizadas.
add_filter('blockstudio/blocks/conditions', function($conditions) {
$conditions['myCustomCondition'] = 'expected';
return $conditions;
});
atributos
Este filtro ajusta a definição de um campo antes que o bloco seja registrado. A definição filtrada determina o controle do editor e a validação do valor no momento da renderização. Consulte Filtragem para saber mais.
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
// Modify this field definition before registration.
return $attribute;
}, 10, 2);
attributes/render
Este filtro ajusta o valor de um campo antes de passá-lo ao template do bloco. Ele é executado uma vez por campo e recebe três argumentos: $value (o valor resolvido), $key (a chave do campo, usada em $a) e $block (o array de dados do bloco que os templates recebem como $block ou $b). Registre-o com três argumentos aceitos. Consulte Filtragem para saber mais.
add_filter('blockstudio/blocks/attributes/render', function($value, $key, $block) {
// Modify the value of one field before rendering.
return $value;
}, 10, 3);
attributes/files/sizes
Um campo files retorna cada imagem com um array sizes que contém o URL, a largura e a altura de full e de cada tamanho de imagem registrado, como $image['sizes']['thumbnail'] e $image['sizes']['thumbnail-width']. Cada tamanho gera uma chamada wp_get_attachment_image_src() por imagem, então os filtros correspondentes continuam sendo aplicados. Templates que nunca leem sizes podem descartar ou encurtar a lista.
add_filter('blockstudio/blocks/attributes/files/sizes', function($sizes, $id, $size) {
// Keep only two sizes. Return an empty array to skip them, `sizes` is then null.
return ['full', 'large'];
}, 10, 3);
$sizes é a lista de nomes de tamanhos, com full em primeiro lugar (vazia se nenhum tamanho intermediário estiver registrado). $id é o ID do anexo e $size é o tamanho solicitado para o url do valor. O filtro altera o array sizes de todo valor de arquivos na solicitação. Sem esse filtro, o array permanece inalterado.
Retorna os nomes dos tamanhos como strings. Entradas inválidas são ignoradas, e nomes duplicados são resolvidos uma única vez. Um valor de retorno que não seja um array ignora os tamanhos. As propriedades solicitadas url e outras propriedades do anexo permanecem inalteradas. Este hook não é executado para um campo de arquivos com returnFormat: "url", que não cria um mapa de tamanhos.
attributes/validate
Ajusta os resultados de chamadas explícitas de bs_validate_block(), por exemplo, quando um filtro de renderização personalizado resolve referências armazenadas. Isso não ativa a validação automática ao salvar ou renderizar.
add_filter('blockstudio/blocks/attributes/validate', function($findings, $name, $attrs) {
return $findings;
}, 10, 3);
Retorna uma lista de resultados. O filtro não é chamado quando o bloco não tem campos Blockstudio nem extensões correspondentes (null).
attributes/schema
Ajuste o Schema de JSON retornado por bs_block_schema(), por exemplo, quando um filtro de renderização personalizado resolve referências armazenadas.
add_filter('blockstudio/blocks/attributes/schema', function($schema, $name) {
return $schema;
}, 10, 2);
Retorne o array do schema. O filtro não é chamado quando o bloco não tem campos Blockstudio nem extensões correspondentes (null).
attributes/populate
Este filtro permite adicionar dados personalizados às opções de um campo checkbox, select ou radio. Consulte Preenchendo opções para saber mais.
O filtro recebe um argumento: um array com todos os conjuntos de dados personalizados, indexados pelo nome usado em "populate": {"type": "custom", "custom": "myCustomOptions"}.
add_filter('blockstudio/blocks/attributes/populate', function($options) {
$options['myCustomOptions'] = [
['value' => '1', 'label' => 'Option 1'],
['value' => '2', 'label' => 'Option 2'],
];
return $options;
});
components/use_block_props/render
Este filtro permite ajustar a saída do conteúdo useBlockProps.
Todos os filtros de componentes (use_block_props, inner_blocks e rich_text) recebem o bloco como último argumento. $block é o WP_Block_Type registrado para o bloco que está sendo renderizado, portanto $block->name é o nome do bloco, por exemplo acme/hero.
$props é uma string de atributos HTML, não um array. No frontend, é o resultado de get_block_wrapper_attributes(), por exemplo class="wp-block-acme-hero my-class". No editor, é o atributo class do elemento. Retorna uma string. No editor, somente o atributo class da string retornada é aplicado.
add_filter('blockstudio/blocks/components/use_block_props/render', function($props, $block) {
if ($block->name !== 'acme/hero') {
return $props;
}
return str_replace('class="', 'class="my-custom-class ', $props);
}, 10, 2);
components/inner_blocks/render
Este filtro permite ajustar a saída do conteúdo <InnerBlocks />.
add_filter('blockstudio/blocks/components/inner_blocks/render', function($content, $block) {
return '<div class="inner-wrapper">' . $content . '</div>';
}, 10, 2);
components/inner_blocks/frontend/wrap
Este filtro permite remover o contêiner <InnerBlocks /> do frontend.
add_filter('blockstudio/blocks/components/inner_blocks/frontend/wrap', function($wrap, $block) {
return false; // Remove wrapper
}, 10, 2);
components/rich_text/render
Este filtro permite ajustar a saída do conteúdo <RichText />. Ele recebe o valor do atributo e o bloco.
add_filter('blockstudio/blocks/components/rich_text/render', function($content, $block) {
return wp_kses_post($content);
}, 10, 2);
Tags de bloco
blockstudio/block_tags/builders
Este filtro registra criadores de arrays de blocos usados por tags de bloco e por blocos personalizados selecionados por meio de blockstudio/parser/element_mapping. Cada criador recebe atributos analisados e conteúdo interno bruto.
add_filter('blockstudio/block_tags/builders', function($builders, $parser) {
$builders['theme/paragraph'] = function(array $attributes, string $inner) {
$attributes['content'] = trim($inner);
return [
'blockName' => 'theme/paragraph',
'attrs' => [
'blockstudio' => [
'attributes' => $attributes,
],
],
'innerBlocks' => [],
'innerHTML' => '',
'innerContent' => [],
];
};
return $builders;
}, 10, 2);
Os filtros compatíveis blockstudio/block_tags/renderers e blockstudio/parser/renderers são executados após este hook e podem substituir o mesmo nome de bloco.
blockstudio/block_tags/tag_aliases
Este filtro permite registrar tags de autoria personalizadas com hífens que são resolvidas para nomes de bloco reais antes do fallback bruto de HTML. Ele é útil quando um tema quer uma superfície de tags concisa e específica do projeto, mantendo a renderização de blocos padrão de Blockstudio ou do núcleo.
add_filter('blockstudio/block_tags/tag_aliases', function($aliases) {
$aliases['theme-button'] = 'bsui/button';
$aliases['theme-card'] = 'theme/card';
return $aliases;
});
<theme-button href="/download" label="Download" />
<theme-card title="Fast authoring">
<p>Children are parsed as nested blocks.</p>
</theme-card>
blockstudio/block_tags/prefixes
Este filtro permite mapear abreviações de prefixo para um ou mais namespaces de bloco. Cada chave é um prefixo em letras minúsculas, sem hífens. Cada valor pode ser uma string de namespace ou uma lista ordenada de namespaces.
add_filter('blockstudio/block_tags/prefixes', function($prefixes) {
$prefixes['theme'] = ['theme-components', 'bsui'];
return $prefixes;
});
<theme-card title="Homepage" />
<theme-button label="Get started" />
<theme-ui-feature-matrix />
<theme-card> é resolvido para theme-components/card. <theme-button> tenta primeiro theme-components/button e, em seguida, usa bsui/button como fallback. Entradas explícitas de blockstudio/block_tags/tag_aliases têm precedência para a mesma tag, e tags com prefixo não resolvidas permanecem inalteradas.
Prefixos podem ser combinados: se uma tag com prefixo não for resolvida diretamente e seu slug também for uma tag de prefixo registrada, a resolução será recursiva. Com theme => ['theme-components'] e ui => ['bsui'], <theme-ui-input> passa para o prefixo ui e resolve bsui/input. Tags de prefixo e alias registradas também são renderizadas na saída de modelos de bloco, não apenas no conteúdo da página.
Configurações
caminho
Este filtro permite ajustar o caminho do arquivo blockstudio.json. Por padrão, ele fica em blockstudio.json dentro do tema atualmente ativo.
add_filter('blockstudio/settings/path', function() {
return get_stylesheet_directory() . '/config/blockstudio.json';
});
users/ids
Este filtro permite ativar o editor para IDs de usuário específicos.
add_filter('blockstudio/settings/users/ids', function() {
return [1];
});
users/roles
Este filtro permite ativar o editor para funções de usuário específicas.
add_filter('blockstudio/settings/users/roles', function() {
return ['administrator', 'editor'];
});
assets/enqueue
Este filtro permite ativar/desativar o enfileiramento de recursos no frontend e no editor.
add_filter('blockstudio/settings/assets/enqueue', function() {
return false;
});
assets/reset/enabled
Este filtro permite ativar/desativar a remoção dos estilos de bloco do núcleo de WordPress e a redefinição do layout de utilitários do editor.
add_filter('blockstudio/settings/assets/reset/enabled', function() {
return true;
});
assets/reset/full_width
Este filtro permite controlar quais tipos de post usam edição em largura total.
add_filter('blockstudio/settings/assets/reset/full_width', function() {
return ['page'];
});
assets/minify/css
Este filtro permite ativar/desativar a minificação de CSS.
add_filter('blockstudio/settings/assets/minify/css', function() {
return true;
});
assets/minify/js
Este filtro permite ativar/desativar a minificação de JS.
add_filter('blockstudio/settings/assets/minify/js', function() {
return true;
});
assets/process/scss
Este filtro permite ativar/desativar o processamento de SCSS em arquivos .css.
add_filter('blockstudio/settings/assets/process/scss', function() {
return true;
});
assets/process/scss_files
Este filtro permite ativar/desativar o processamento de arquivos .scss para CSS.
add_filter('blockstudio/settings/assets/process/scss_files', function() {
return true;
});
assets/output
Este filtro permite controlar onde os recursos de bloco compilados são gravados.
add_filter('blockstudio/settings/assets/output', function() {
return 'cache';
});
assets/inline_limit
Este filtro permite controlar quantos bytes de CSS de blocos externos são incorporados por página.
add_filter('blockstudio/settings/assets/inline_limit', function() {
return 40000;
});
cache/enabled
Este filtro permite ativar/desativar todos os caches de recursos do editor e do runtime baseados em arquivos de Blockstudio.
add_filter('blockstudio/settings/cache/enabled', function() {
return false;
});
cache/path
Este filtro permite alterar o diretório de cache baseado em arquivos de Blockstudio.
add_filter('blockstudio/settings/cache/path', function() {
return 'cache/blockstudio';
});
cache/namespace_grace
Este filtro permite alterar por quanto tempo um namespace de cache desativado é mantido antes de ser coletado.
add_filter('blockstudio/settings/cache/namespace_grace', function() {
return 777600;
});
githooks/commit
Este filtro informa se o hook de commit de PHPStan, pertencente a Blockstudio, está ativado.
add_filter('blockstudio/settings/githooks/commit', function() {
return true;
});
content/enabled
Este filtro permite ativar/desativar a sincronização de conteúdo.
add_filter('blockstudio/settings/content/enabled', function() {
return true;
});
content/id
Este filtro permite definir o namespace de propriedade da sincronização de conteúdo.
add_filter('blockstudio/settings/content/id', function() {
return 'docs';
});
content/path
Este filtro permite definir o diretório de arquivos da sincronização de conteúdo.
add_filter('blockstudio/settings/content/path', function() {
return 'content';
});
content/include_page_sync_managed
Este filtro permite incluir ou excluir posts gerenciados pela sincronização de páginas.
add_filter('blockstudio/settings/content/include_page_sync_managed', function() {
return false;
});
content/authors
Este filtro permite configurar o tratamento de autores da sincronização de conteúdo.
add_filter('blockstudio/settings/content/authors', function() {
return 'ignore';
});
content/post_types
Este filtro permite configurar as listas de permissões de tipos de post da sincronização de conteúdo.
add_filter('blockstudio/settings/content/post_types', function() {
return ['team_member'];
});
content/taxonomies
Este filtro permite configurar as listas de permissões de taxonomias da sincronização de conteúdo.
add_filter('blockstudio/settings/content/taxonomies', function() {
return ['category', 'post_tag'];
});
content/media
Este filtro permite configurar o tratamento de mídia da sincronização de conteúdo.
add_filter('blockstudio/settings/content/media', function() {
return 'manifest';
});
tailwind/enabled
Este filtro permite ativar/desativar Tailwind.
add_filter('blockstudio/settings/tailwind/enabled', function() {
return true;
});
tailwind/config
Este filtro permite adicionar uma configuração personalizada de Tailwind CSS.
add_filter('blockstudio/settings/tailwind/config', function() {
return '@theme { --color-primary: pink; }';
});
tailwind/output
Este filtro permite escolher uma saída Tailwind CSS embutida ou vinculada.
add_filter('blockstudio/settings/tailwind/output', function() {
return 'link';
});
ui/enabled
Este filtro permite ativar/desativar componentes agrupados de UI.
add_filter('blockstudio/settings/ui/enabled', function() {
return true;
});
editor/format_on_save
Este filtro permite ativar/desativar a formatação do código ao salvar.
add_filter('blockstudio/settings/editor/format_on_save', function() {
return true;
});
editor/assets
Este filtro permite enfileirar recursos adicionais no editor.
add_filter('blockstudio/settings/editor/assets', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
editor/markup
Este filtro permite adicionar marcação adicional ao final do editor.
add_filter('blockstudio/settings/editor/markup', function() {
return '<style>body { background: black; }</style>';
});
block_editor/disable_loading
Este filtro permite desativar o carregamento de blocos no Editor de Blocos.
add_filter('blockstudio/settings/block_editor/disable_loading', function() {
return true;
});
block_editor/enhance
Este filtro permite ativar recursos de edição de Blockstudio, como estilos de foco mais limpos e contornos ao passar o mouse ou selecionar.
add_filter('blockstudio/settings/block_editor/enhance', function() {
return true;
});
block_editor/css_classes
Este filtro permite adicionar folhas de estilo cujas classes devem estar disponíveis para seleção no campo de classes.
add_filter('blockstudio/settings/block_editor/css_classes', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/css_variables
Este filtro permite adicionar folhas de estilo cujas variáveis CSS devem estar disponíveis para preenchimento automático no campo de código.
add_filter('blockstudio/settings/block_editor/css_variables', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/blocks/allow
Este filtro permite controlar os nomes de bloco permitidos no inseridor.
add_filter('blockstudio/settings/block_editor/blocks/allow', function() {
return ['core/*', 'acf/*', 'my-theme/*'];
});
block_editor/blocks/deny
Este filtro permite remover nomes de bloco do inseridor.
add_filter('blockstudio/settings/block_editor/blocks/deny', function() {
return ['core/embed', 'core/freeform'];
});
block_editor/blocks/directory
Este filtro permite ativar ou desativar os recursos de diretório de blocos de WordPress no editor.
add_filter('blockstudio/settings/block_editor/blocks/directory', function() {
return false;
});
block_editor/blocks/categories/allow
Este filtro permite controlar quais slugs de categoria de bloco permanecem disponíveis.
add_filter('blockstudio/settings/block_editor/blocks/categories/allow', function() {
return ['text', 'media', 'design'];
});
block_editor/blocks/categories/deny
Este filtro permite remover slugs de categoria de bloco do inseridor.
add_filter('blockstudio/settings/block_editor/blocks/categories/deny', function() {
return ['embed'];
});
block_editor/blocks/categories/rename
Este filtro permite renomear rótulos de categoria de bloco por slug.
add_filter('blockstudio/settings/block_editor/blocks/categories/rename', function() {
return [
'text' => 'Writing',
'design' => 'Layout'
];
});
block_editor/blocks/categories/order
Este filtro permite ordenar slugs de categoria de bloco no inseridor.
add_filter('blockstudio/settings/block_editor/blocks/categories/order', function() {
return ['my-theme', 'text', 'media'];
});
block_editor/blocks/styles/deny
Este filtro permite cancelar o registro de estilos de bloco registrados por PHP, por nome de bloco.
add_filter('blockstudio/settings/block_editor/blocks/styles/deny', function() {
return [
'my-theme/card' => ['outline'],
'my-theme/media' => ['framed']
];
});
block_editor/blocks/legacy_widgets/hide
Este filtro permite ocultar widgets legados adicionais do bloco de widgets legados.
add_filter('blockstudio/settings/block_editor/blocks/legacy_widgets/hide', function() {
return ['archives', 'calendar'];
});
block_editor/patterns/core
Este filtro permite ativar ou desativar padrões de bloco do núcleo de WordPress.
add_filter('blockstudio/settings/block_editor/patterns/core', function() {
return false;
});
block_editor/patterns/remote
Este filtro permite ativar ou desativar padrões remotos do diretório de padrões de WordPress.
add_filter('blockstudio/settings/block_editor/patterns/remote', function() {
return false;
});
block_editor/patterns/theme
Este filtro permite ativar ou desativar padrões de bloco fornecidos pelo tema.
add_filter('blockstudio/settings/block_editor/patterns/theme', function() {
return false;
});
block_editor/patterns/blockstudio
Este filtro permite ativar ou desativar padrões baseados em arquivos de Blockstudio.
add_filter('blockstudio/settings/block_editor/patterns/blockstudio', function() {
return false;
});
block_editor/patterns/categories/allow
Este filtro permite controlar quais slugs de categoria de padrão permanecem disponíveis.
add_filter('blockstudio/settings/block_editor/patterns/categories/allow', function() {
return ['featured', 'buttons', 'columns'];
});
block_editor/patterns/categories/deny
Este filtro permite remover slugs de categoria de padrão do inseridor de padrões.
add_filter('blockstudio/settings/block_editor/patterns/categories/deny', function() {
return ['gallery'];
});
block_editor/patterns/categories/rename
Este filtro permite renomear rótulos de categoria de padrão por slug.
add_filter('blockstudio/settings/block_editor/patterns/categories/rename', function() {
return [
'featured' => 'Featured Layouts'
];
});
block_editor/patterns/categories/order
Este filtro permite ordenar slugs de categoria de padrão no inseridor.
add_filter('blockstudio/settings/block_editor/patterns/categories/order', function() {
return ['featured', 'buttons'];
});
block_editor/media/openverse
Este filtro permite ativar ou desativar a categoria de mídia Openverse no inseridor de mídia do editor de blocos.
add_filter('blockstudio/settings/block_editor/media/openverse', function() {
return false;
});
block_editor/media/image_sizes/allow
Este filtro permite controlar quais nomes de tamanhos de imagem permanecem disponíveis nos controles de mídia do editor.
add_filter('blockstudio/settings/block_editor/media/image_sizes/allow', function() {
return ['thumbnail', 'large'];
});
block_editor/media/image_sizes/deny
Este filtro permite remover nomes de tamanhos de imagem dos controles de mídia do editor.
add_filter('blockstudio/settings/block_editor/media/image_sizes/deny', function() {
return ['medium_large'];
});
ai/enable_context_generation
Este filtro permite ativar ou desativar a geração de arquivos de contexto para integração com ferramentas de LLM. Quando ativado, o arquivo de contexto reúne dados atualizados de blocos, configurações de Blockstudio da instalação atual, todos os esquemas relevantes e a documentação de Blockstudio em uma única fonte para uso com ferramentas de desenvolvimento de IA.
add_filter('blockstudio/settings/ai/enable_context_generation', function() {
return true;
});
block_tags/enabled
Este filtro permite ativar/desativar a renderização de tags de bloco no nível da página.
add_filter('blockstudio/settings/block_tags/enabled', function() {
return true;
});
block_tags/prefixes
Este filtro permite registrar abreviações de prefixo para namespace em tags de bloco.
add_filter('blockstudio/settings/block_tags/prefixes', function() {
return [
'theme' => ['theme-components', 'bsui']
];
});
dev/grab/enabled
Este filtro permite ativar/desativar o capturador de elementos.
add_filter('blockstudio/settings/dev/grab/enabled', function() {
return false;
});
dev/perf
Este filtro permite ativar/desativar o perfilador de desempenho.
add_filter('blockstudio/settings/dev/perf', function() {
return false;
});
dev/canvas/enabled
Este filtro permite ativar/desativar a tela.
add_filter('blockstudio/settings/dev/canvas/enabled', function() {
return false;
});
dev/canvas/admin_bar
Este filtro permite mostrar/ocultar a barra de administração de WordPress na tela.
add_filter('blockstudio/settings/dev/canvas/admin_bar', function() {
return true;
});
WPML
blockstudio/wpml/config/label
Filtra o rótulo de cada chave que wp bs wpml config grava. Consulte Alterar os rótulos para ver o array de contexto.
add_filter('blockstudio/wpml/config/label', function($label, $context) {
return str_replace(' (optional)', '', $label);
}, 10, 2);
Tela
blockstudio/canvas/inventory
Este filtro ajusta o inventário que a Canvas relata para uma seleção. O callback recebe o DTO do inventário, a seleção original e as opções com as quais foi chamado.
add_filter('blockstudio/canvas/inventory', function(array $result, array $selection, array $options) {
return $result;
}, 10, 3);
blockstudio/canvas/documents
Este filtro ajusta os documentos renderizados que Canvas retorna, com os mesmos três argumentos do filtro de inventário.
blockstudio/canvas/item_loaded
Esta ação é executada uma vez por registro de inventário durante o carregamento e recebe o tipo de inventário, o ID canônico do registro e o registro normalizado.
blockstudio/canvas/source_compiled
Esta ação é executada depois que um arquivo de origem é compilado para Canvas e recebe o caminho da origem selecionada e o registro canônico da origem.
UI agrupados
blockstudio/ui/directories
Este filtro ajusta os diretórios verificados em busca de componentes agrupados de UI.
blockstudio/ui/inventory
Este filtro ajusta o inventário público da família UI.
blockstudio/ui/examples
Este filtro ajusta os registros de exemplo de UI e recebe os exemplos e o inventário público de UI dos quais foram derivados.
Topologia
blockstudio/blocks/topology_refreshed
Esta ação é executada depois que a topologia de blocos é reconstruída.
blockstudio/pages/topology_refreshed
Esta ação é executada depois que a topologia da página é reconstruída.
blockstudio/pages/layout_error
Esta ação é executada quando o layout de uma página falha ao ser renderizado, em vez de falhar silenciosamente.
Runtime
blockstudio/runtime/initialized
Esta ação é executada quando o runtime resolve sua configuração.
blockstudio/runtime/changed
Esta ação é executada quando a identidade resolvida do runtime muda, o que altera os namespaces de cache e o estado de pré-renderização estática.
blockstudio/performance/default_config
Este filtro ajusta os padrões de desempenho antes que os valores próprios de blockstudio.json do projeto sejam aplicados sobre eles.
Conteúdo
blockstudio/content/orphan_action
Este filtro determina o que a sincronização de conteúdo faz com um registro que não tem mais uma origem.
Bootstrap
blockstudio/url
Este filtro altera o URL público usado para os recursos do editor e da administração de Blockstudio. As integrações de Composer precisam registrá-lo antes de carregar o arquivo de carregamento automático de Blockstudio. O segundo argumento é o diretório físico do pacote.
add_filter(
'blockstudio/url',
function(string $url, string $directory) {
return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
},
10,
2
);
Cache do runtime
blockstudio/cache/dir
Este filtro recebe o diretório base de cache resolvido antes de ser acrescentado a um escopo de cache de runtime, recursos do editor ou outro tipo.
add_filter('blockstudio/cache/dir', function(string $directory) {
return WP_CONTENT_DIR . '/cache/blockstudio';
});
blockstudio/cache/context
Este filtro adiciona uma variante de runtime serializável às identidades de cache. Use-o quando a mesma origem de descoberta puder selecionar inventários lógicos diferentes.
add_filter('blockstudio/cache/context', function($context, string $scope) {
return [
'preview' => get_query_var('preview_id'),
'site' => get_current_blog_id(),
];
}, 10, 2);
blockstudio/cache/site_key
Este filtro altera a identidade do diretório de rede/blog para hosts com seu próprio limite de locatário. O valor retornado é sanitizado antes do uso.
add_filter(
'blockstudio/cache/site_key',
function(string $key, int $networkId, int $blogId) {
return sprintf('tenant-%d-%d', $networkId, $blogId);
},
10,
3
);
blockstudio/runtime/identity
Este filtro adiciona fatos do host que afetam todos os objetos em um escopo de runtime. Em vez disso, as impressões digitais de origem específicas de um item devem ser passadas como dependências explícitas pelo API responsável.
add_filter(
'blockstudio/runtime/identity',
function(array $identity, string $scope) {
$identity['deployment'] = getenv('RELEASE_SHA') ?: 'local';
return $identity;
},
10,
2
);
blockstudio/cache/watch_debounce
Filtra o número de segundos durante os quais um instantâneo validado de observação de arquivos pode ser reutilizado sem outra verificação do sistema de arquivos. O padrão é 0 em ambientes locais e de desenvolvimento e 20 nos demais.
add_filter('blockstudio/cache/watch_debounce', function() {
return 30;
});
blockstudio/cache/build_wait_budget
Filtra por quanto tempo, em milissegundos, uma solicitação espera que um processo de criação concorrente publique o cache do runtime ou uma atualização de opções preenchidas antes de continuar sem ele. O padrão é 5000 para reconstruções estruturais e 4000 para atualizações de opções.
add_filter('blockstudio/cache/build_wait_budget', function() {
return 2000;
});
blockstudio/cache/populate_debounce
Filtra quantos segundos um conjunto de gravações de conteúdo, termos, usuários ou metadados é agrupado em uma única atualização de opções preenchidas. A primeira gravação após um período de inatividade atualiza imediatamente; a última gravação de um conjunto é refletida assim que o intervalo termina. O padrão é 30. Retorne 0 para atualizar a cada gravação.
add_filter('blockstudio/cache/populate_debounce', function() {
return 120;
});
blockstudio/cache/populate_ignored_meta_keys
Filtra as chaves de metadados cujas gravações nunca atualizam as opções preenchidas. Por padrão, são as chaves que WordPress grava para controle de edição e login: _edit_lock, atualizada pelo editor e pelo Heartbeat enquanto uma publicação está aberta, _edit_last, gravada junto com o salvamento de uma publicação que já atualiza as opções, e session_tokens, gravada no login e no logout. Adicione chaves que mudam com frequência, mas nunca afetam uma consulta de preenchimento.
add_filter('blockstudio/cache/populate_ignored_meta_keys', function(array $keys) {
$keys[] = '_my_view_counter';
return $keys;
});
blockstudio/cache/max_files_per_scope
Filtra quantos payloads publicados cada escopo de cache do runtime mantém.
add_filter('blockstudio/cache/max_files_per_scope', function($maximum, $scope) {
return $scope === 'runtime' ? 50 : $maximum;
}, 10, 2);
blockstudio/cache/compress
Filtra se uma carga útil de cache usa dados serializados compactados em vez de um array PHP simples. Por padrão, somente cargas úteis de até 1 MiB usam o formato simples, e apenas quando a memória compartilhada do OPcache ativo pode armazenar em cache o destino. Outros processos, arquivos excluídos e cargas úteis maiores usam compactação.
add_filter('blockstudio/cache/compress', function($compress, $scope) {
return $scope === 'runtime' ? false : $compress;
}, 10, 2);
Retornar false também ignora o limite de tamanho. Isso pode ajudar quando WP-CLI sem opcache.enable_cli prepara arquivos para processos web com OPcache, mas todo leitor sem OPcache analisará o array gerado. Mantenha a compactação para cargas úteis compartilhadas grandes, a menos que esse custo extra de memória seja aceitável. Consulte formatos de carga útil do cache para ver as proteções padrão.
blockstudio/cache/protected_paths
A poda de retenção nunca deve remover caminhos de cache. Blockstudio inicializa a lista com todos os arquivos referenciados pelo mapa instalado de disponibilização antecipada.
add_filter('blockstudio/cache/protected_paths', function(array $paths, string $scope, string $directory) {
if ('static-prerender' === $scope) {
$paths[] = $directory . '/pinned.html';
}
return $paths;
}, 10, 3);
blockstudio/cache/outcome
Esta ação informa um escopo de cache compartilhado e um resultado, como hit, build, miss-stale, stale-last-good ou write-failure.
add_action('blockstudio/cache/outcome', function(string $scope, string $reason) {
my_metrics()->increment("blockstudio.cache.{$scope}.{$reason}");
}, 10, 2);
blockstudio/static_prerender/request_bypass
Este filtro recebe a decisão final de segurança anônima, além de entradas do servidor e de cookies. Retornar true sempre ignora a disponibilização estática e a geração.
add_filter(
'blockstudio/static_prerender/request_bypass',
function(bool $bypass, array $server, array $cookies) {
return $bypass || isset($cookies['commerce_session']);
},
10,
3
);
blockstudio/static_prerender/public_urls
Este filtro fornece ou ajusta o inventário público completo de URL usado pelo processo de aquecimento agendado e pelas ferramentas explícitas de grafo.
add_filter('blockstudio/static_prerender/public_urls', function(array $urls) {
$urls[] = home_url('/custom-route/');
return array_values(array_unique($urls));
});
O que o filtro retorna não é o inventário final. O resultado passa por uma etapa de verificação de capacidade de cache que descarta tudo o que corresponde a um caminho dinâmico configurado e tudo o que é ignorado por padrão: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, qualquer caminho que contenha /feed/ e resultados de pesquisa abaixo do caminho base de pesquisa no caminho inicial do site (/search/ por padrão). Portanto, um URL adicionado pode ser descartado sem aviso. Se uma rota esperada estiver ausente do inventário gerado, verifique-a segundo essas regras antes de concluir que o filtro não foi executado.
blockstudio/static_prerender/render_internal
Este filtro implementa o transporte em lote opcional no mesmo processo. Retorne um array de resultados normalizado ou deixe o valor inalterado para que o renderizador use o fallback HTTP configurado. O resultado contém html e, opcionalmente, status, dependencies, virtualHashes e headers; os cabeçalhos indicados em performance.staticPrerender.replayHeaders são armazenados com o documento.
add_filter(
'blockstudio/static_prerender/render_internal',
function($result, string $url, array $options) {
return my_static_renderer()->render($url, $options);
},
10,
3
);
blockstudio/static_prerender/cacheable_html
Este filtro toma a decisão final depois que Blockstudio verifica se a saída é um documento HTML completo, sem o marcador de não armazenar em cache, e se o status de resposta observado indica sucesso. O terceiro argumento é o status observado ou null quando nenhum status foi declarado.
add_filter('blockstudio/static_prerender/cacheable_html', function(bool $cacheable, string $html, ?int $status) {
return $cacheable && !str_contains($html, 'data-personalized');
}, 10, 3);
blockstudio/static_prerender/outcome
Esta ação informa resultados de pré-renderização estática, incluindo acertos, falhas, gravações, gravações de grafo, entradas obsoletas e erros.
add_action('blockstudio/static_prerender/outcome', function(string $reason) {
my_metrics()->increment("blockstudio.prerender.{$reason}");
});
blockstudio/tailwind/cache_max_files
Filtra o número máximo de entradas compiladas de Tailwind CSS. O padrão é 1000.
add_filter('blockstudio/tailwind/cache_max_files', function() {
return 1500;
});
blockstudio/tailwind/cache_max_age
Filtra a idade máxima, em segundos, das entradas compiladas de Tailwind CSS. O padrão é 30 dias e o mínimo é uma hora.
add_filter('blockstudio/tailwind/cache_max_age', function() {
return 14 * DAY_IN_SECONDS;
});
Administração
ativado
Este filtro permite ativar ou desativar a página de administração de Blockstudio em Ferramentas > Blockstudio.
add_filter('blockstudio/admin/enabled', function() {
return false;
});
Recursos
editor/canvas/body_class
Quando a redefinição de recursos está ativada, este filtro ajusta as classes sanitizadas do corpo do frontend copiadas para a tela do editor de blocos.
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
return array_values(array_diff($classes, ['logged-in']));
});
ativar
Este filtro permite desativar o processamento e o enfileiramento de recursos de um tipo específico.
add_filter('blockstudio/assets/enable', function($enable, $type, $block) {
if ($type === 'css' && $block['name'] === 'my/block') {
return false;
}
return $enable;
}, 10, 3);
desativar
Este filtro permite desativar recursos por ID. Os recursos que correspondem a um ID da matriz retornada não serão renderizados no frontend.
add_filter('blockstudio/assets/disable', function($disabled) {
$disabled[] = 'my-block-style';
return $disabled;
});
process/scss/import_paths
Este filtro permite adicionar caminhos adicionais à declaração @import do compilador de SCSS.
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
$paths[] = get_stylesheet_directory() . '/scss';
return $paths;
});
process/scss/prelude
Este filtro permite inserir código compartilhado de Sass antes da compilação de cada arquivo SCSS.
add_filter('blockstudio/assets/process/scss/prelude', function($prelude, $path, $scss) {
return '@import "functions";' . "\n"
. '@import "variables";' . "\n"
. '@import "mixins";';
}, 10, 3);
process/css/content
Este filtro permite ajustar o conteúdo do arquivo CSS antes de ele ser compilado.
add_filter('blockstudio/assets/process/css/content', function($content, $block) {
return str_replace('old-class', 'new-class', $content);
}, 10, 2);
process/js/content
Este filtro permite ajustar o conteúdo do arquivo JS antes de ele ser compilado.
add_filter('blockstudio/assets/process/js/content', function($content, $block) {
return $content;
}, 10, 2);
Buffer
ativado
Blockstudio armazena em buffer a resposta do frontend para que as tags de estilo e script de bloco renderizadas dentro do corpo possam ser movidas para o cabeçalho e o rodapé e para que Tailwind possa analisar o documento completo. O armazenamento em buffer significa manter e analisar o documento inteiro em cada solicitação do frontend; um site que não renderiza recursos de bloco de Blockstudio e não usa Tailwind pode retornar false para ignorar ambos.
add_filter('blockstudio/buffer/enabled', '__return_false');
O buffer também fica desativado no painel de administração e na prévia do Personalizador. Chame bs_is_buffering() a partir de wp_enqueue_scripts ou posterior para saber se a resposta atual está em buffer. Ela retorna false antes de a decisão ser tomada em template_redirect.
saída
Este filtro recebe o documento completo em buffer de HTML antes de ser enviado. A movimentação de recursos de Blockstudio é executada na prioridade 1000000 e a compilação de Tailwind, na prioridade 999999; portanto, execute antes para ver o documento antes dessas etapas ou depois para ver a saída final.
add_filter('blockstudio/buffer/output', function(string $html) {
return $html;
}, 2000000);
Renderização
dependências
Este filtro informa o modelo selecionado e as dependências de recursos sempre que Blockstudio renderiza um bloco. Ele é útil para exportadores estáticos e outros coletores de dependências no mesmo processo.
add_filter(
'blockstudio/render/dependencies',
function($paths, $name, $block, $isEditor, $isPreview) {
my_dependency_graph()->add($name, $paths);
return $paths;
},
10,
5
);
global
Este filtro permite ajustar a saída da página antes de ela ser renderizada.
add_filter('blockstudio/render', function($content) {
return $content;
});
cabeçalho
Este filtro permite ajustar a saída da tag <head> antes de ela ser renderizada. Ele é executado somente quando Blockstudio coloca a resposta em buffer; consulte bs_is_buffering().
add_filter('blockstudio/render/head', function($content) {
return $content . '<meta name="custom" content="value">';
});
rodapé
Este filtro permite ajustar a saída de </body> antes de ela ser renderizada.
add_filter('blockstudio/render/footer', function($content) {
return $content . '<script>console.log("loaded")</script>';
});
Tratamento de erros
error/logged
Ação executada após o registro de um erro. Use-a para enviar erros a serviços externos de registro.
add_action('blockstudio/error/logged', function($message, $level, $context) {
if ($level === 'error') {
my_external_logger($message, $context);
}
}, 10, 3);
error/exception
Ação executada após o tratamento de uma exceção.
add_action('blockstudio/error/exception', function($exception, $context) {
my_error_tracker($exception);
}, 10, 2);
Banco de dados
Todos os hooks de banco de dados recebem uma única matriz $params.
db/before_create
Ação executada antes da criação de um registro.
add_action('blockstudio/db/before_create', function($params) {
// $params: block, schema, data, storage
});
db/after_create
Ação executada após a criação de um registro.
add_action('blockstudio/db/after_create', function($params) {
// $params: block, schema, record, storage
wp_mail($params['record']['email'], 'Welcome!', 'Thanks for subscribing.');
});
db/before_update
Ação executada antes da atualização de um registro.
add_action('blockstudio/db/before_update', function($params) {
// $params: block, schema, id, data, storage
});
db/after_update
Ação executada após a atualização de um registro.
add_action('blockstudio/db/after_update', function($params) {
// $params: block, schema, id, record, storage
});
db/before_delete
Ação executada antes da exclusão de um registro.
add_action('blockstudio/db/before_delete', function($params) {
// $params: block, schema, id, storage
});
db/after_delete
Ação executada após a exclusão de um registro.
add_action('blockstudio/db/after_delete', function($params) {
// $params: block, schema, id, storage
});
RPC
Todos os hooks de RPC recebem uma única matriz $params.
rpc/before_call
Ação executada antes da chamada de uma função RPC.
add_action('blockstudio/rpc/before_call', function($params) {
// $params: block, function, params
});
rpc/after_call
Ação executada após a chamada de uma função RPC.
add_action('blockstudio/rpc/after_call', function($params) {
// $params: block, function, params, result
});