Перейти до вмісту

PHP Хуки

Нижче наведено список усіх доступних хуків PHP, за допомогою яких можна розширити або змінити функціональність плагіна.

Шлях

Цей фільтр дає змогу змінити шлях до папки блока. За замовчуванням це blockstudio у поточній активній темі. Також можна створити новий екземпляр для кількох каталогів вихідного коду.

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

Ініціалізація

глобальний

Ця дія виконується після того, як плагін зареєструє всі блоки.

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

екземпляр

Ця дія виконується після того, як плагін зареєструє всі блоки певного екземпляра. Сегмент $instance — це шлях до екземпляра відносно 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

Ця дія виконується перед тим, як плагін зареєструє всі блоки.

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

global/before/$instance

Ця дія виконується перед тим, як плагін зареєструє всі блоки певного екземпляра.

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

Блоки

рендеринг

Цей фільтр дає змогу змінити вивід блока перед рендерингом.

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

метадані

Цей фільтр дає змогу змінити дані файла block.json перед його реєстрацією.

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

Наведений вище код змінить піктограму всіх блоків, назва яких починається з marketing.

умови

Цей фільтр дає змогу додавати власні умови, які можна використовувати в блоках. Кожному типу умови відповідає значення, яке редактор порівнює з value умови. Див. Власні умови.

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

атрибути

Цей фільтр змінює визначення одного поля перед реєстрацією блока. Відфільтроване визначення керує елементом керування редактора та перевіркою значень під час рендерингу. Докладніше див. Фільтрування.

PHP
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). Зареєструйте його з трьома прийнятими аргументами. Докладніше див. Фільтрування.

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

Поле files повертає кожне зображення з масивом sizes, що містить URL, ширину й висоту full, а також кожного зареєстрованого розміру зображення, наприклад $image['sizes']['thumbnail'] і $image['sizes']['thumbnail-width']. Для кожного розміру виконується один виклик wp_get_attachment_image_src() на зображення, тож його фільтри й надалі застосовуються. У шаблонах, які ніколи не читають sizes, список можна видалити або скоротити.

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 — це список назв розмірів, full перша (порожній, якщо проміжні розміри не зареєстровано). $id — це ID вкладення, а $size — розмір, запитаний для url значення. Фільтр змінює масив sizes кожного значення типу файлу в запиті. Без нього масив лишається незмінним.

Повертає назви розмірів у вигляді рядків. Недійсні записи ігноруються, дублікати назв опрацьовуються один раз, а значення, яке не є масивом, пропускає розміри. Запитаний url та інші властивості вкладення залишаються незмінними. Цей хук не запускається для поля файлу з returnFormat: "url", для якого не створюється мапа розмірів.

attributes/validate

Коригує результати явних викликів bs_validate_block(), наприклад, коли власний фільтр рендерингу розв’язує збережені посилання. Це не вмикає автоматичну перевірку під час збереження чи рендерингу.

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

Повертає список результатів. Фільтр не викликається, якщо блок не має полів Blockstudio або відповідних розширень (null).

attributes/schema

Налаштуйте схему JSON, яку повертає bs_block_schema(), наприклад, коли власний фільтр рендерингу розв’язує збережені посилання.

PHP
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"}.

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

Цей фільтр дає змогу змінити вивід вмісту 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 повернутого рядка.

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

Цей фільтр дає змогу змінити вивід вмісту <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

Цей фільтр дає змогу прибрати обгортку <InnerBlocks /> з фронтенду.

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

components/rich_text/render

Цей фільтр дає змогу коригувати виведення вмісту <RichText />. Він отримує значення атрибута та блок.

PHP
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. Кожен конструктор отримує розібрані атрибути та необроблений внутрішній вміст.

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

Сумісні фільтри blockstudio/block_tags/renderers і blockstudio/parser/renderers виконуються після цього хуку та можуть перевизначити те саме ім’я блоку.

blockstudio/block_tags/tag_aliases

Цей фільтр дає змогу реєструвати користувацькі теги авторингу з дефісами, які перед резервним варіантом для необробленого HTML перетворюються на справжні імена блоків. Це корисно, коли тема потребує стислого набору тегів для конкретного проєкту, але має відображати стандартні Blockstudio або основні блоки.

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

Цей фільтр дає змогу зіставляти скорочення префіксів з одним або кількома просторами імен блоків. Кожен ключ — це префікс у нижньому регістрі без дефісів. Значенням може бути рядок простору імен або впорядкований список просторів імен.

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> перетворюється на 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 в активній темі.

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

users/ids

Цей фільтр дає змогу ввімкнути редактор для певних ідентифікаторів користувачів.

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

users/roles

Цей фільтр дає змогу ввімкнути редактор для певних ролей користувачів.

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

assets/enqueue

Цей фільтр дає змогу вмикати й вимикати підключення ресурсів у зовнішній частині сайту та редакторі.

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

assets/reset/enabled

Цей фільтр дає змогу вмикати й вимикати видалення основних стилів блоків WordPress і скидання допоміжних стилів компонування редактора.

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

assets/reset/full_width

Цей фільтр дає змогу визначати, для яких типів записів використовувати редагування на всю ширину.

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

assets/minify/css

Цей фільтр дає змогу вмикати й вимикати мініфікацію CSS.

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

assets/minify/js

Цей фільтр дає змогу вмикати й вимикати мініфікацію JS.

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

assets/process/scss

Цей фільтр дає змогу вмикати й вимикати обробку SCSS у файлах .css.

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

assets/process/scss_files

Цей фільтр дає змогу вмикати й вимикати перетворення файлів .scss на CSS.

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

assets/output

Цей фільтр дає змогу визначати, куди записуються скомпільовані ресурси блоків.

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

assets/inline_limit

Фільтрує кількість байтів зовнішнього блочного CSS, які вбудовуються на сторінку.

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

cache/enabled

Цей фільтр дає змогу вмикати й вимикати всі файлові кеші середовища виконання та редактора для Blockstudio.

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

cache/path

Цей фільтр дає змогу змінити каталог файлового кешу Blockstudio.

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

cache/namespace_grace

Цей фільтр дає змогу визначити, як довго зберігати виведений з ужитку простір імен кешу, перш ніж його буде очищено.

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

githooks/commit

Цей фільтр надає інформацію про те, чи ввімкнено хук фіксації PHPStan, яким керує Blockstudio.

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

content/enabled

Цей фільтр дає змогу вмикати й вимикати синхронізацію вмісту.

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

content/id

Цей фільтр дає змогу задати простір імен власника для синхронізації вмісту.

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

content/path

Цей фільтр дає змогу задати каталог файлів для синхронізації вмісту.

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

content/include_page_sync_managed

Цей фільтр дає змогу включати керовані синхронізацією сторінок записи або виключати їх.

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

content/authors

Цей фільтр дає змогу налаштувати обробку авторів під час синхронізації вмісту.

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

content/post_types

Цей фільтр дає змогу налаштувати списки дозволених типів записів для синхронізації вмісту.

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

content/taxonomies

Цей фільтр дає змогу налаштувати списки дозволених таксономій для синхронізації вмісту.

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

content/media

Цей фільтр дає змогу налаштувати обробку медіафайлів під час синхронізації вмісту.

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

tailwind/enabled

Цей фільтр дає змогу вмикати й вимикати Tailwind.

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

tailwind/config

Цей фільтр дає змогу додати власну конфігурацію Tailwind CSS.

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

tailwind/output

Цей фільтр дає змогу вибрати вбудований або підключений Tailwind CSS для виведення.

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

ui/enabled

Цей фільтр дає змогу вмикати й вимикати вбудовані компоненти UI.

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

editor/format_on_save

Цей фільтр дає змогу вмикати й вимикати форматування коду під час збереження.

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

editor/assets

Цей фільтр дає змогу підключати додаткові ресурси в редакторі.

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

editor/markup

Цей фільтр дає змогу додати розмітку в кінець редактора.

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

block_editor/disable_loading

Цей фільтр дає змогу вимкнути завантаження блоків у Block Editor.

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

block_editor/enhance

Цей фільтр дає змогу ввімкнути зручності редактора Blockstudio, як-от чистіші стилі фокусу й контури під час наведення або вибору.

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

block_editor/css_classes

Цей фільтр дає змогу додати таблиці стилів, класи з яких можна буде вибирати в полі класу.

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

block_editor/css_variables

Цей фільтр дає змогу додати таблиці стилів, змінні CSS з яких будуть доступні для автодоповнення в полі коду.

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

block_editor/blocks/allow

Цей фільтр дає змогу визначати, які імена блоків дозволено використовувати у вставлячі.

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

block_editor/blocks/deny

Цей фільтр дає змогу вилучити імена блоків зі вставляча.

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

block_editor/blocks/directory

Цей фільтр дає змогу вмикати й вимикати ресурси каталогу блоків WordPress у редакторі.

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

block_editor/blocks/categories/allow

Цей фільтр дає змогу визначати, які ярлики категорій блоків залишити доступними.

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

block_editor/blocks/categories/deny

Цей фільтр дає змогу вилучити ярлики категорій блоків зі вставляча.

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

block_editor/blocks/categories/rename

Цей фільтр дає змогу перейменовувати назви категорій блоків за ярликом.

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

block_editor/blocks/categories/order

Цей фільтр дає змогу впорядкувати ярлики категорій блоків у вставлячі.

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

block_editor/blocks/styles/deny

Цей фільтр дає змогу скасувати реєстрацію стилів блоків, зареєстрованих через PHP, за іменем блоку.

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

Цей фільтр дає змогу приховати додаткові застарілі віджети від блоку застарілих віджетів.

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

block_editor/patterns/core

Цей фільтр дає змогу вмикати й вимикати основні шаблони блоків WordPress.

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

block_editor/patterns/remote

Цей фільтр дає змогу вмикати й вимикати віддалені шаблони з каталогу шаблонів WordPress.

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

block_editor/patterns/theme

Цей фільтр дає змогу вмикати й вимикати шаблони блоків, надані темою.

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

block_editor/patterns/blockstudio

Цей фільтр дає змогу вмикати й вимикати шаблони на основі файлів Blockstudio.

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

block_editor/patterns/categories/allow

Цей фільтр дає змогу визначати, які ярлики категорій шаблонів залишити доступними.

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

block_editor/patterns/categories/deny

Цей фільтр дає змогу вилучити ярлики категорій шаблонів зі вставляча шаблонів.

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

block_editor/patterns/categories/rename

Цей фільтр дає змогу перейменовувати назви категорій шаблонів за ярликом.

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

block_editor/patterns/categories/order

Цей фільтр дає змогу впорядкувати ярлики категорій шаблонів у вставлячі.

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

block_editor/media/openverse

Цей фільтр дає змогу вмикати й вимикати категорію медіафайлів Openverse у вставлячі медіафайлів редактора блоків.

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

block_editor/media/image_sizes/allow

Цей фільтр дає змогу визначати, які назви розмірів зображень залишити доступними в елементах керування медіафайлами редактора.

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

block_editor/media/image_sizes/deny

Цей фільтр дає змогу вилучити назви розмірів зображень з елементів керування медіафайлами редактора.

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

ai/enable_context_generation

Цей фільтр дає змогу вмикати й вимикати створення файлу контексту для інтеграції з інструментами LLM. Коли цю функцію ввімкнено, файл контексту об’єднує актуальні дані блоків, налаштування Blockstudio поточної інсталяції, усі відповідні схеми та документацію Blockstudio в єдине джерело для інструментів розробки на основі ШІ.

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

block_tags/enabled

Цей фільтр дає змогу вмикати й вимикати відображення тегів блоків на рівні сторінки.

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

block_tags/prefixes

Цей фільтр дає змогу реєструвати скорочення для зіставлення префіксів із просторами імен тегів блоків.

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

dev/grab/enabled

Цей фільтр дає змогу вмикати й вимикати захоплювач елементів.

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

dev/perf

Цей фільтр дає змогу вмикати й вимикати профілювальник продуктивності.

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

dev/canvas/enabled

Цей фільтр дає змогу вмикати й вимикати полотно.

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

dev/canvas/admin_bar

Цей фільтр дає змогу показувати й приховувати панель адміністратора WordPress на полотні.

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

WPML

blockstudio/wpml/config/label

Фільтрує мітку кожного ключа, який записує wp bs wpml config. Контекстний масив див. у розділі Зміна міток.

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

Полотно

blockstudio/canvas/inventory

Цей фільтр змінює перелік, який Canvas повертає для вибраного елемента. Функція зворотного виклику отримує DTO переліку, початковий вибір і передані їй параметри.

PHP
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

Цей фільтр визначає, що синхронізація вмісту робить із записом, для якого більше немає джерела.

Bootstrap

blockstudio/url

Цей фільтр змінює загальнодоступний URL, який використовується редактором і адміністративними ресурсами Blockstudio. Інтеграції Composer мають зареєструвати його до завантаження файлу автозавантаження Blockstudio. Другий аргумент — це фізичний каталог пакета.

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

Кеш середовища виконання

blockstudio/cache/dir

Цей фільтр отримує визначений базовий каталог кешу, перш ніж до нього буде додано середовище виконання, ресурси редактора або іншу область кешу.

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

blockstudio/cache/context

Цей фільтр додає до ідентифікаторів кешу серіалізований варіант середовища виконання. Використовуйте його, коли те саме джерело виявлення може вибирати різні логічні переліки.

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

Цей фільтр змінює ідентифікатор каталогу мережі/блогу для вузлів із власною межею орендаря. Повернене значення очищується перед використанням.

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

Цей фільтр додає факти про вузол, які впливають на кожен об’єкт в області середовища виконання. Відбитки джерел для окремих елементів слід передавати як явні залежності через відповідний API.

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

Фільтр задає кількість секунд, протягом яких можна повторно використовувати перевірений знімок спостереження за файлами без повторної перевірки стану файлової системи. За замовчуванням це 0 у локальних середовищах і середовищах розробки та 20 в інших.

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

blockstudio/cache/build_wait_budget

Фільтр задає, скільки мілісекунд запит очікує на публікацію кешу середовища виконання паралельним процесом або оновлення заповнених варіантів, перш ніж перейти до спрощеного режиму. За замовчуванням це 5000 для структурних перебудов і 4000 для оновлення варіантів.

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

blockstudio/cache/populate_debounce

Фільтр задає, за скільки секунд пакетний запис вмісту, термінів, користувачів або метаданих об’єднується в одне оновлення заповнених варіантів. Перший запис після періоду бездіяльності запускає оновлення одразу; останній запис пакета враховується після завершення інтервалу. За замовчуванням це 30. Поверніть 0, щоб оновлювати після кожного запису.

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

blockstudio/cache/populate_ignored_meta_keys

Фільтрує метаключі, зміни яких ніколи не оновлюють заповнені варіанти. За замовчуванням це ключі, які WordPress записує для відстеження редагувань і входів у систему: _edit_lock, які редактор і Heartbeat оновлюють, поки допис відкрито; _edit_last, які записуються під час збереження допису, що вже запускає оновлення; та session_tokens, які записуються під час входу й виходу із системи. Додайте ключі, що часто змінюються, але ніколи не впливають на запит заповнення.

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

blockstudio/cache/max_files_per_scope

Фільтр задає кількість опублікованих корисних даних, які зберігає кожна область кешу середовища виконання.

PHP
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 може кешувати цільовий файл. Інші процеси, виключені файли та більший корисний вміст використовують стиснення.

PHP
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 додає до них кожен файл, на який посилається встановлена карта раннього обслуговування.

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

Ця дія повідомляє про спільну область кешу та результат, як-от hit, build, miss-stale, stale-last-good або 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

Цей фільтр отримує остаточне рішення щодо безпеки для анонімних користувачів, а також дані сервера й файлів cookie. Якщо повернути true, статичне обслуговування та генерування завжди оминаються.

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

Цей фільтр надає або змінює повний загальнодоступний перелік URL, який використовують планувальник попереднього прогрівання та явні інструменти для роботи з графами.

PHP
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, зберігаються разом із документом.

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

Ця дія ухвалює остаточне рішення після того, як Blockstudio перевіряє, що результатом є повний документ HTML без маркера заборони кешування, а отриманий статус відповіді є успішним. Третій аргумент — це отриманий статус або null, якщо статус не було визначено.

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

Ця дія повідомляє про результати статичного попереднього рендерингу, зокрема про влучання та промахи кешу, записи, записи графів, застарілі записи й помилки.

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

blockstudio/tailwind/cache_max_files

Фільтр задає максимальну кількість скомпільованих записів Tailwind CSS. За замовчуванням — 1000.

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

blockstudio/tailwind/cache_max_age

Фільтр задає максимальний вік скомпільованих записів Tailwind CSS у секундах. За замовчуванням — 30 днів, мінімум — одна година.

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

Адміністрування

Увімкнено

Цей фільтр дає змогу вмикати й вимикати адміністративну сторінку Blockstudio у розділі Інструменти > Blockstudio.

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

Ресурси

editor/canvas/body_class

Коли скидання ресурсів увімкнено, цей фільтр змінює очищені класи тіла сторінки, скопійовані на полотно редактора блоків.

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

Увімкнути

Цей фільтр дає змогу вимкнути обробку та підключення ресурсів певного типу.

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

Вимкнути

Цей фільтр дає змогу вимикати певні ресурси за їхніми ідентифікаторами. Ресурси, чиї ідентифікатори є в повернутому масиві, не відображатимуться на зовнішній частині сайту.

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

process/scss/import_paths

Цей фільтр дає змогу додати додаткові шляхи до інструкції @import компілятора SCSS.

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

process/scss/prelude

Цей фільтр дає змогу додавати спільний код Sass перед компіляцією кожного файлу 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

Цей фільтр дає змогу змінити вміст файлу CSS перед компіляцією.

PHP
add_filter('blockstudio/assets/process/css/content', function($content, $block) {
  return str_replace('old-class', 'new-class', $content);
}, 10, 2);

process/js/content

Цей фільтр дає змогу змінити вміст файлу JS перед компіляцією.

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

Буфер

Увімкнено

Blockstudio буферизує відповідь зовнішньої частини сайту, щоб теги стилів блоків і скриптів, відрендерені в тілі сторінки, можна було перенести в head і footer, а Tailwind міг просканувати весь документ. Буферизація означає, що весь документ утримується в пам’яті та сканується під час кожного запиту до зовнішньої частини сайту. Сайт, який не рендерить ресурсів блоків Blockstudio і не використовує Tailwind, може повернути false, щоб пропустити обидві операції.

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

Буферизація також вимкнена в адмінпанелі та попередньому перегляді Customizer. Викличте bs_is_buffering() з wp_enqueue_scripts або пізніше, щоб дізнатися, чи буферизується поточна відповідь. До ухвалення рішення на етапі template_redirect ця функція повертає false.

Вивід

Цей фільтр отримує весь буферизований документ HTML перед надсиланням. Власне перенесення ресурсів Blockstudio виконується з пріоритетом 1000000, а компіляція Tailwind — з пріоритетом 999999, тож запустіть фільтр раніше, щоб побачити документ до цих операцій, або пізніше, щоб побачити остаточний результат.

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

Рендеринг

Залежності

Цей фільтр повідомляє про вибрані шаблон і залежності ресурсів щоразу, коли Blockstudio рендерить блок. Він стане в пригоді для експортувальників статики та інших засобів збирання залежностей у межах процесу.

PHP
add_filter(
  'blockstudio/render/dependencies',
  function($paths, $name, $block, $isEditor, $isPreview) {
    my_dependency_graph()->add($name, $paths);
    return $paths;
  },
  10,
  5
);

глобальний

Цей фільтр дає змогу змінити вивід сторінки перед рендерингом.

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

Цей фільтр дає змогу коригувати виведення тегу <head> перед його рендерингом. Він запускається лише тоді, коли Blockstudio буферизує відповідь; див. bs_is_buffering().

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

Цей фільтр дає змогу змінити вивід </body> перед рендерингом.

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

Обробка помилок

error/logged

Дія виконується після реєстрації помилки. Використовуйте її, щоб надсилати помилки до зовнішніх сервісів журналювання.

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

error/exception

Дія виконується після обробки винятку.

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

База даних

Усі хуки бази даних отримують один масив $params.

db/before_create

Дія виконується перед створенням запису.

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

db/after_create

Дія виконується після створення запису.

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

Дія виконується перед оновленням запису.

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

db/after_update

Дія виконується після оновлення запису.

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

db/before_delete

Дія виконується перед видаленням запису.

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

db/after_delete

Дія виконується після видалення запису.

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

RPC

Усі хуки RPC отримують один масив $params.

rpc/before_call

Дія виконується перед викликом функції RPC.

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

rpc/after_call

Дія виконується після виклику функції RPC.

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