Przejdź do treści

Hooki PHP

Poniżej znajduje się lista wszystkich dostępnych hooków PHP, które można wykorzystać do rozszerzenia lub zmiany funkcjonalności wtyczki.

Ścieżka

Ten filtr pozwala zmienić ścieżkę katalogu bloku. Domyślnie znajduje się on blockstudio w aktywnym motywie. Możesz też utworzyć nową instancję, aby używać wielu katalogów źródłowych.

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

Inicjalizacja

globalna

Ta akcja jest wywoływana po zarejestrowaniu przez wtyczkę wszystkich bloków.

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

instancja

Ta akcja jest wywoływana po zarejestrowaniu przez wtyczkę wszystkich bloków danej instancji. Segment $instance to ścieżka instancji względna względem 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

Ta akcja jest wywoływana przed zarejestrowaniem przez wtyczkę wszystkich bloków.

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

global/before/$instance

Ta akcja jest wywoływana przed zarejestrowaniem przez wtyczkę wszystkich bloków danej instancji.

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

Bloki

renderowanie

Ten filtr pozwala zmienić wynik renderowania bloku.

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

metadane

Ten filtr pozwala zmienić dane pliku block.json przed jego rejestracją.

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

Powyższy kod zmieni ikonę wszystkich bloków, których nazwa zaczyna się od marketing.

warunki

Ten filtr pozwala dodawać własne warunki, których można używać w blokach. Każdy typ warunku jest powiązany z wartością, którą edytor porównuje z value warunku. Zobacz Warunki niestandardowe.

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

atrybuty

Ten filtr modyfikuje definicję pola przed zarejestrowaniem bloku. Przefiltrowana definicja określa ustawienie kontrolki edytora oraz walidację wartości podczas renderowania. Więcej informacji znajdziesz w sekcji Filtrowanie.

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

attributes/render

Ten filtr modyfikuje wartość jednego pola przed przekazaniem jej do szablonu bloku. Uruchamia się raz dla każdego pola i otrzymuje trzy argumenty: $value (rozwiązaną wartość), $key (klucz pola używany w $a) oraz $block (tablicę danych bloku, którą szablony otrzymują jako $block lub $b). Zarejestruj go, podając trzy akceptowane argumenty. Więcej informacji znajdziesz w sekcji Filtrowanie.

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

Pole files zwraca każdy obraz wraz z tablicą sizes zawierającą URL, szerokość i wysokość full oraz każdego zarejestrowanego rozmiaru obrazu, na przykład $image['sizes']['thumbnail'] i $image['sizes']['thumbnail-width']. Każdy rozmiar wymaga jednego wywołania wp_get_attachment_image_src() na obraz, więc filtry nadal mają zastosowanie. Szablony, które nigdy nie odczytują sizes, mogą usunąć tę listę lub ją skrócić.

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 to lista nazw rozmiarów, zaczynająca się od full (pusta, jeśli nie zarejestrowano rozmiarów pośrednich). $id to identyfikator załącznika, a $size to rozmiar żądany dla wartości url. Filtr zmienia tablicę sizes każdej wartości files w żądaniu. Bez niego tablica pozostaje niezmieniona.

Zwraca nazwy rozmiarów jako ciągi znaków. Nieprawidłowe wpisy są ignorowane, a powtarzające się nazwy rozpatrywane tylko raz. Wartość zwrotna, która nie jest tablicą, pomija rozmiary. Żądane url i pozostałe właściwości załącznika pozostają bez zmian. Ten hook nie jest uruchamiany dla pola plików z returnFormat: "url", które nie tworzy mapy rozmiarów.

attributes/validate

Dostosuj wyniki jawnych bs_validate_block()wywołań, na przykład gdy niestandardowy filtr renderowania rozwiązuje zapisane odwołania. Nie włącza to automatycznej walidacji podczas zapisywania ani renderowania.

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

Zwraca listę wyników. Filtr nie jest wywoływany, gdy blok nie ma pól Blockstudio ani pasujących rozszerzeń (null).

attributes/schema

Dostosuj schemat JSON zwracany przez bs_block_schema(), na przykład gdy niestandardowy filtr renderowania rozwiązuje zapisane referencje.

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

Zwróć tablicę schematu. Filtr nie jest wywoływany, gdy blok nie ma pól Blockstudio ani pasujących rozszerzeń (null).

attributes/populate

Ten filtr pozwala dodać niestandardowe dane do opcji pola checkbox, select lub radio. Więcej informacji znajdziesz w sekcji Wypełnianie opcji.

Filtr otrzymuje jeden argument: tablicę wszystkich niestandardowych zestawów danych, z kluczami będącymi nazwami użytymi w "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

Ten filtr pozwala zmienić wynik renderowania treści useBlockProps.

Wszystkie filtry komponentów (use_block_props, inner_blocks i rich_text) otrzymują blok jako ostatni argument. $block to WP_Block_Type zarejestrowany dla renderowanego bloku, więc $block->name jest nazwą bloku, na przykład acme/hero.

$props jest ciągiem znaków zawierającym atrybuty HTML, a nie tablicą. Na frontendzie jest wynikiem get_block_wrapper_attributes(), na przykład class="wp-block-acme-hero my-class". W edytorze jest atrybutem class elementu. Zwraca ciąg znaków. W edytorze stosowany jest tylko atrybut class zwróconego ciągu.

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

Ten filtr pozwala zmienić wynik renderowania treści <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

Ten filtr pozwala usunąć z frontendu otoczkę <InnerBlocks />.

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

components/rich_text/render

Ten filtr pozwala dostosować zawartość <RichText />. Otrzymuje wartość atrybutu i blok.

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

Tagi bloków

blockstudio/block_tags/builders

Ten filtr rejestruje konstruktory tablic bloków używane przez tagi bloków oraz bloki niestandardowe wybrane przez blockstudio/parser/element_mapping. Każdy konstruktor otrzymuje sparsowane atrybuty i surową zawartość wewnętrzną.

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

Zgodne filtry blockstudio/block_tags/renderers i blockstudio/parser/renderers są uruchamiane po tym hooku i mogą zastąpić nazwę tego samego bloku.

blockstudio/block_tags/tag_aliases

Ten filtr pozwala rejestrować niestandardowe tagi autorskie z łącznikiem, które przed użyciem surowego mechanizmu awaryjnego HTML są mapowane na rzeczywiste nazwy bloków. Przydaje się, gdy motyw ma udostępniać zwięzły zestaw tagów specyficznych dla projektu, zachowując jednocześnie możliwość renderowania standardowych bloków Blockstudio lub bloków rdzenia.

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

Ten filtr pozwala mapować skróty prefiksów na jedną lub więcej przestrzeni nazw bloków. Każdy klucz to mały prefiks bez łączników. Wartością może być ciąg znaków z przestrzenią nazw lub uporządkowana lista przestrzeni nazw.

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> jest mapowane na theme-components/card. <theme-button> najpierw sprawdza theme-components/button, a następnie wraca do bsui/button. Jawne wpisy blockstudio/block_tags/tag_aliases mają pierwszeństwo dla tego samego tagu, a nierozpoznane tagi z prefiksem pozostają bez zmian.

Prefiksy można łączyć: jeśli tag z prefiksem nie zostanie bezpośrednio rozpoznany, a jego slug jest zarejestrowanym tagiem prefiksu, rozpoznawanie jest kontynuowane rekurencyjnie. Przy użyciu theme => ['theme-components'] i ui => ['bsui'] tag <theme-ui-input> przechodzi do prefiksu ui i zostaje rozpoznany jako bsui/input. Zarejestrowane tagi prefiksów i aliasów są renderowane także w wyniku szablonu bloku, a nie tylko w treści strony.

Ustawienia

ścieżka

Ten filtr pozwala zmienić ścieżkę pliku blockstudio.json. Domyślnie znajduje się on pod adresem blockstudio.json w aktualnie aktywnym motywie.

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

users/ids

Ten filtr pozwala włączyć edytor dla określonych identyfikatorów użytkowników.

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

users/roles

Ten filtr pozwala włączyć edytor dla określonych ról użytkowników.

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

assets/enqueue

Ten filtr pozwala włączyć lub wyłączyć dodawanie zasobów do kolejki w interfejsie i edytorze.

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

assets/reset/enabled

Ten filtr pozwala włączyć lub wyłączyć usuwanie stylów bloków rdzenia WordPress oraz resetu układu narzędzi edytora.

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

assets/reset/full_width

Ten filtr pozwala określić, które typy wpisów używają edycji na pełną szerokość.

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

assets/minify/css

Ten filtr pozwala włączyć lub wyłączyć minifikację CSS.

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

assets/minify/js

Ten filtr pozwala włączyć lub wyłączyć minifikację JS.

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

assets/process/scss

Ten filtr pozwala włączyć lub wyłączyć przetwarzanie SCSS w plikach .css.

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

assets/process/scss_files

Ten filtr pozwala włączyć lub wyłączyć przetwarzanie plików .scss do postaci CSS.

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

assets/output

Ten filtr pozwala określić, gdzie zapisywane są skompilowane zasoby bloków.

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

assets/inline_limit

Filtruje liczbę bajtów zewnętrznego bloku CSS wstawianych bezpośrednio na stronę.

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

cache/enabled

Ten filtr pozwala włączyć lub wyłączyć wszystkie oparte na plikach pamięci podręczne środowiska uruchomieniowego i zasobów edytora Blockstudio.

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

cache/path

Ten filtr pozwala zmienić katalog pamięci podręcznej Blockstudio opartej na plikach.

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

cache/namespace_grace

Ten filtr pozwala zmienić czas przechowywania wycofanej przestrzeni nazw pamięci podręcznej przed jej usunięciem.

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

githooks/commit

Ten filtr udostępnia informację, czy hook commitowania PHPStan należący do Blockstudio jest włączony.

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

content/enabled

Ten filtr pozwala włączyć lub wyłączyć synchronizację treści.

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

content/id

Ten filtr pozwala ustawić przestrzeń nazw właściciela synchronizacji treści.

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

content/path

Ten filtr pozwala ustawić katalog plików synchronizacji treści.

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

content/include_page_sync_managed

Ten filtr pozwala uwzględniać wpisy zarządzane przez synchronizację stron lub je wykluczać.

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

content/authors

Ten filtr pozwala skonfigurować obsługę autorów przez synchronizację treści.

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

content/post_types

Ten filtr pozwala skonfigurować listy dozwolonych typów wpisów dla synchronizacji treści.

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

content/taxonomies

Ten filtr pozwala skonfigurować listy dozwolonych taksonomii dla synchronizacji treści.

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

content/media

Ten filtr pozwala skonfigurować obsługę mediów przez synchronizację treści.

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

tailwind/enabled

Ten filtr pozwala włączyć lub wyłączyć Tailwind.

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

tailwind/config

Ten filtr pozwala dodać niestandardową konfigurację Tailwind CSS.

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

tailwind/output

Ten filtr pozwala wybrać wynik Tailwind CSS wbudowany lub dołączony jako plik.

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

ui/enabled

Ten filtr pozwala włączyć lub wyłączyć dołączone komponenty UI.

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

editor/format_on_save

Ten filtr pozwala włączyć lub wyłączyć formatowanie kodu podczas zapisywania.

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

editor/assets

Ten filtr pozwala dodać do kolejki dodatkowe zasoby w edytorze.

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

editor/markup

Ten filtr pozwala dodać dodatkowe znaczniki na końcu edytora.

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

block_editor/disable_loading

Ten filtr pozwala wyłączyć ładowanie bloków w edytorze bloków.

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

block_editor/enhance

Ten filtr pozwala włączyć ułatwienia edytora Blockstudio, takie jak czytelniejsze style fokusu oraz obrysy po najechaniu i zaznaczeniu.

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

block_editor/css_classes

Ten filtr pozwala dodać arkusze stylów, których klasy będą dostępne do wyboru w polu klasy.

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

block_editor/css_variables

Ten filtr pozwala dodać arkusze stylów, których zmienne CSS będą dostępne do autouzupełniania w polu kodu.

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

block_editor/blocks/allow

Ten filtr pozwala określić, które nazwy bloków są dozwolone w inserterze.

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

block_editor/blocks/deny

Ten filtr pozwala usunąć nazwy bloków z insertera.

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

block_editor/blocks/directory

Ten filtr pozwala włączyć lub wyłączyć zasoby katalogu bloków WordPress w edytorze.

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

block_editor/blocks/categories/allow

Ten filtr pozwala określić, które slugi kategorii bloków pozostają dostępne.

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

block_editor/blocks/categories/deny

Ten filtr pozwala usunąć slugi kategorii bloków z insertera.

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

block_editor/blocks/categories/rename

Ten filtr pozwala zmienić etykiety kategorii bloków według sluga.

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

block_editor/blocks/categories/order

Ten filtr pozwala ustawić kolejność slugów kategorii bloków w inserterze.

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

block_editor/blocks/styles/deny

Ten filtr pozwala wyrejestrować style bloków zarejestrowane przez PHP, według nazwy bloku.

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

Ten filtr pozwala ukryć dodatkowe starsze widżety w bloku starszych widżetów.

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

block_editor/patterns/core

Ten filtr pozwala włączyć lub wyłączyć wzorce bloków rdzenia WordPress.

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

block_editor/patterns/remote

Ten filtr pozwala włączyć lub wyłączyć zdalne wzorce z katalogu wzorców WordPress.

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

block_editor/patterns/theme

Ten filtr pozwala włączyć lub wyłączyć wzorce bloków udostępniane przez motyw.

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

block_editor/patterns/blockstudio

Ten filtr pozwala włączyć lub wyłączyć wzorce oparte na plikach Blockstudio.

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

block_editor/patterns/categories/allow

Ten filtr pozwala określić, które slugi kategorii wzorców pozostają dostępne.

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

block_editor/patterns/categories/deny

Ten filtr pozwala usunąć slugi kategorii wzorców z insertera wzorców.

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

block_editor/patterns/categories/rename

Ten filtr pozwala zmienić etykiety kategorii wzorców według sluga.

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

block_editor/patterns/categories/order

Ten filtr pozwala ustawić kolejność slugów kategorii wzorców w inserterze.

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

block_editor/media/openverse

Ten filtr pozwala włączyć lub wyłączyć kategorię mediów Openverse w inserterze mediów edytora bloków.

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

block_editor/media/image_sizes/allow

Ten filtr pozwala określić, które nazwy rozmiarów obrazów pozostają dostępne w kontrolkach mediów edytora.

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

block_editor/media/image_sizes/deny

Ten filtr pozwala usunąć nazwy rozmiarów obrazów z kontrolek mediów edytora.

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

ai/enable_context_generation

Ten filtr pozwala włączyć lub wyłączyć generowanie pliku kontekstu na potrzeby integracji z narzędziami LLM. Po włączeniu plik kontekstu zbiera aktualne dane bloków, ustawienia Blockstudio bieżącej instalacji, wszystkie odpowiednie schematy i dokumentację Blockstudio w jednym źródle dla narzędzi programistycznych AI.

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

block_tags/enabled

Ten filtr pozwala włączyć lub wyłączyć renderowanie tagów bloków na poziomie strony.

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

block_tags/prefixes

Ten filtr pozwala rejestrować skróty mapujące prefiksy na przestrzenie nazw dla tagów bloków.

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

dev/grab/enabled

Ten filtr pozwala włączyć lub wyłączyć chwytak elementów.

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

dev/perf

Ten filtr pozwala włączyć lub wyłączyć profiler wydajności.

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

dev/canvas/enabled

Ten filtr pozwala włączyć lub wyłączyć kanwę.

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

dev/canvas/admin_bar

Ten filtr pozwala wyświetlić lub ukryć pasek administracyjny WordPress na kanwie.

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

WPML

blockstudio/wpml/config/label

Filtruje etykietę każdego klucza zapisywanego przez wp bs wpml config. Informacje o tablicy kontekstu znajdziesz w sekcji Zmienianie etykiet.

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

Kanwa

blockstudio/canvas/inventory

Ten filtr modyfikuje zestawienie zgłaszane przez kanwę dla danego zaznaczenia. Funkcja zwrotna otrzymuje obiekt DTO zestawienia, pierwotne zaznaczenie oraz użyte opcje.

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

blockstudio/canvas/documents

Ten filtr modyfikuje dokumenty zwracane przez kanwę po renderowaniu; otrzymuje te same trzy argumenty co filtr zestawienia.

blockstudio/canvas/item_loaded

Ta akcja jest wywoływana dla każdego rekordu zestawienia podczas jego wczytywania. Otrzymuje typ zestawienia, kanoniczny identyfikator rekordu i znormalizowany rekord.

blockstudio/canvas/source_compiled

Ta akcja jest wywoływana po skompilowaniu pliku źródłowego na potrzeby kanwy. Otrzymuje wybraną ścieżkę źródłową i kanoniczny rekord źródła.

Dołączone UI

blockstudio/ui/directories

Ten filtr modyfikuje katalogi skanowane w poszukiwaniu dołączonych komponentów UI.

blockstudio/ui/inventory

Ten filtr modyfikuje publiczne zestawienie rodzin UI.

blockstudio/ui/examples

Ten filtr modyfikuje przykładowe rekordy UI, otrzymując przykłady i publiczne zestawienie UI, z którego je utworzono.

Topologia

blockstudio/blocks/topology_refreshed

Ta akcja jest wywoływana po przebudowaniu topologii bloków.

blockstudio/pages/topology_refreshed

Ta akcja jest wywoływana po przebudowaniu topologii stron.

blockstudio/pages/layout_error

Ta akcja jest wywoływana, gdy układ strony nie może zostać wyrenderowany, zamiast zakończyć się bez komunikatu.

Środowisko uruchomieniowe

blockstudio/runtime/initialized

Ta akcja jest wywoływana po ustaleniu konfiguracji środowiska uruchomieniowego.

blockstudio/runtime/changed

Ta akcja jest wywoływana, gdy zmienia się ustalona tożsamość środowiska uruchomieniowego, co powoduje zmianę przestrzeni nazw pamięci podręcznej i stanu wstępnego renderowania statycznego.

blockstudio/performance/default_config

Ten filtr modyfikuje domyślne ustawienia wydajności, zanim zostaną nałożone wartości projektu blockstudio.json.

Treść

blockstudio/content/orphan_action

Ten filtr określa, co synchronizacja treści robi z rekordem, który nie ma już źródła.

Bootstrap

blockstudio/url

Ten filtr zmienia publiczną ścieżkę URL używaną przez edytor i zasoby administracyjne Blockstudio. Integracje Composer muszą ją zarejestrować przed załadowaniem pliku autoload Blockstudio. Drugi argument to fizyczny katalog pakietu.

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

Pamięć podręczna środowiska uruchomieniowego

blockstudio/cache/dir

Ten filtr otrzymuje bazowy katalog pamięci podręcznej po jego ustaleniu, zanim zostanie do niego dodany zakres środowiska uruchomieniowego, zasobów edytora lub innej pamięci podręcznej.

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

blockstudio/cache/context

Ten filtr dodaje serializowalny wariant środowiska uruchomieniowego do identyfikatorów pamięci podręcznej. Użyj go, gdy to samo źródło wykrywania może wybrać różne logiczne zestawienia.

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

Ten filtr zmienia tożsamość katalogu sieci lub bloga w przypadku hostów z własną granicą dzierżawcy. Zwrócona wartość jest oczyszczana przed użyciem.

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

Ten filtr dodaje dane o hoście, które wpływają na każdy obiekt w zakresie środowiska uruchomieniowego. Odciski źródeł specyficzne dla elementu należy zamiast tego przekazywać jako jawne zależności właścicielowi 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

Filtruje liczbę sekund, przez które zweryfikowany zrzut stanu obserwatora plików może być ponownie używany bez kolejnego sprawdzenia stanu systemu plików. Wartość domyślna to 0 w środowiskach lokalnych i deweloperskich oraz 20 w pozostałych.

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

blockstudio/cache/build_wait_budget

Filtruje czas w milisekundach, przez jaki żądanie czeka na opublikowanie pamięci podręcznej środowiska uruchomieniowego przez równoległy proces budujący lub odświeżenie wypełnionych opcji, zanim przejdzie do trybu ograniczonego. Wartość domyślna to 5000 dla przebudów strukturalnych i 4000 dla odświeżania opcji.

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

blockstudio/cache/populate_debounce

Filtruje liczbę sekund, przez które seria zapisów treści, terminów, użytkowników lub metadanych jest łączona w jedno odświeżenie wypełnionych opcji. Pierwszy zapis po okresie bezczynności powoduje natychmiastowe odświeżenie; ostatni zapis z serii zostaje uwzględniony po upływie tego czasu. Wartość domyślna to 30. Zwróć 0, aby odświeżać po każdym zapisie.

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

blockstudio/cache/populate_ignored_meta_keys

Filtruje klucze meta, których zapis nigdy nie odświeża wypełnionych opcji. Domyślnie są to klucze, które WordPress zapisuje w ramach edycji i obsługi logowania: _edit_lock, odświeżane przez edytor i mechanizm Heartbeat, gdy wpis jest otwarty, _edit_last, zapisywane razem z zapisem wpisu, który już powoduje odświeżenie, oraz session_tokens, zapisywane przy logowaniu i wylogowywaniu. Dodaj klucze, które często się zmieniają, ale nigdy nie wpływają na zapytanie wypełniające opcje.

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

blockstudio/cache/max_files_per_scope

Filtruje maksymalną liczbę opublikowanych ładunków danych przechowywanych w każdym zakresie pamięci podręcznej środowiska uruchomieniowego.

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

blockstudio/cache/compress

Filtruje, czy dane ładunku pamięci podręcznej są skompresowane i serializowane zamiast zapisane jako zwykła tablica PHP. Domyślnie format zwykły jest używany tylko dla ładunków o rozmiarze do 1 MiB i tylko wtedy, gdy aktywna pamięć współdzielona OPcache może buforować lokalizację docelową. Inne procesy, wykluczone pliki i większe ładunki są kompresowane.

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

Zwrócenie false omija również ograniczenie rozmiaru. Może to być przydatne, gdy WP-CLI bez opcache.enable_cli wstępnie ładuje pliki dla procesów roboczych serwera WWW z włączonym OPcache, ale każdy czytelnik bez OPcache będzie analizować wygenerowaną tablicę. Duże współdzielone ładunki kompresuj, chyba że akceptujesz dodatkowe zużycie pamięci. Domyślne zabezpieczenia opisano w sekcji formaty ładunków pamięci podręcznej.

blockstudio/cache/protected_paths

Przycinanie retencji ścieżek pamięci podręcznej nie może ich usuwać. Blockstudio wypełnia ją wszystkimi plikami wskazanymi przez zainstalowaną mapę wczesnej obsługi żądań.

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

Ta akcja zgłasza wspólny zakres pamięci podręcznej i wynik, taki jak hit, build, miss-stale, stale-last-good lub 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

Ten filtr otrzymuje ostateczną decyzję dotyczącą anonimowego bezpieczeństwa oraz dane serwera i plików cookie. Zwrócenie true zawsze pomija statyczne serwowanie i generowanie.

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

Ten filtr udostępnia lub modyfikuje pełne publiczne zestawienie URL używane przez zaplanowany proces wstępnego napełniania pamięci podręcznej i jawne narzędzia grafu.

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

Wynik zwracany przez filtr nie jest ostatecznym zestawieniem. Przechodzi przez etap sprawdzania możliwości buforowania, który usuwa elementy pasujące do skonfigurowanej ścieżki dynamicznej oraz domyślnie pomijane: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, każdą ścieżkę zawierającą /feed/ oraz wyniki wyszukiwania w obrębie ścieżki bazowej wyszukiwania pod główną ścieżką witryny (domyślnie /search/). Dodany przez Ciebie element URL może więc zostać odrzucony bez ostrzeżenia. Jeśli oczekiwana trasa nie występuje w zbudowanym zestawieniu, sprawdź ją pod kątem tych reguł, zanim uznasz, że filtr się nie uruchomił.

blockstudio/static_prerender/render_internal

Ten filtr implementuje opcjonalny transport wsadowy w tym samym procesie. Zwróć znormalizowaną tablicę wyników albo pozostaw wartość bez zmian, aby renderer użył skonfigurowanego fallbacku HTTP. Wynik zawiera html oraz opcjonalnie status, dependencies, virtualHashes i headers; nagłówki wymienione w performance.staticPrerender.replayHeaders są zapisywane wraz z dokumentem.

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

Ten filtr podejmuje ostateczną decyzję po sprawdzeniu przez Blockstudio, czy wynik jest kompletnym dokumentem HTML bez znacznika braku pamięci podręcznej oraz czy zaobserwowany status odpowiedzi oznacza powodzenie. Trzeci argument to zaobserwowany status lub null, jeśli statusu nie podano.

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

Ta akcja zgłasza wyniki wstępnego renderowania statycznego, w tym trafienia, chybienia, zapisy, zapisy grafu, nieaktualne wpisy i błędy.

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

blockstudio/tailwind/cache_max_files

Filtruje maksymalną liczbę skompilowanych wpisów Tailwind CSS. Wartość domyślna to 1000.

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

blockstudio/tailwind/cache_max_age

Filtruje maksymalny wiek skompilowanych wpisów Tailwind CSS w sekundach. Wartość domyślna to 30 dni, a minimalna to jedna godzina.

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

Administracja

włączone

Ten filtr pozwala włączyć lub wyłączyć stronę administracyjną Blockstudio w menu Narzędzia > Blockstudio.

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

Zasoby

editor/canvas/body_class

Gdy reset zasobów jest włączony, ten filtr modyfikuje oczyszczone klasy elementu body z interfejsu, kopiowane do kanwy edytora bloków.

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

włącz

Ten filtr pozwala wyłączyć przetwarzanie i dodawanie do kolejki zasobów określonego typu.

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

wyłącz

Ten filtr pozwala wyłączyć określone zasoby według ich identyfikatora. Zasoby, których identyfikator znajduje się w zwróconej tablicy, nie będą renderowane w interfejsie.

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

process/scss/import_paths

Ten filtr pozwala dodać dodatkowe ścieżki do instrukcji @import kompilatora SCSS.

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

process/scss/prelude

Ten filtr pozwala dodać współdzielony kod Sass przed kompilacją każdego pliku 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

Ten filtr pozwala zmienić zawartość pliku CSS przed jego kompilacją.

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

process/js/content

Ten filtr pozwala zmienić zawartość pliku JS przed jego kompilacją.

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

Buforowanie

włączone

Blockstudio buforuje odpowiedź interfejsu, aby znaczniki stylów i skryptów bloków wyrenderowane wewnątrz elementu body można było przenieść do head i stopki, a Tailwind mógł przeskanować cały dokument. Buforowanie oznacza przechowywanie i skanowanie całego dokumentu przy każdym żądaniu interfejsu. Witryna, która nie renderuje żadnych zasobów bloków Blockstudio i nie używa Tailwind, może zwrócić false, aby pominąć oba działania.

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

Buforowanie jest również wyłączone w panelu administracyjnym i podglądzie Personalizatora. Wywołaj bs_is_buffering() z wp_enqueue_scripts lub później, aby sprawdzić, czy bieżąca odpowiedź jest buforowana. Zwraca false, zanim decyzja zostanie podjęta w template_redirect.

wynik

Ten filtr otrzymuje kompletny, zbuforowany dokument HTML przed jego wysłaniem. Własne przenoszenie zasobów Blockstudio działa z priorytetem 1000000, a kompilacja Tailwind z priorytetem 999999. Uruchom filtr wcześniej, aby zobaczyć dokument przed tymi operacjami, albo później, aby zobaczyć wynik końcowy.

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

Renderowanie

zależności

Ten filtr zgłasza wybrany szablon i zależności zasobów za każdym razem, gdy Blockstudio renderuje blok. Przydaje się w eksporterach statycznych i innych narzędziach zbierających zależności w procesie.

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

globalna

Ten filtr pozwala zmienić wynik strony przed renderowaniem.

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

Ten filtr pozwala dostosować wynik tagu <head> przed jego wyrenderowaniem. Jest uruchamiany tylko wtedy, gdy Blockstudio buforuje odpowiedź. Zobacz bs_is_buffering().

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

Ten filtr pozwala zmienić wynik </body> przed renderowaniem.

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

Obsługa błędów

error/logged

Akcja jest wywoływana po zarejestrowaniu błędu. Użyj jej, aby przesyłać błędy do zewnętrznych usług rejestrowania.

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

error/exception

Akcja jest wywoływana po obsłużeniu wyjątku.

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

Baza danych

Wszystkie hooki bazy danych otrzymują pojedynczą tablicę $params.

db/before_create

Akcja jest wywoływana przed utworzeniem rekordu.

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

db/after_create

Akcja jest wywoływana po utworzeniu rekordu.

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

Akcja jest wywoływana przed zaktualizowaniem rekordu.

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

db/after_update

Akcja jest wywoływana po zaktualizowaniu rekordu.

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

db/before_delete

Akcja jest wywoływana przed usunięciem rekordu.

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

db/after_delete

Akcja jest wywoływana po usunięciu rekordu.

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

RPC

Wszystkie hooki RPC otrzymują pojedynczą tablicę $params.

rpc/before_call

Akcja jest wywoływana przed wywołaniem funkcji RPC.

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

rpc/after_call

Akcja jest wywoływana po wywołaniu funkcji RPC.

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