Saltar al contenido

Hooks de PHP

A continuación encontrarás una lista de todos los hooks de PHP disponibles para ampliar o ajustar la funcionalidad del plugin.

Ruta

Este filtro permite ajustar la ruta de la carpeta de bloques. De forma predeterminada, se encuentra en blockstudio dentro del tema activo. También es posible crear una instancia nueva para varios directorios de código fuente.

PHP
add_filter('blockstudio/path', function() {
  $path = get_stylesheet_directory() . '/blocks';
  return $path;
});

Inicialización

global

Esta acción se ejecuta después de que el plugin haya registrado todos los bloques.

PHP
add_action('blockstudio/init', function($blocks) {
  // All blocks have been registered
});

instancia

Esta acción se ejecuta después de que el plugin haya registrado todos los bloques de una instancia específica. El segmento $instance es la ruta de la instancia relativa a wp-content.

PHP
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/$instance", function() {
  // All blocks of this instance have been registered
});

global/before

Esta acción se ejecuta antes de que el plugin haya registrado todos los bloques.

PHP
add_action('blockstudio/init/before', function() {
  // Before blocks are registered
});

global/before/$instance

Esta acción se ejecuta antes de que el plugin haya registrado todos los bloques de una instancia específica.

PHP
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/before/$instance", function() {
  // Before blocks of this instance are registered
});

Bloques

render

Este filtro permite ajustar la salida de un bloque antes de que se represente.

PHP
add_filter('blockstudio/blocks/render', function($content, $block, $attributes) {
  // Modify the block content
  return $content;
}, 10, 3);

meta

Este filtro permite ajustar los datos del archivo block.json antes de registrarlo.

PHP
add_filter('blockstudio/blocks/meta', function($meta, $block) {
  if (str_starts_with($block['name'], 'marketing')) {
    $meta['icon'] = 'megaphone';
  }
  return $meta;
}, 10, 2);

El código anterior cambiaría el icono de todos los bloques cuyo nombre empieza por marketing.

conditions

Este filtro permite añadir condiciones personalizadas que pueden usarse en los bloques. Cada tipo de condición se asigna a un valor que el editor compara con el value de la condición. Consulta Condiciones personalizadas.

PHP
add_filter('blockstudio/blocks/conditions', function($conditions) {
  $conditions['myCustomCondition'] = 'expected';
  return $conditions;
});

attributes

Este filtro ajusta la definición de un campo antes de registrar el bloque. La definición filtrada determina el control del editor y la validación del valor al representar el bloque. Consulta Filtrado para obtener más información.

PHP
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
  // Modify this field definition before registration.
  return $attribute;
}, 10, 2);

attributes/render

Este filtro ajusta el valor de un campo antes de pasarlo a la plantilla del bloque. Se ejecuta una vez por campo y recibe tres argumentos: $value (el valor resuelto), $key (la clave del campo, tal como se usa en $a) y $block (la matriz de datos del bloque que las plantillas reciben como $block o $b). Regístralo con tres argumentos aceptados. Consulta Filtrado para obtener más información.

PHP
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

Un campo files devuelve cada imagen con una matriz sizes que contiene URL, el ancho y el alto de full y de cada tamaño de imagen registrado, como $image['sizes']['thumbnail'] y $image['sizes']['thumbnail-width']. Cada tamaño supone una llamada wp_get_attachment_image_src() por imagen, por lo que sus filtros siguen aplicándose. Las plantillas que nunca leen sizes pueden eliminar o acortar la lista.

PHP
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 es la lista de nombres de tamaño, con full en primer lugar (vacía si no hay tamaños intermedios registrados). $id es el ID del adjunto y $size, el tamaño solicitado para url del valor. El filtro modifica la matriz sizes de todos los valores de tipo archivo de la solicitud. Sin él, la matriz no cambia.

Devuelve los nombres de tamaño como cadenas. Se ignoran las entradas no válidas y los nombres duplicados se resuelven una sola vez. Si el valor devuelto no es un array, se omiten los tamaños. url y las demás propiedades del adjunto no cambian. Este hook no se ejecuta para un campo de archivos con returnFormat: "url", que no crea un mapa de tamaños.

attributes/validate

Ajusta los resultados de las llamadas explícitas a bs_validate_block(), por ejemplo, cuando un filtro de renderizado personalizado resuelve referencias almacenadas. Esto no habilita la validación automática al guardar o renderizar.

PHP
add_filter('blockstudio/blocks/attributes/validate', function($findings, $name, $attrs) {
  return $findings;
}, 10, 3);

Devuelve una lista de resultados. El filtro no se llama cuando el bloque no tiene campos Blockstudio ni extensiones coincidentes (null).

attributes/schema

Ajuste el esquema JSON devuelto por bs_block_schema(), por ejemplo, cuando un filtro de renderizado personalizado resuelve referencias almacenadas.

PHP
add_filter('blockstudio/blocks/attributes/schema', function($schema, $name) {
  return $schema;
}, 10, 2);

Devuelva la matriz del esquema. El filtro no se llama si el bloque no tiene campos Blockstudio ni extensiones coincidentes (null).

attributes/populate

Este filtro permite añadir datos personalizados a las opciones de un campo checkbox, select o radio. Consulta Cómo rellenar opciones para obtener más información.

El filtro recibe un argumento: un array con todos los conjuntos de datos personalizados, cuyas claves son los nombres que se usan en "populate": {"type": "custom", "custom": "myCustomOptions"}.

PHP
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 la salida del contenido useBlockProps.

Todos los filtros de componentes (use_block_props, inner_blocks y rich_text) reciben el bloque como último argumento. $block es el WP_Block_Type registrado para el bloque que se está renderizando, así que $block->name es el nombre del bloque, por ejemplo acme/hero.

$props es una cadena de atributos HTML, no un array. En el frontend es el resultado de get_block_wrapper_attributes(), por ejemplo class="wp-block-acme-hero my-class". En el editor es el atributo class del elemento. Devuelve una cadena. En el editor solo se aplica el atributo class de la cadena devuelta.

PHP
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 la salida del contenido <InnerBlocks />.

PHP
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 quitar el contenedor <InnerBlocks /> del frontend.

PHP
add_filter('blockstudio/blocks/components/inner_blocks/frontend/wrap', function($wrap, $block) {
  return false; // Remove wrapper
}, 10, 2);

components/rich_text/render

Este filtro te permite ajustar la salida del contenido <RichText />. Recibe el valor del atributo y el bloque.

PHP
add_filter('blockstudio/blocks/components/rich_text/render', function($content, $block) {
  return wp_kses_post($content);
}, 10, 2);

Etiquetas de bloque

blockstudio/block_tags/builders

Este filtro registra constructores de matrices de bloques utilizados por las etiquetas de bloque y por bloques personalizados seleccionados mediante blockstudio/parser/element_mapping. Cada constructor recibe los atributos analizados y el contenido interno sin procesar.

PHP
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);

Los filtros compatibles blockstudio/block_tags/renderers y blockstudio/parser/renderers se ejecutan después de este hook y pueden sobrescribir el mismo nombre de bloque.

blockstudio/block_tags/tag_aliases

Este filtro permite registrar etiquetas de autoría personalizadas con guiones que se resuelven en nombres de bloque reales antes de recurrir a HTML sin procesar. Es útil cuando un tema quiere ofrecer un conjunto conciso de etiquetas específico del proyecto y, a la vez, renderizar bloques estándar Blockstudio o del núcleo.

PHP
add_filter('blockstudio/block_tags/tag_aliases', function($aliases) {
  $aliases['theme-button'] = 'bsui/button';
  $aliases['theme-card'] = 'theme/card';

  return $aliases;
});
HTML
<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 asignar abreviaturas de prefijo a uno o varios espacios de nombres de bloques. Cada clave es un prefijo en minúsculas sin guiones. Cada valor puede ser una cadena de espacio de nombres o una lista ordenada de espacios de nombres.

PHP
add_filter('blockstudio/block_tags/prefixes', function($prefixes) {
  $prefixes['theme'] = ['theme-components', 'bsui'];

  return $prefixes;
});
HTML
<theme-card title="Homepage" />
<theme-button label="Get started" />
<theme-ui-feature-matrix />

<theme-card> se resuelve como theme-components/card. <theme-button> prueba primero theme-components/button y, si no funciona, recurre a bsui/button. Las entradas explícitas de blockstudio/block_tags/tag_aliases tienen prioridad para la misma etiqueta, y las etiquetas con prefijo que no se resuelven permanecen sin cambios.

Los prefijos se combinan: si una etiqueta con prefijo no se resuelve directamente y su slug también es una etiqueta de prefijo registrada, la resolución continúa de forma recursiva. Con theme => ['theme-components'] y ui => ['bsui'], <theme-ui-input> recurre al prefijo ui y resuelve bsui/input. Las etiquetas de prefijo y alias registradas también se renderizan en la salida de las plantillas de bloques, no solo en el contenido de las páginas.

Ajustes

ruta

Este filtro permite ajustar la ruta del archivo blockstudio.json. De forma predeterminada, se encuentra en blockstudio.json dentro del tema activo.

PHP
add_filter('blockstudio/settings/path', function() {
  return get_stylesheet_directory() . '/config/blockstudio.json';
});

users/ids

Este filtro permite habilitar el editor para ID de usuario específicos.

PHP
add_filter('blockstudio/settings/users/ids', function() {
  return [1];
});

users/roles

Este filtro permite habilitar el editor para roles de usuario específicos.

PHP
add_filter('blockstudio/settings/users/roles', function() {
  return ['administrator', 'editor'];
});

assets/enqueue

Este filtro permite habilitar o deshabilitar la incorporación de recursos en el frontend y el editor.

PHP
add_filter('blockstudio/settings/assets/enqueue', function() {
  return false;
});

assets/reset/enabled

Este filtro permite habilitar o deshabilitar la eliminación de los estilos de bloques del núcleo de WordPress y el restablecimiento del diseño de utilidades del editor.

PHP
add_filter('blockstudio/settings/assets/reset/enabled', function() {
  return true;
});

assets/reset/full_width

Este filtro permite controlar qué tipos de contenido usan la edición a ancho completo.

PHP
add_filter('blockstudio/settings/assets/reset/full_width', function() {
  return ['page'];
});

assets/minify/css

Este filtro permite habilitar o deshabilitar la minificación de CSS.

PHP
add_filter('blockstudio/settings/assets/minify/css', function() {
  return true;
});

assets/minify/js

Este filtro permite habilitar o deshabilitar la minificación de JS.

PHP
add_filter('blockstudio/settings/assets/minify/js', function() {
  return true;
});

assets/process/scss

Este filtro permite habilitar o deshabilitar el procesamiento de SCSS en archivos .css.

PHP
add_filter('blockstudio/settings/assets/process/scss', function() {
  return true;
});

assets/process/scss_files

Este filtro permite habilitar o deshabilitar el procesamiento de archivos .scss a CSS.

PHP
add_filter('blockstudio/settings/assets/process/scss_files', function() {
  return true;
});

assets/output

Este filtro permite controlar dónde se escriben los recursos compilados de los bloques.

PHP
add_filter('blockstudio/settings/assets/output', function() {
  return 'cache';
});

assets/inline_limit

Este filtro te permite controlar cuántos bytes de CSS de bloques externos se insertan en línea por página.

PHP
add_filter('blockstudio/settings/assets/inline_limit', function() {
  return 40000;
});

cache/enabled

Este filtro permite habilitar o deshabilitar todas las cachés de recursos del editor y del entorno de ejecución de Blockstudio basadas en archivos.

PHP
add_filter('blockstudio/settings/cache/enabled', function() {
  return false;
});

cache/path

Este filtro permite cambiar el directorio de caché de Blockstudio basado en archivos.

PHP
add_filter('blockstudio/settings/cache/path', function() {
  return 'cache/blockstudio';
});

cache/namespace_grace

Este filtro permite cambiar durante cuánto tiempo se conserva un espacio de nombres de caché retirado antes de eliminarlo.

PHP
add_filter('blockstudio/settings/cache/namespace_grace', function() {
  return 777600;
});

githooks/commit

Este filtro indica si el hook de confirmación PHPStan propiedad de Blockstudio está habilitado.

PHP
add_filter('blockstudio/settings/githooks/commit', function() {
  return true;
});

content/enabled

Este filtro permite habilitar o deshabilitar la sincronización de contenido.

PHP
add_filter('blockstudio/settings/content/enabled', function() {
  return true;
});

content/id

Este filtro permite establecer el espacio de nombres de propiedad de la sincronización de contenido.

PHP
add_filter('blockstudio/settings/content/id', function() {
  return 'docs';
});

content/path

Este filtro permite establecer el directorio de archivos de la sincronización de contenido.

PHP
add_filter('blockstudio/settings/content/path', function() {
  return 'content';
});

content/include_page_sync_managed

Este filtro permite incluir o excluir las entradas gestionadas por la sincronización de páginas.

PHP
add_filter('blockstudio/settings/content/include_page_sync_managed', function() {
  return false;
});

content/authors

Este filtro permite configurar la gestión de autores de la sincronización de contenido.

PHP
add_filter('blockstudio/settings/content/authors', function() {
  return 'ignore';
});

content/post_types

Este filtro permite configurar las listas de permitidos de tipos de contenido para la sincronización de contenido.

PHP
add_filter('blockstudio/settings/content/post_types', function() {
  return ['team_member'];
});

content/taxonomies

Este filtro permite configurar las listas de permitidos de taxonomías para la sincronización de contenido.

PHP
add_filter('blockstudio/settings/content/taxonomies', function() {
  return ['category', 'post_tag'];
});

content/media

Este filtro permite configurar la gestión de medios de la sincronización de contenido.

PHP
add_filter('blockstudio/settings/content/media', function() {
  return 'manifest';
});

tailwind/enabled

Este filtro permite habilitar o deshabilitar Tailwind.

PHP
add_filter('blockstudio/settings/tailwind/enabled', function() {
  return true;
});

tailwind/config

Este filtro permite añadir una configuración personalizada de Tailwind CSS.

PHP
add_filter('blockstudio/settings/tailwind/config', function() {
  return '@theme { --color-primary: pink; }';
});

tailwind/output

Este filtro permite elegir una salida de Tailwind CSS integrada o enlazada.

PHP
add_filter('blockstudio/settings/tailwind/output', function() {
  return 'link';
});

ui/enabled

Este filtro permite habilitar o deshabilitar los componentes de UI incluidos.

PHP
add_filter('blockstudio/settings/ui/enabled', function() {
  return true;
});

editor/format_on_save

Este filtro permite habilitar o deshabilitar el formato del código al guardar.

PHP
add_filter('blockstudio/settings/editor/format_on_save', function() {
  return true;
});

editor/assets

Este filtro permite incorporar recursos adicionales en el editor.

PHP
add_filter('blockstudio/settings/editor/assets', function() {
  return ['my-stylesheet', 'another-stylesheet'];
});

editor/markup

Este filtro permite añadir marcado adicional al final del editor.

PHP
add_filter('blockstudio/settings/editor/markup', function() {
  return '<style>body { background: black; }</style>';
});

block_editor/disable_loading

Este filtro permite deshabilitar la carga de bloques dentro del editor de bloques.

PHP
add_filter('blockstudio/settings/block_editor/disable_loading', function() {
  return true;
});

block_editor/enhance

Este filtro permite habilitar funciones del editor de Blockstudio, como estilos de foco más limpios y contornos al pasar el cursor o seleccionar.

PHP
add_filter('blockstudio/settings/block_editor/enhance', function() {
  return true;
});

block_editor/css_classes

Este filtro permite añadir hojas de estilo cuyas clases estarán disponibles para elegir en el campo de clases.

PHP
add_filter('blockstudio/settings/block_editor/css_classes', function() {
  return ['my-stylesheet', 'another-stylesheet'];
});

block_editor/css_variables

Este filtro permite añadir hojas de estilo cuyas variables de CSS estarán disponibles para autocompletarse en el campo de código.

PHP
add_filter('blockstudio/settings/block_editor/css_variables', function() {
  return ['my-stylesheet', 'another-stylesheet'];
});

block_editor/blocks/allow

Este filtro permite controlar qué nombres de bloque se admiten en el insertador.

PHP
add_filter('blockstudio/settings/block_editor/blocks/allow', function() {
  return ['core/*', 'acf/*', 'my-theme/*'];
});

block_editor/blocks/deny

Este filtro permite quitar nombres de bloque del insertador.

PHP
add_filter('blockstudio/settings/block_editor/blocks/deny', function() {
  return ['core/embed', 'core/freeform'];
});

block_editor/blocks/directory

Este filtro permite habilitar o deshabilitar los recursos del directorio de bloques de WordPress en el editor.

PHP
add_filter('blockstudio/settings/block_editor/blocks/directory', function() {
  return false;
});

block_editor/blocks/categories/allow

Este filtro permite controlar qué slugs de categorías de bloques siguen disponibles.

PHP
add_filter('blockstudio/settings/block_editor/blocks/categories/allow', function() {
  return ['text', 'media', 'design'];
});

block_editor/blocks/categories/deny

Este filtro permite quitar slugs de categorías de bloques del insertador.

PHP
add_filter('blockstudio/settings/block_editor/blocks/categories/deny', function() {
  return ['embed'];
});

block_editor/blocks/categories/rename

Este filtro permite cambiar las etiquetas de categorías de bloques según el slug.

PHP
add_filter('blockstudio/settings/block_editor/blocks/categories/rename', function() {
  return [
    'text' => 'Writing',
    'design' => 'Layout'
  ];
});

block_editor/blocks/categories/order

Este filtro permite ordenar los slugs de categorías de bloques en el insertador.

PHP
add_filter('blockstudio/settings/block_editor/blocks/categories/order', function() {
  return ['my-theme', 'text', 'media'];
});

block_editor/blocks/styles/deny

Este filtro permite cancelar el registro de estilos de bloque registrados por PHP, según el nombre del bloque.

PHP
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 heredados adicionales del bloque de widgets heredados.

PHP
add_filter('blockstudio/settings/block_editor/blocks/legacy_widgets/hide', function() {
  return ['archives', 'calendar'];
});

block_editor/patterns/core

Este filtro permite habilitar o deshabilitar los patrones de bloques del núcleo de WordPress.

PHP
add_filter('blockstudio/settings/block_editor/patterns/core', function() {
  return false;
});

block_editor/patterns/remote

Este filtro permite habilitar o deshabilitar patrones remotos del directorio de patrones de WordPress.

PHP
add_filter('blockstudio/settings/block_editor/patterns/remote', function() {
  return false;
});

block_editor/patterns/theme

Este filtro permite habilitar o deshabilitar los patrones de bloques proporcionados por el tema.

PHP
add_filter('blockstudio/settings/block_editor/patterns/theme', function() {
  return false;
});

block_editor/patterns/blockstudio

Este filtro permite habilitar o deshabilitar los patrones basados en archivos de Blockstudio.

PHP
add_filter('blockstudio/settings/block_editor/patterns/blockstudio', function() {
  return false;
});

block_editor/patterns/categories/allow

Este filtro permite controlar qué slugs de categorías de patrones siguen disponibles.

PHP
add_filter('blockstudio/settings/block_editor/patterns/categories/allow', function() {
  return ['featured', 'buttons', 'columns'];
});

block_editor/patterns/categories/deny

Este filtro permite quitar slugs de categorías de patrones del insertador de patrones.

PHP
add_filter('blockstudio/settings/block_editor/patterns/categories/deny', function() {
  return ['gallery'];
});

block_editor/patterns/categories/rename

Este filtro permite cambiar las etiquetas de categorías de patrones según el slug.

PHP
add_filter('blockstudio/settings/block_editor/patterns/categories/rename', function() {
  return [
    'featured' => 'Featured Layouts'
  ];
});

block_editor/patterns/categories/order

Este filtro permite ordenar los slugs de categorías de patrones en el insertador.

PHP
add_filter('blockstudio/settings/block_editor/patterns/categories/order', function() {
  return ['featured', 'buttons'];
});

block_editor/media/openverse

Este filtro permite habilitar o deshabilitar la categoría de medios de Openverse en el insertador de medios del editor de bloques.

PHP
add_filter('blockstudio/settings/block_editor/media/openverse', function() {
  return false;
});

block_editor/media/image_sizes/allow

Este filtro permite controlar qué nombres de tamaños de imagen siguen disponibles en los controles de medios del editor.

PHP
add_filter('blockstudio/settings/block_editor/media/image_sizes/allow', function() {
  return ['thumbnail', 'large'];
});

block_editor/media/image_sizes/deny

Este filtro permite quitar nombres de tamaños de imagen de los controles de medios del editor.

PHP
add_filter('blockstudio/settings/block_editor/media/image_sizes/deny', function() {
  return ['medium_large'];
});

ai/enable_context_generation

Este filtro permite habilitar o deshabilitar la generación de archivos de contexto para la integración con herramientas LLM. Cuando está habilitado, el archivo de contexto reúne datos de bloques actualizados, ajustes de Blockstudio de la instalación actual, todos los esquemas pertinentes y documentación de Blockstudio en una única fuente para usar con herramientas de desarrollo basadas en IA.

PHP
add_filter('blockstudio/settings/ai/enable_context_generation', function() {
  return true;
});

block_tags/enabled

Este filtro permite habilitar o deshabilitar el renderizado de etiquetas de bloque a nivel de página.

PHP
add_filter('blockstudio/settings/block_tags/enabled', function() {
  return true;
});

block_tags/prefixes

Este filtro permite registrar abreviaturas que asignan prefijos a espacios de nombres para las etiquetas de bloque.

PHP
add_filter('blockstudio/settings/block_tags/prefixes', function() {
  return [
    'theme' => ['theme-components', 'bsui']
  ];
});

dev/grab/enabled

Este filtro permite habilitar o deshabilitar el capturador de elementos.

PHP
add_filter('blockstudio/settings/dev/grab/enabled', function() {
  return false;
});

dev/perf

Este filtro permite habilitar o deshabilitar el perfilador de rendimiento.

PHP
add_filter('blockstudio/settings/dev/perf', function() {
  return false;
});

dev/canvas/enabled

Este filtro permite habilitar o deshabilitar el lienzo.

PHP
add_filter('blockstudio/settings/dev/canvas/enabled', function() {
  return false;
});

dev/canvas/admin_bar

Este filtro permite mostrar u ocultar la barra de administración de WordPress en el lienzo.

PHP
add_filter('blockstudio/settings/dev/canvas/admin_bar', function() {
  return true;
});

WPML

blockstudio/wpml/config/label

Filtra la etiqueta de cada clave que escribe wp bs wpml config. Consulta Cambiar las etiquetas para ver el array de contexto.

PHP
add_filter('blockstudio/wpml/config/label', function($label, $context) {
  return str_replace(' (optional)', '', $label);
}, 10, 2);

Lienzo

blockstudio/canvas/inventory

Este filtro ajusta el inventario que el lienzo informa para una selección. La función de retorno recibe el objeto de transferencia de datos del inventario, la selección original y las opciones con las que se llamó.

PHP
add_filter('blockstudio/canvas/inventory', function(array $result, array $selection, array $options) {
  return $result;
}, 10, 3);

blockstudio/canvas/documents

Este filtro ajusta los documentos renderizados que devuelve el lienzo, con los mismos tres argumentos que el filtro de inventario.

blockstudio/canvas/item_loaded

Esta acción se activa una vez por cada registro de inventario al cargarse y recibe el tipo de inventario, el ID canónico del registro y el registro normalizado.

blockstudio/canvas/source_compiled

Esta acción se activa tras compilar un archivo fuente para el lienzo y recibe la ruta de origen seleccionada y el registro de origen canónico.

UI incluido

blockstudio/ui/directories

Este filtro ajusta los directorios que se analizan en busca de componentes de UI incluidos.

blockstudio/ui/inventory

Este filtro ajusta el inventario público de familias de UI.

blockstudio/ui/examples

Este filtro ajusta los registros de ejemplo de UI; recibe los ejemplos y el inventario público de UI del que se derivaron.

Topología

blockstudio/blocks/topology_refreshed

Esta acción se activa después de reconstruir la topología de bloques.

blockstudio/pages/topology_refreshed

Esta acción se activa después de reconstruir la topología de páginas.

blockstudio/pages/layout_error

Esta acción se activa cuando falla el renderizado del diseño de una página, en vez de fallar silenciosamente.

Entorno de ejecución

blockstudio/runtime/initialized

Esta acción se activa cuando el entorno de ejecución resuelve su configuración.

blockstudio/runtime/changed

Esta acción se activa cuando cambia la identidad resuelta del entorno de ejecución, lo que modifica los espacios de nombres de caché y el estado de prerenderizado estático.

blockstudio/performance/default_config

Este filtro ajusta los valores predeterminados de rendimiento antes de aplicar encima los valores de blockstudio.json propios del proyecto.

Contenido

blockstudio/content/orphan_action

Este filtro decide qué hace la sincronización de contenido con un registro que ya no tiene una fuente.

Bootstrap

blockstudio/url

Este filtro cambia el URL público que se usa para los recursos del editor y de administración de Blockstudio. Las integraciones de Composer deben registrarlo antes de cargar el archivo de autocarga de Blockstudio. El segundo argumento es el directorio físico del paquete.

PHP
add_filter(
  'blockstudio/url',
  function(string $url, string $directory) {
    return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
  },
  10,
  2
);

Caché del entorno de ejecución

blockstudio/cache/dir

Este filtro recibe el directorio base de caché resuelto antes de añadir un ámbito de caché de entorno de ejecución, recursos del editor u otro tipo.

PHP
add_filter('blockstudio/cache/dir', function(string $directory) {
  return WP_CONTENT_DIR . '/cache/blockstudio';
});

blockstudio/cache/context

Este filtro añade una variante serializable del entorno de ejecución a las identidades de caché. Úselo cuando una misma fuente de descubrimiento pueda seleccionar inventarios lógicos diferentes.

PHP
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 cambia la identidad del directorio de red/blog para hosts con su propio límite de inquilino. El valor devuelto se depura antes de usarse.

PHP
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 añade datos del host que afectan a todos los objetos de un ámbito del entorno de ejecución. En su lugar, la API propietaria debe pasar las huellas de origen específicas de cada elemento como dependencias explícitas.

PHP
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 el número de segundos durante los que se puede reutilizar una instantánea validada de vigilancia de archivos sin volver a consultar el sistema de archivos. El valor predeterminado es 0 en entornos locales y de desarrollo y 20 en los demás.

PHP
add_filter('blockstudio/cache/watch_debounce', function() {
  return 30;
});

blockstudio/cache/build_wait_budget

Filtra cuánto tiempo, en milisegundos, espera una solicitud a que un constructor concurrente publique la caché del entorno de ejecución o actualice las opciones rellenadas antes de degradarse. El valor predeterminado es 5000 para las reconstrucciones estructurales y 4000 para actualizar las opciones.

PHP
add_filter('blockstudio/cache/build_wait_budget', function() {
  return 2000;
});

blockstudio/cache/populate_debounce

Filtra cuántos segundos se agrupan las escrituras de contenido, términos, usuarios o metadatos para realizar una sola actualización de las opciones rellenadas. La primera escritura tras un periodo de inactividad actualiza de inmediato; la última escritura de una ráfaga se refleja cuando transcurre el intervalo. El valor predeterminado es 30. Devuelva 0 para actualizar con cada escritura.

PHP
add_filter('blockstudio/cache/populate_debounce', function() {
  return 120;
});

blockstudio/cache/populate_ignored_meta_keys

Filtra las claves meta cuyas escrituras nunca actualizan las opciones cargadas. De forma predeterminada, son las claves que WordPress escribe como registro de edición y de inicio de sesión: _edit_lock, actualizada por el editor y Heartbeat mientras hay una entrada abierta; _edit_last, escrita junto con un guardado de entrada que ya actualiza los datos; y session_tokens, escrita al iniciar y cerrar sesión. Añade claves que cambian a menudo, pero nunca afectan a una consulta de opciones.

PHP
add_filter('blockstudio/cache/populate_ignored_meta_keys', function(array $keys) {
  $keys[] = '_my_view_counter';
  return $keys;
});

blockstudio/cache/max_files_per_scope

Filtra cuántas cargas publicadas conserva cada ámbito de caché del entorno de ejecución.

PHP
add_filter('blockstudio/cache/max_files_per_scope', function($maximum, $scope) {
  return $scope === 'runtime' ? 50 : $maximum;
}, 10, 2);

blockstudio/cache/compress

Filtra si un contenido de caché usa datos serializados comprimidos en lugar de un array PHP sin comprimir. De forma predeterminada, solo los contenidos de hasta 1 MiB usan el formato sin comprimir, y solo cuando la memoria compartida activa de OPcache puede almacenar el destino en caché. Otros procesos, archivos excluidos y contenidos más grandes usan compresión.

PHP
add_filter('blockstudio/cache/compress', function($compress, $scope) {
  return $scope === 'runtime' ? false : $compress;
}, 10, 2);

Devolver false también anula el límite de tamaño. Esto puede ayudar cuando WP-CLI sin opcache.enable_cli precarga archivos para los procesos web con OPcache habilitado, pero cada lector sin OPcache analizará el array generado. Mantén la compresión para contenidos compartidos grandes, salvo que el coste adicional de memoria sea aceptable. Consulta formatos de contenido de caché para conocer las protecciones predeterminadas.

blockstudio/cache/protected_paths

La limpieza de retención de rutas de caché nunca debe eliminar. Blockstudio la inicializa con todos los archivos a los que hace referencia el mapa instalado de servicio anticipado.

PHP
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 acción informa de un ámbito de caché compartido y de un resultado, como hit, build, miss-stale, stale-last-good o write-failure.

PHP
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 recibe la decisión final sobre seguridad anónima, además de las entradas del servidor y las cookies. Si devuelve true, siempre se omiten el servicio y la generación estáticos.

PHP
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 proporciona o ajusta el inventario público completo de URL que usan el proceso programado de precalentamiento y las herramientas explícitas de grafos.

PHP
add_filter('blockstudio/static_prerender/public_urls', function(array $urls) {
  $urls[] = home_url('/custom-route/');
  return array_values(array_unique($urls));
});

Lo que devuelve el filtro no es el inventario definitivo. El resultado pasa por una comprobación de capacidad de caché que descarta todo lo que coincida con una ruta dinámica configurada y todo lo que se omite de forma predeterminada: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, cualquier ruta que contenga /feed/ y los resultados de búsqueda bajo la ruta base de búsqueda en la ruta de inicio del sitio (/search/ de forma predeterminada). Por tanto, se puede descartar un URL que añada sin avisar. Si falta una ruta que esperaba en el inventario generado, compruebe estas reglas antes de suponer que el filtro no se ejecutó.

blockstudio/static_prerender/render_internal

Este filtro implementa el transporte por lotes opcional en proceso. Devuelva una matriz de resultados normalizada o deje el valor sin cambios para que el renderizador use su alternativa HTTP configurada. El resultado incluye html y, opcionalmente, status, dependencies, virtualHashes y headers; los encabezados indicados en performance.staticPrerender.replayHeaders se almacenan con el documento.

PHP
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

Esta función toma la decisión definitiva después de que Blockstudio verifique que la salida es un documento HTML completo, sin el marcador de no almacenar en caché, y que el estado de respuesta observado sea satisfactorio. El tercer argumento es el estado observado o null si no se declaró ninguno.

PHP
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 acción informa de los resultados del prerenderizado estático, incluidos aciertos, fallos, escrituras, escrituras de grafos, entradas obsoletas y errores.

PHP
add_action('blockstudio/static_prerender/outcome', function(string $reason) {
  my_metrics()->increment("blockstudio.prerender.{$reason}");
});

blockstudio/tailwind/cache_max_files

Filtra el número máximo de entradas compiladas de Tailwind CSS. El valor predeterminado es 1000.

PHP
add_filter('blockstudio/tailwind/cache_max_files', function() {
  return 1500;
});

blockstudio/tailwind/cache_max_age

Filtra la antigüedad máxima, en segundos, de las entradas compiladas de Tailwind CSS. El valor predeterminado es 30 días y el mínimo, una hora.

PHP
add_filter('blockstudio/tailwind/cache_max_age', function() {
  return 14 * DAY_IN_SECONDS;
});

Administración

habilitado

Este filtro permite habilitar o deshabilitar la página de administración de Blockstudio en Herramientas > Blockstudio.

PHP
add_filter('blockstudio/admin/enabled', function() {
  return false;
});

Recursos

editor/canvas/body_class

Cuando el restablecimiento de recursos está habilitado, este filtro ajusta las clases del cuerpo del frontend depuradas que se copian al lienzo del editor de bloques.

PHP
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
  return array_values(array_diff($classes, ['logged-in']));
});

habilitar

Este filtro permite deshabilitar el procesamiento y la incorporación de recursos de un tipo específico.

PHP
add_filter('blockstudio/assets/enable', function($enable, $type, $block) {
  if ($type === 'css' && $block['name'] === 'my/block') {
    return false;
  }
  return $enable;
}, 10, 3);

deshabilitar

Este filtro permite deshabilitar recursos específicos por su ID. Los recursos cuyo ID coincida con uno de los valores de la matriz devuelta no se renderizarán en el frontend.

PHP
add_filter('blockstudio/assets/disable', function($disabled) {
  $disabled[] = 'my-block-style';
  return $disabled;
});

process/scss/import_paths

Este filtro permite añadir rutas adicionales a la instrucción @import del compilador SCSS.

PHP
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
  $paths[] = get_stylesheet_directory() . '/scss';
  return $paths;
});

process/scss/prelude

Este filtro permite anteponer código compartido de Sass antes de compilar cada archivo SCSS.

PHP
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 el contenido del archivo CSS antes de compilarlo.

PHP
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 el contenido del archivo JS antes de compilarlo.

PHP
add_filter('blockstudio/assets/process/js/content', function($content, $block) {
  return $content;
}, 10, 2);

Búfer

habilitado

Blockstudio almacena en un búfer la respuesta del frontend para poder trasladar al encabezado y al pie las etiquetas de estilo y script de bloques renderizadas dentro del cuerpo, y para que Tailwind pueda analizar el documento completo. El almacenamiento en búfer implica retener y analizar el documento entero en cada solicitud del frontend; un sitio que no renderice recursos de bloques Blockstudio ni use Tailwind puede devolver false para omitir ambas cosas.

PHP
add_filter('blockstudio/buffer/enabled', '__return_false');

El almacenamiento en búfer también está desactivado en el área de administración y en la vista previa del Personalizador. Llama a bs_is_buffering() desde wp_enqueue_scripts o después para saber si la respuesta actual está almacenada en búfer. Devuelve false antes de que se tome la decisión en template_redirect.

salida

Este filtro recibe el documento HTML completo almacenado en búfer antes de enviarlo. La reubicación de recursos propia de Blockstudio se ejecuta con prioridad 1000000 y la compilación de Tailwind con prioridad 999999; por tanto, ejecútelo antes para ver el documento previo a esos procesos o después para ver la salida final.

PHP
add_filter('blockstudio/buffer/output', function(string $html) {
  return $html;
}, 2000000);

Renderizado

dependencias

Este filtro informa de las dependencias de plantillas y recursos cada vez que Blockstudio renderiza un bloque. Es útil para exportadores estáticos y otros recopiladores de dependencias en el mismo proceso.

PHP
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 la salida de la página antes de renderizarla.

PHP
add_filter('blockstudio/render', function($content) {
  return $content;
});

Este filtro te permite ajustar la salida de la etiqueta <head> antes de renderizarla. Solo se ejecuta cuando Blockstudio almacena la respuesta en búfer; consulta bs_is_buffering().

PHP
add_filter('blockstudio/render/head', function($content) {
  return $content . '<meta name="custom" content="value">';
});

Este filtro permite ajustar la salida de </body> antes de renderizarla.

PHP
add_filter('blockstudio/render/footer', function($content) {
  return $content . '<script>console.log("loaded")</script>';
});

Gestión de errores

error/logged

Acción que se activa después de registrar un error. Úsela para enviar errores a servicios externos de registro.

PHP
add_action('blockstudio/error/logged', function($message, $level, $context) {
  if ($level === 'error') {
    my_external_logger($message, $context);
  }
}, 10, 3);

error/exception

Acción que se activa después de gestionar una excepción.

PHP
add_action('blockstudio/error/exception', function($exception, $context) {
  my_error_tracker($exception);
}, 10, 2);

Base de datos

Todos los hooks de base de datos reciben una única matriz $params.

db/before_create

Acción que se activa antes de crear un registro.

PHP
add_action('blockstudio/db/before_create', function($params) {
  // $params: block, schema, data, storage
});

db/after_create

Acción que se activa después de crear un registro.

PHP
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

Acción que se activa antes de actualizar un registro.

PHP
add_action('blockstudio/db/before_update', function($params) {
  // $params: block, schema, id, data, storage
});

db/after_update

Acción que se activa después de actualizar un registro.

PHP
add_action('blockstudio/db/after_update', function($params) {
  // $params: block, schema, id, record, storage
});

db/before_delete

Acción que se activa antes de eliminar un registro.

PHP
add_action('blockstudio/db/before_delete', function($params) {
  // $params: block, schema, id, storage
});

db/after_delete

Acción que se activa después de eliminar un registro.

PHP
add_action('blockstudio/db/after_delete', function($params) {
  // $params: block, schema, id, storage
});

RPC

Todos los hooks de RPC reciben una única matriz $params.

rpc/before_call

Acción que se activa antes de llamar a una función RPC.

PHP
add_action('blockstudio/rpc/before_call', function($params) {
  // $params: block, function, params
});

rpc/after_call

Acción que se activa después de llamar a una función RPC.

PHP
add_action('blockstudio/rpc/after_call', function($params) {
  // $params: block, function, params, result
});