Хуки PHP
Ниже приведен список всех доступных хуков PHP, с помощью которых можно расширять или изменять функциональность плагина.
Путь
Этот фильтр позволяет изменить путь к папке блока. По умолчанию она находится в каталоге blockstudio активной темы. Также можно создать новый экземпляр для нескольких каталогов исходного кода.
add_filter('blockstudio/path', function() {
$path = get_stylesheet_directory() . '/blocks';
return $path;
});
Инициализация
Глобальная
Это действие выполняется после регистрации плагином всех блоков.
add_action('blockstudio/init', function($blocks) {
// All blocks have been registered
});
Экземпляр
Это действие выполняется после регистрации плагином всех блоков конкретного
экземпляра.
Сегмент $instance — это путь экземпляра относительно wp-content.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/$instance", function() {
// All blocks of this instance have been registered
});
global/before
Это действие выполняется до регистрации плагином всех блоков.
add_action('blockstudio/init/before', function() {
// Before blocks are registered
});
global/before/$instance
Это действие выполняется до регистрации плагином всех блоков конкретного экземпляра.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/before/$instance", function() {
// Before blocks of this instance are registered
});
Блоки
Отображение
Этот фильтр позволяет изменить вывод блока перед его отображением.
add_filter('blockstudio/blocks/render', function($content, $block, $attributes) {
// Modify the block content
return $content;
}, 10, 3);
Метаданные
Этот фильтр позволяет изменить данные файла block.json до его регистрации.
add_filter('blockstudio/blocks/meta', function($meta, $block) {
if (str_starts_with($block['name'], 'marketing')) {
$meta['icon'] = 'megaphone';
}
return $meta;
}, 10, 2);
Приведенный выше код изменит значок всех блоков, имена которых начинаются с marketing.
Условия
Этот фильтр позволяет добавлять собственные условия, которые можно использовать в блоках. Каждому типу условия соответствует значение, которое редактор сравнивает с value условия. См. Пользовательские условия.
add_filter('blockstudio/blocks/conditions', function($conditions) {
$conditions['myCustomCondition'] = 'expected';
return $conditions;
});
Атрибуты
Этот фильтр изменяет описание одного поля перед регистрацией блока. Отфильтрованное описание определяет элемент управления в редакторе и проверку значения при отображении. Подробнее см. в разделе Фильтрация.
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
// Modify this field definition before registration.
return $attribute;
}, 10, 2);
attributes/render
Этот фильтр изменяет значение одного поля перед передачей в шаблон блока. Он выполняется один раз для каждого поля и получает три аргумента: $value (разрешённое значение), $key (ключ поля, используемый в $a) и $block (массив данных блока, который шаблоны получают как $block или $b). Зарегистрируйте фильтр, указав три принимаемых аргумента. Подробнее см. в разделе Фильтрация.
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
Поле files возвращает каждое изображение с массивом sizes, содержащим URL, ширину и высоту full и каждого зарегистрированного размера изображения, например $image['sizes']['thumbnail'] и $image['sizes']['thumbnail-width']. Для каждого изображения выполняется отдельный вызов wp_get_attachment_image_src(), поэтому его фильтры продолжают применяться. В шаблонах, которые не читают sizes, список можно удалить или сократить.
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 — это список имён размеров, сначала full (пустой, если промежуточные размеры не зарегистрированы). $id — ID вложения, а $size — размер, запрошенный для значения url. Фильтр изменяет массив sizes каждого значения files в запросе. Без него массив не меняется.
Возвращайте названия размеров в виде строк. Некорректные значения игнорируются, повторяющиеся названия учитываются один раз, а если возвращено не массивное значение, размеры пропускаются. Запрошенное url и остальные свойства вложения остаются без изменений. Этот хук не запускается для поля files с returnFormat: "url", которое не формирует карту размеров.
attributes/validate
Корректирует результаты явных вызовов bs_validate_block(), например когда пользовательский фильтр рендеринга разрешает сохранённые ссылки. Это не включает автоматическую проверку при сохранении или рендеринге.
add_filter('blockstudio/blocks/attributes/validate', function($findings, $name, $attrs) {
return $findings;
}, 10, 3);
Возвращает список результатов. Фильтр не вызывается, если у блока нет полей Blockstudio или подходящих расширений (null).
attributes/schema
Настройте схему JSON, возвращаемую фильтром bs_block_schema(), например, когда пользовательский фильтр рендеринга разрешает сохраненные ссылки.
add_filter('blockstudio/blocks/attributes/schema', function($schema, $name) {
return $schema;
}, 10, 2);
Верните массив схемы. Фильтр не вызывается, если у блока нет полей Blockstudio или подходящих расширений (null).
attributes/populate
Этот фильтр позволяет добавлять пользовательские данные к параметрам поля типа checkbox, select или radio. Подробнее см. в разделе Заполнение параметров.
Фильтр получает один аргумент: массив всех пользовательских наборов данных, ключами которого служат имена, указанные в "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
Этот фильтр позволяет изменить вывод содержимого useBlockProps.
Все фильтры компонентов (use_block_props, inner_blocks и rich_text) получают блок последним аргументом. $block — это WP_Block_Type, зарегистрированный для рендерируемого блока, поэтому $block->name — имя блока, например acme/hero.
$props — это строка атрибутов HTML, а не массив. На внешней стороне это результат get_block_wrapper_attributes(), например class="wp-block-acme-hero my-class". В редакторе это атрибут class элемента. Возвращайте строку. В редакторе применяется только атрибут class возвращённой строки.
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
Этот фильтр позволяет изменить вывод содержимого <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
Этот фильтр позволяет удалить обертку <InnerBlocks /> на внешней стороне сайта.
add_filter('blockstudio/blocks/components/inner_blocks/frontend/wrap', function($wrap, $block) {
return false; // Remove wrapper
}, 10, 2);
components/rich_text/render
Этот фильтр позволяет изменить вывод содержимого <RichText />. Он получает значение атрибута и блок.
add_filter('blockstudio/blocks/components/rich_text/render', function($content, $block) {
return wp_kses_post($content);
}, 10, 2);
Теги блоков
blockstudio/block_tags/builders
Этот фильтр регистрирует построители массивов блоков, используемые тегами блоков и пользовательскими блоками, выбранными через blockstudio/parser/element_mapping. Каждый построитель получает разобранные атрибуты и исходное внутреннее содержимое.
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);
Совместимые фильтры blockstudio/block_tags/renderers и blockstudio/parser/renderers выполняются после этого хука и могут переопределить то же имя блока.
blockstudio/block_tags/tag_aliases
Этот фильтр позволяет регистрировать пользовательские теги авторинга с дефисами, которые сопоставляются с реальными именами блоков до перехода к резервному варианту с необработанным HTML. Это полезно, когда тема использует краткие теги, характерные для проекта, но при этом отображает стандартные блоки Blockstudio или ядра.
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
Этот фильтр позволяет сопоставлять сокращения с префиксами с одним или несколькими пространствами имён блоков. Каждый ключ — это префикс в нижнем регистре без дефисов. Значением может быть строка с пространством имён или упорядоченный список пространств имён.
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> сопоставляется с theme-components/card. <theme-button> сначала проверяет theme-components/button, а затем переходит к bsui/button. Для одного и того же тега приоритет имеют явные записи blockstudio/block_tags/tag_aliases, а неразрешённые теги с префиксом остаются без изменений.
Префиксы можно комбинировать: если тег с префиксом не разрешается напрямую, а его slug сам является зарегистрированным тегом-префиксом, разрешение выполняется рекурсивно. При theme => ['theme-components'] и ui => ['bsui'] тег <theme-ui-input> переходит к префиксу ui и разрешается в bsui/input. Зарегистрированные теги-префиксы и псевдонимы также отображаются в выводе шаблонов блоков, а не только в содержимом страниц.
Настройки
путь
Этот фильтр позволяет изменить путь к файлу blockstudio.json. По умолчанию он находится по пути blockstudio.json в текущей активной теме.
add_filter('blockstudio/settings/path', function() {
return get_stylesheet_directory() . '/config/blockstudio.json';
});
users/ids
Этот фильтр позволяет включить редактор для определённых идентификаторов пользователей.
add_filter('blockstudio/settings/users/ids', function() {
return [1];
});
users/roles
Этот фильтр позволяет включить редактор для определённых ролей пользователей.
add_filter('blockstudio/settings/users/roles', function() {
return ['administrator', 'editor'];
});
assets/enqueue
Этот фильтр позволяет включать и отключать подключение ресурсов во внешней части сайта и редакторе.
add_filter('blockstudio/settings/assets/enqueue', function() {
return false;
});
assets/reset/enabled
Этот фильтр позволяет включать и отключать удаление стилей блоков ядра WordPress и сброса макета для служебных элементов редактора.
add_filter('blockstudio/settings/assets/reset/enabled', function() {
return true;
});
assets/reset/full_width
Этот фильтр позволяет управлять типами записей, для которых доступно редактирование во всю ширину.
add_filter('blockstudio/settings/assets/reset/full_width', function() {
return ['page'];
});
assets/minify/css
Этот фильтр позволяет включать и отключать минификацию CSS.
add_filter('blockstudio/settings/assets/minify/css', function() {
return true;
});
assets/minify/js
Этот фильтр позволяет включать и отключать минификацию JS.
add_filter('blockstudio/settings/assets/minify/js', function() {
return true;
});
assets/process/scss
Этот фильтр позволяет включать и отключать обработку SCSS в файлах .css.
add_filter('blockstudio/settings/assets/process/scss', function() {
return true;
});
assets/process/scss_files
Этот фильтр позволяет включать и отключать преобразование файлов .scss в CSS.
add_filter('blockstudio/settings/assets/process/scss_files', function() {
return true;
});
assets/output
Этот фильтр позволяет управлять расположением скомпилированных ресурсов блоков.
add_filter('blockstudio/settings/assets/output', function() {
return 'cache';
});
assets/inline_limit
Фильтрует количество байтов внешнего CSS блока, встраиваемых на страницу.
add_filter('blockstudio/settings/assets/inline_limit', function() {
return 40000;
});
cache/enabled
Этот фильтр позволяет включать и отключать все файловые кэши среды выполнения и ресурсов редактора Blockstudio.
add_filter('blockstudio/settings/cache/enabled', function() {
return false;
});
cache/path
Этот фильтр позволяет изменить каталог файлового кэша Blockstudio.
add_filter('blockstudio/settings/cache/path', function() {
return 'cache/blockstudio';
});
cache/namespace_grace
Этот фильтр позволяет изменить срок хранения выведенного из эксплуатации пространства имён кэша до его очистки.
add_filter('blockstudio/settings/cache/namespace_grace', function() {
return 777600;
});
githooks/commit
Этот фильтр показывает, включён ли хук фиксации PHPStan, принадлежащий Blockstudio.
add_filter('blockstudio/settings/githooks/commit', function() {
return true;
});
content/enabled
Этот фильтр позволяет включать и отключать Content Sync.
add_filter('blockstudio/settings/content/enabled', function() {
return true;
});
content/id
Этот фильтр позволяет задать пространство имён-владельца для Content Sync.
add_filter('blockstudio/settings/content/id', function() {
return 'docs';
});
content/path
Этот фильтр позволяет задать каталог файлов Content Sync.
add_filter('blockstudio/settings/content/path', function() {
return 'content';
});
content/include_page_sync_managed
Этот фильтр позволяет включать или исключать записи, которыми управляет Page Sync.
add_filter('blockstudio/settings/content/include_page_sync_managed', function() {
return false;
});
content/authors
Этот фильтр позволяет настроить обработку авторов в Content Sync.
add_filter('blockstudio/settings/content/authors', function() {
return 'ignore';
});
content/post_types
Этот фильтр позволяет настроить списки разрешённых типов записей для Content Sync.
add_filter('blockstudio/settings/content/post_types', function() {
return ['team_member'];
});
content/taxonomies
Этот фильтр позволяет настроить списки разрешённых таксономий для Content Sync.
add_filter('blockstudio/settings/content/taxonomies', function() {
return ['category', 'post_tag'];
});
content/media
Этот фильтр позволяет настроить обработку медиафайлов в Content Sync.
add_filter('blockstudio/settings/content/media', function() {
return 'manifest';
});
tailwind/enabled
Этот фильтр позволяет включать и отключать Tailwind.
add_filter('blockstudio/settings/tailwind/enabled', function() {
return true;
});
tailwind/config
Этот фильтр позволяет добавить пользовательскую конфигурацию Tailwind CSS.
add_filter('blockstudio/settings/tailwind/config', function() {
return '@theme { --color-primary: pink; }';
});
tailwind/output
Этот фильтр позволяет выбрать встроенный или подключаемый вывод Tailwind CSS.
add_filter('blockstudio/settings/tailwind/output', function() {
return 'link';
});
ui/enabled
Этот фильтр позволяет включать и отключать входящие в комплект компоненты UI.
add_filter('blockstudio/settings/ui/enabled', function() {
return true;
});
editor/format_on_save
Этот фильтр позволяет включать и отключать форматирование кода при сохранении.
add_filter('blockstudio/settings/editor/format_on_save', function() {
return true;
});
editor/assets
Этот фильтр позволяет подключать дополнительные ресурсы в редакторе.
add_filter('blockstudio/settings/editor/assets', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
editor/markup
Этот фильтр позволяет добавить дополнительную разметку в конец редактора.
add_filter('blockstudio/settings/editor/markup', function() {
return '<style>body { background: black; }</style>';
});
block_editor/disable_loading
Этот фильтр позволяет отключить загрузку блоков в редакторе блоков.
add_filter('blockstudio/settings/block_editor/disable_loading', function() {
return true;
});
block_editor/enhance
Этот фильтр позволяет включить возможности редактора Blockstudio, например более чистые стили фокуса и контуры при наведении или выборе.
add_filter('blockstudio/settings/block_editor/enhance', function() {
return true;
});
block_editor/css_classes
Этот фильтр позволяет добавить таблицы стилей, классы которых будут доступны для выбора в поле классов.
add_filter('blockstudio/settings/block_editor/css_classes', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/css_variables
Этот фильтр позволяет добавить таблицы стилей, переменные CSS из которых будут доступны для автодополнения в поле кода.
add_filter('blockstudio/settings/block_editor/css_variables', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/blocks/allow
Этот фильтр позволяет управлять именами блоков, доступных во вставщике.
add_filter('blockstudio/settings/block_editor/blocks/allow', function() {
return ['core/*', 'acf/*', 'my-theme/*'];
});
block_editor/blocks/deny
Этот фильтр позволяет удалять имена блоков из вставщика.
add_filter('blockstudio/settings/block_editor/blocks/deny', function() {
return ['core/embed', 'core/freeform'];
});
block_editor/blocks/directory
Этот фильтр позволяет включать и отключать ресурсы каталога блоков WordPress в редакторе.
add_filter('blockstudio/settings/block_editor/blocks/directory', function() {
return false;
});
block_editor/blocks/categories/allow
Этот фильтр позволяет управлять slug-ами категорий блоков, которые остаются доступными.
add_filter('blockstudio/settings/block_editor/blocks/categories/allow', function() {
return ['text', 'media', 'design'];
});
block_editor/blocks/categories/deny
Этот фильтр позволяет удалять slug-и категорий блоков из вставщика.
add_filter('blockstudio/settings/block_editor/blocks/categories/deny', function() {
return ['embed'];
});
block_editor/blocks/categories/rename
Этот фильтр позволяет переименовывать названия категорий блоков по slug-у.
add_filter('blockstudio/settings/block_editor/blocks/categories/rename', function() {
return [
'text' => 'Writing',
'design' => 'Layout'
];
});
block_editor/blocks/categories/order
Этот фильтр позволяет задавать порядок slug-ов категорий блоков во вставщике.
add_filter('blockstudio/settings/block_editor/blocks/categories/order', function() {
return ['my-theme', 'text', 'media'];
});
block_editor/blocks/styles/deny
Этот фильтр позволяет отменять регистрацию стилей блоков, зарегистрированных через 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
Этот фильтр позволяет скрыть дополнительные устаревшие виджеты из блока устаревших виджетов.
add_filter('blockstudio/settings/block_editor/blocks/legacy_widgets/hide', function() {
return ['archives', 'calendar'];
});
block_editor/patterns/core
Этот фильтр позволяет включать и отключать шаблоны блоков ядра WordPress.
add_filter('blockstudio/settings/block_editor/patterns/core', function() {
return false;
});
block_editor/patterns/remote
Этот фильтр позволяет включать и отключать удалённые шаблоны из каталога шаблонов WordPress.
add_filter('blockstudio/settings/block_editor/patterns/remote', function() {
return false;
});
block_editor/patterns/theme
Этот фильтр позволяет включать и отключать шаблоны блоков, предоставляемые темой.
add_filter('blockstudio/settings/block_editor/patterns/theme', function() {
return false;
});
block_editor/patterns/blockstudio
Этот фильтр позволяет включать и отключать шаблоны на основе файлов Blockstudio.
add_filter('blockstudio/settings/block_editor/patterns/blockstudio', function() {
return false;
});
block_editor/patterns/categories/allow
Этот фильтр позволяет управлять slug-ами категорий шаблонов, которые остаются доступными.
add_filter('blockstudio/settings/block_editor/patterns/categories/allow', function() {
return ['featured', 'buttons', 'columns'];
});
block_editor/patterns/categories/deny
Этот фильтр позволяет удалять slug-и категорий шаблонов из вставщика шаблонов.
add_filter('blockstudio/settings/block_editor/patterns/categories/deny', function() {
return ['gallery'];
});
block_editor/patterns/categories/rename
Этот фильтр позволяет переименовывать названия категорий шаблонов по slug-у.
add_filter('blockstudio/settings/block_editor/patterns/categories/rename', function() {
return [
'featured' => 'Featured Layouts'
];
});
block_editor/patterns/categories/order
Этот фильтр позволяет задавать порядок slug-ов категорий шаблонов во вставщике.
add_filter('blockstudio/settings/block_editor/patterns/categories/order', function() {
return ['featured', 'buttons'];
});
block_editor/media/openverse
Этот фильтр позволяет включать и отключать категорию медиафайлов Openverse во вставщике медиафайлов редактора блоков.
add_filter('blockstudio/settings/block_editor/media/openverse', function() {
return false;
});
block_editor/media/image_sizes/allow
Этот фильтр позволяет управлять названиями размеров изображений, доступными в элементах управления медиафайлами редактора.
add_filter('blockstudio/settings/block_editor/media/image_sizes/allow', function() {
return ['thumbnail', 'large'];
});
block_editor/media/image_sizes/deny
Этот фильтр позволяет удалять названия размеров изображений из элементов управления медиафайлами редактора.
add_filter('blockstudio/settings/block_editor/media/image_sizes/deny', function() {
return ['medium_large'];
});
ai/enable_context_generation
Этот фильтр позволяет включать и отключать создание файла контекста для интеграции с инструментами LLM. Если эта функция включена, файл контекста объединяет актуальные данные о блоках, настройки Blockstudio текущей установки, все соответствующие схемы и документацию Blockstudio в единый источник для инструментов разработки с ИИ.
add_filter('blockstudio/settings/ai/enable_context_generation', function() {
return true;
});
block_tags/enabled
Этот фильтр позволяет включать и отключать отображение тегов блоков на уровне страницы.
add_filter('blockstudio/settings/block_tags/enabled', function() {
return true;
});
block_tags/prefixes
Этот фильтр позволяет регистрировать сокращения «префикс — пространство имён» для тегов блоков.
add_filter('blockstudio/settings/block_tags/prefixes', function() {
return [
'theme' => ['theme-components', 'bsui']
];
});
dev/grab/enabled
Этот фильтр позволяет включать и отключать захватчик элементов.
add_filter('blockstudio/settings/dev/grab/enabled', function() {
return false;
});
dev/perf
Этот фильтр позволяет включать и отключать профилировщик производительности.
add_filter('blockstudio/settings/dev/perf', function() {
return false;
});
dev/canvas/enabled
Этот фильтр позволяет включать и отключать холст.
add_filter('blockstudio/settings/dev/canvas/enabled', function() {
return false;
});
dev/canvas/admin_bar
Этот фильтр позволяет показывать или скрывать панель администратора WordPress на холсте.
add_filter('blockstudio/settings/dev/canvas/admin_bar', function() {
return true;
});
WPML
blockstudio/wpml/config/label
Фильтрует метку каждого ключа, который записывает wp bs wpml config. См. Изменение меток для массива контекста.
add_filter('blockstudio/wpml/config/label', function($label, $context) {
return str_replace(' (optional)', '', $label);
}, 10, 2);
Холст
blockstudio/canvas/inventory
Этот фильтр изменяет перечень данных, который Canvas возвращает для выбранного элемента. Функция обратного вызова получает DTO перечня, исходное выделение и параметры, с которыми её вызвали.
add_filter('blockstudio/canvas/inventory', function(array $result, array $selection, array $options) {
return $result;
}, 10, 3);
blockstudio/canvas/documents
Этот фильтр изменяет отрисованные документы, которые возвращает Canvas, и принимает те же три аргумента, что и фильтр перечня.
blockstudio/canvas/item_loaded
Это действие выполняется при загрузке каждой записи перечня данных и получает тип данных, канонический идентификатор записи и нормализованную запись.
blockstudio/canvas/source_compiled
Это действие выполняется после компиляции исходного файла для Canvas и получает выбранный путь к исходному файлу и каноническую запись источника.
Встроенные UI
blockstudio/ui/directories
Этот фильтр изменяет каталоги, в которых выполняется поиск встроенных компонентов UI.
blockstudio/ui/inventory
Этот фильтр изменяет общедоступный перечень семейств UI.
blockstudio/ui/examples
Этот фильтр изменяет примеры UI, получая примеры и общедоступный перечень UI, на основе которого они созданы.
Топология
blockstudio/blocks/topology_refreshed
Это действие выполняется после перестроения топологии блоков.
blockstudio/pages/topology_refreshed
Это действие выполняется после перестроения топологии страницы.
blockstudio/pages/layout_error
Это действие выполняется при ошибке отображения макета страницы, вместо того чтобы завершиться без уведомления.
Среда выполнения
blockstudio/runtime/initialized
Это действие выполняется после определения конфигурации среды выполнения.
blockstudio/runtime/changed
Это действие выполняется при изменении определённой идентичности среды выполнения, что приводит к смене пространств имён кэша и состояния предварительной статической отрисовки.
blockstudio/performance/default_config
Этот фильтр изменяет настройки производительности по умолчанию до применения поверх них собственных значений проекта blockstudio.json.
Содержимое
blockstudio/content/orphan_action
Этот фильтр определяет, что Content Sync делает с записью, у которой больше нет источника.
Bootstrap
blockstudio/url
Этот фильтр изменяет общедоступный URL, используемый для ресурсов редактора и панели администратора Blockstudio. Интеграции Composer должны зарегистрировать его до загрузки файла автозагрузки Blockstudio. Второй аргумент — физический каталог пакета.
add_filter(
'blockstudio/url',
function(string $url, string $directory) {
return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
},
10,
2
);
Кэш среды выполнения
blockstudio/cache/dir
Этот фильтр получает определённый базовый каталог кэша до добавления области среды выполнения, ресурсов редактора или другого кэша.
add_filter('blockstudio/cache/dir', function(string $directory) {
return WP_CONTENT_DIR . '/cache/blockstudio';
});
blockstudio/cache/context
Этот фильтр добавляет сериализуемый вариант среды выполнения к идентификаторам кэша. Используйте его, если один и тот же источник обнаружения может выбирать разные логические перечни.
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
Этот фильтр изменяет идентификатор каталога сети/блога для узлов со своей границей арендатора. Возвращаемое значение очищается перед использованием.
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
Этот фильтр добавляет сведения об узле, влияющие на каждый объект в области среды выполнения. Отпечатки источников для отдельных элементов следует передавать как явные зависимости принадлежащему им API.
add_filter(
'blockstudio/runtime/identity',
function(array $identity, string $scope) {
$identity['deployment'] = getenv('RELEASE_SHA') ?: 'local';
return $identity;
},
10,
2
);
blockstudio/cache/watch_debounce
Фильтрует число секунд, в течение которых можно повторно использовать проверенный снимок отслеживания файлов без дополнительного прохода stat по файловой системе. По умолчанию — 0 в локальных средах и средах разработки и 20 в остальных случаях.
add_filter('blockstudio/cache/watch_debounce', function() {
return 30;
});
blockstudio/cache/build_wait_budget
Фильтрует время в миллисекундах, в течение которого запрос ожидает публикации кэша среды выполнения или обновления заполненных вариантов параллельным построителем, прежде чем перейти к упрощённому режиму. По умолчанию — 5000 для структурных перестроений и 4000 для обновления вариантов.
add_filter('blockstudio/cache/build_wait_budget', function() {
return 2000;
});
blockstudio/cache/populate_debounce
Фильтрует число секунд, в течение которых серия изменений содержимого, терминов, пользователей или метаданных объединяется в одно обновление заполненных вариантов. Первая запись после периода бездействия вызывает немедленное обновление; последняя запись серии отражается по истечении окна. По умолчанию — 30. Возвратите 0, чтобы обновлять при каждой записи.
add_filter('blockstudio/cache/populate_debounce', function() {
return 120;
});
blockstudio/cache/populate_ignored_meta_keys
Фильтрует метаключи, записи которых никогда не обновляют заполненные варианты. По умолчанию это ключи, которые WordPress записывает для учёта редактирования и входа в систему: _edit_lock обновляется редактором и Heartbeat, пока запись открыта; _edit_last записывается при сохранении записи, которое и так выполняет обновление; session_tokens записывается при входе и выходе из системы. Добавляйте ключи, которые часто меняются, но никогда не влияют на запрос заполнения.
add_filter('blockstudio/cache/populate_ignored_meta_keys', function(array $keys) {
$keys[] = '_my_view_counter';
return $keys;
});
blockstudio/cache/max_files_per_scope
Фильтрует количество опубликованных полезных данных, сохраняемых каждой областью кэша среды выполнения.
add_filter('blockstudio/cache/max_files_per_scope', function($maximum, $scope) {
return $scope === 'runtime' ? 50 : $maximum;
}, 10, 2);
blockstudio/cache/compress
Фильтрует, использует ли полезная нагрузка кэша сжатые сериализованные данные вместо обычного массива PHP. По умолчанию обычный формат используется только для полезных нагрузок размером до 1 MiB и только если активная общая память OPcache может кэшировать целевой файл. В остальных процессах, для исключённых файлов и больших полезных нагрузок используется сжатие.
add_filter('blockstudio/cache/compress', function($compress, $scope) {
return $scope === 'runtime' ? false : $compress;
}, 10, 2);
Возврат false также отменяет ограничение размера. Это может быть полезно, когда WP-CLI без opcache.enable_cli прогревает файлы для веб-воркеров с включённым OPcache, но каждый читатель без OPcache будет разбирать сгенерированный массив. Сохраняйте сжатие для больших общих полезных нагрузок, если дополнительные затраты памяти неприемлемы. Сведения о стандартных мерах защиты см. в разделе форматы полезных нагрузок кэша.
blockstudio/cache/protected_paths
Очистка кэшированных путей по сроку хранения ни при каких обстоятельствах не должна удалять. Blockstudio добавляет в него каждый файл, на который ссылается установленная карта ранней обработки запросов.
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
Это действие сообщает об общей области кэша и результате, например hit, build, miss-stale, stale-last-good или 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
Этот фильтр получает итоговое решение о безопасности для анонимных запросов, а также данные сервера и файлов cookie. Возврат true всегда обходит статическую обработку и генерацию.
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
Этот фильтр предоставляет или изменяет полный общедоступный перечень URL, используемый планировщиком предварительной загрузки и явными инструментами работы с графом.
add_filter('blockstudio/static_prerender/public_urls', function(array $urls) {
$urls[] = home_url('/custom-route/');
return array_values(array_unique($urls));
});
Результат фильтра не является итоговым перечнем. Он проходит проверку на возможность кэширования, которая удаляет всё, что соответствует настроенному динамическому пути, а также всё, что по умолчанию исключено из обработки: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, любые пути, содержащие /feed/, и результаты поиска ниже базового пути поиска на главной странице сайта (по умолчанию — /search/). Поэтому добавленный вами URL может быть удалён без предупреждения. Если ожидаемый маршрут отсутствует в построенном перечне, прежде чем предполагать, что фильтр не сработал, проверьте его на соответствие этим правилам.
blockstudio/static_prerender/render_internal
Этот фильтр реализует необязательную пакетную передачу данных в рамках одного процесса. Верните нормализованный массив результатов или оставьте значение без изменений, чтобы средство рендеринга использовало настроенный резервный вариант HTTP. Результат содержит html и, при необходимости, status, dependencies, virtualHashes и headers; заголовки, указанные в performance.staticPrerender.replayHeaders, сохраняются вместе с документом.
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
Этот фильтр принимает окончательное решение после того, как Blockstudio проверит, что вывод представляет собой полный документ HTML без маркера запрета кэширования и что полученный статус ответа указывает на успех. Третий аргумент — полученный статус или null, если статус не был указан.
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
Это действие сообщает о результатах предварительной статической отрисовки, включая попадания и промахи кэша, записи, записи графа, устаревшие записи и сбои.
add_action('blockstudio/static_prerender/outcome', function(string $reason) {
my_metrics()->increment("blockstudio.prerender.{$reason}");
});
blockstudio/tailwind/cache_max_files
Фильтрует максимальное количество скомпилированных записей Tailwind CSS. По умолчанию — 1000.
add_filter('blockstudio/tailwind/cache_max_files', function() {
return 1500;
});
blockstudio/tailwind/cache_max_age
Фильтрует максимальный срок хранения скомпилированных записей Tailwind CSS в секундах. По умолчанию — 30 дней, минимальный срок — один час.
add_filter('blockstudio/tailwind/cache_max_age', function() {
return 14 * DAY_IN_SECONDS;
});
Административная панель
включено
Этот фильтр позволяет включать и отключать страницу администратора Blockstudio в разделе Инструменты > Blockstudio.
add_filter('blockstudio/admin/enabled', function() {
return false;
});
Ресурсы
editor/canvas/body_class
Если сброс ресурсов включён, этот фильтр изменяет очищенные классы тела страницы во внешней части сайта, которые копируются на холст редактора блоков.
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
return array_values(array_diff($classes, ['logged-in']));
});
включить
Этот фильтр позволяет отключить обработку ресурсов определённого типа и их подключение.
add_filter('blockstudio/assets/enable', function($enable, $type, $block) {
if ($type === 'css' && $block['name'] === 'my/block') {
return false;
}
return $enable;
}, 10, 3);
отключить
Этот фильтр позволяет отключать отдельные ресурсы по их идентификатору. Ресурсы с идентификаторами из возвращённого массива не будут отображаться во внешней части сайта.
add_filter('blockstudio/assets/disable', function($disabled) {
$disabled[] = 'my-block-style';
return $disabled;
});
process/scss/import_paths
Этот фильтр позволяет добавить дополнительные пути к директиве @import компилятора SCSS.
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
$paths[] = get_stylesheet_directory() . '/scss';
return $paths;
});
process/scss/prelude
Этот фильтр позволяет добавлять общий код Sass перед компиляцией каждого файла 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
Этот фильтр позволяет изменить содержимое файла CSS перед его компиляцией.
add_filter('blockstudio/assets/process/css/content', function($content, $block) {
return str_replace('old-class', 'new-class', $content);
}, 10, 2);
process/js/content
Этот фильтр позволяет изменить содержимое файла JS перед его компиляцией.
add_filter('blockstudio/assets/process/js/content', function($content, $block) {
return $content;
}, 10, 2);
Буферизация
включено
Blockstudio буферизует ответ внешней части сайта, чтобы теги стилей и скриптов блоков, размещённые в теле страницы, можно было перенести в заголовок и футер, а Tailwind мог просканировать весь документ. Буферизация означает, что весь документ удерживается и сканируется при каждом запросе к внешней части сайта. Если на сайте нет ресурсов блоков Blockstudio и не используется Tailwind, можно вернуть false, чтобы пропустить и то и другое.
add_filter('blockstudio/buffer/enabled', '__return_false');
Буферизация также отключена в панели администратора и в предварительном просмотре Customizer. Вызовите bs_is_buffering() из wp_enqueue_scripts или позднее, чтобы узнать, буферизуется ли текущий ответ. До принятия решения в template_redirect функция возвращает false.
вывод
Этот фильтр получает полный буферизованный документ HTML перед отправкой. Собственные ресурсы Blockstudio переносятся с приоритетом 1000000, а компиляция Tailwind выполняется с приоритетом 999999. Запускайте фильтр раньше, чтобы увидеть документ до этих операций, или позже, чтобы увидеть итоговый вывод.
add_filter('blockstudio/buffer/output', function(string $html) {
return $html;
}, 2000000);
Отрисовка
зависимости
Этот фильтр сообщает о выбранных шаблоне и зависимостях ресурсов каждый раз, когда Blockstudio отрисовывает блок. Он полезен для статических экспортёров и других средств сбора зависимостей внутри процесса.
add_filter(
'blockstudio/render/dependencies',
function($paths, $name, $block, $isEditor, $isPreview) {
my_dependency_graph()->add($name, $paths);
return $paths;
},
10,
5
);
Глобальная
Этот фильтр позволяет изменить вывод страницы перед её отрисовкой.
add_filter('blockstudio/render', function($content) {
return $content;
});
заголовок
Этот фильтр позволяет изменить вывод тега <head> перед его рендерингом. Он запускается, только если Blockstudio буферизует ответ. См. bs_is_buffering().
add_filter('blockstudio/render/head', function($content) {
return $content . '<meta name="custom" content="value">';
});
нижняя часть страницы
Этот фильтр позволяет изменить вывод </body> перед его отрисовкой.
add_filter('blockstudio/render/footer', function($content) {
return $content . '<script>console.log("loaded")</script>';
});
Обработка ошибок
error/logged
Действие выполняется после регистрации ошибки. Используйте его, чтобы отправлять ошибки во внешние службы журналирования.
add_action('blockstudio/error/logged', function($message, $level, $context) {
if ($level === 'error') {
my_external_logger($message, $context);
}
}, 10, 3);
error/exception
Действие выполняется после обработки исключения.
add_action('blockstudio/error/exception', function($exception, $context) {
my_error_tracker($exception);
}, 10, 2);
База данных
Все хуки базы данных получают один массив $params.
db/before_create
Действие выполняется перед созданием записи.
add_action('blockstudio/db/before_create', function($params) {
// $params: block, schema, data, storage
});
db/after_create
Действие выполняется после создания записи.
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
Действие выполняется перед обновлением записи.
add_action('blockstudio/db/before_update', function($params) {
// $params: block, schema, id, data, storage
});
db/after_update
Действие выполняется после обновления записи.
add_action('blockstudio/db/after_update', function($params) {
// $params: block, schema, id, record, storage
});
db/before_delete
Действие выполняется перед удалением записи.
add_action('blockstudio/db/before_delete', function($params) {
// $params: block, schema, id, storage
});
db/after_delete
Действие выполняется после удаления записи.
add_action('blockstudio/db/after_delete', function($params) {
// $params: block, schema, id, storage
});
RPC
Все хуки RPC получают один массив $params.
rpc/before_call
Действие выполняется перед вызовом функции RPC.
add_action('blockstudio/rpc/before_call', function($params) {
// $params: block, function, params
});
rpc/after_call
Действие выполняется после вызова функции RPC.
add_action('blockstudio/rpc/after_call', function($params) {
// $params: block, function, params, result
});