Hooks на PHP
По-долу е даден списък на всички налични hooks на 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 на всяка стойност за файлове в заявката. Без него масивът остава непроменен.
Връщайте имената на размерите като низове. Невалидните записи се игнорират, а дублиращите се имена се обработват само веднъж. Ако върнатата стойност не е масив, размерите се пропускат. Заявените url и другите свойства на прикачения файл остават непроменени. Този hook не се изпълнява за поле 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 имат предимство за същия етикет,
а неразпознатите етикети с префикс остават непроменени.
Префиксите се комбинират: ако даден етикет с префикс не се разреши директно, а неговият идентификатор сам по себе си е регистриран етикет с префикс, разрешаването се повтаря рекурсивно. С 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
Този филтър ви позволява да активирате редактора за конкретни потребителски ID.
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
Този филтър ви позволява да активирате или деактивирате синхронизирането на съдържание.
add_filter('blockstudio/settings/content/enabled', function() {
return true;
});
content/id
Този филтър ви позволява да зададете пространството от имена на собственика за синхронизирането на съдържание.
add_filter('blockstudio/settings/content/id', function() {
return 'docs';
});
content/path
Този филтър ви позволява да зададете директорията с файлове за синхронизирането на съдържание.
add_filter('blockstudio/settings/content/path', function() {
return 'content';
});
content/include_page_sync_managed
Този филтър ви позволява да включвате или изключвате публикации, управлявани от синхронизирането на страници.
add_filter('blockstudio/settings/content/include_page_sync_managed', function() {
return false;
});
content/authors
Този филтър ви позволява да конфигурирате обработката на автори при синхронизирането на съдържание.
add_filter('blockstudio/settings/content/authors', function() {
return 'ignore';
});
content/post_types
Този филтър ви позволява да конфигурирате списъците с разрешени типове публикации за синхронизиране на съдържание.
add_filter('blockstudio/settings/content/post_types', function() {
return ['team_member'];
});
content/taxonomies
Този филтър ви позволява да конфигурирате списъците с разрешени таксономии за синхронизиране на съдържание.
add_filter('blockstudio/settings/content/taxonomies', function() {
return ['category', 'post_tag'];
});
content/media
Този филтър ви позволява да конфигурирате обработката на медийни файлове при синхронизирането на съдържание.
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
Този филтър ви позволява да управлявате кои идентификатори на категории блокове остават достъпни.
add_filter('blockstudio/settings/block_editor/blocks/categories/allow', function() {
return ['text', 'media', 'design'];
});
block_editor/blocks/categories/deny
Този филтър ви позволява да премахвате идентификатори на категории блокове от инструмента за вмъкване.
add_filter('blockstudio/settings/block_editor/blocks/categories/deny', function() {
return ['embed'];
});
block_editor/blocks/categories/rename
Този филтър ви позволява да преименувате етикети на категории блокове по идентификатор.
add_filter('blockstudio/settings/block_editor/blocks/categories/rename', function() {
return [
'text' => 'Writing',
'design' => 'Layout'
];
});
block_editor/blocks/categories/order
Този филтър ви позволява да подреждате идентификаторите на категориите блокове в инструмента за вмъкване.
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
Този филтър ви позволява да управлявате кои идентификатори на категории шаблони остават достъпни.
add_filter('blockstudio/settings/block_editor/patterns/categories/allow', function() {
return ['featured', 'buttons', 'columns'];
});
block_editor/patterns/categories/deny
Този филтър ви позволява да премахвате идентификатори на категории шаблони от инструмента за вмъкване на шаблони.
add_filter('blockstudio/settings/block_editor/patterns/categories/deny', function() {
return ['gallery'];
});
block_editor/patterns/categories/rename
Този филтър ви позволява да преименувате етикетите на категориите шаблони по идентификатор.
add_filter('blockstudio/settings/block_editor/patterns/categories/rename', function() {
return [
'featured' => 'Featured Layouts'
];
});
block_editor/patterns/categories/order
Този филтър ви позволява да подреждате идентификаторите на категориите шаблони в инструмента за вмъкване.
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 в един източник за използване с инструменти за разработка с AI.
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
Това действие се изпълнява веднъж за всеки запис в инвентара при зареждането му и получава типа на инвентара, каноничния ID на записа и нормализирания запис.
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
Този филтър определя как синхронизирането на съдържание да обработва запис, който вече няма източник.
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
Филтрира броя секунди, през които може да се използва повторно валидиран моментен образ от наблюдение на файлове без ново проверяване на файловата система. По подразбиране е 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
Този филтър получава окончателното решение за безопасност при анонимно достъпване, както и входните данни за сървъра и бисквитките. Връщането на 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);
деактивиране
Този филтър ви позволява да деактивирате конкретни ресурси по техния ID. Ресурсите, чийто ID присъства във върнатия масив, няма да бъдат визуализирани в публичната част.
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 или по-късно, за да разберете дали текущият отговор се буферира. Връща false, преди решението да бъде взето при template_redirect.
изход
Този филтър получава целия буфериран документ 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
});