Přejít k obsahu

Hooky PHP

Níže je seznam všech dostupných hooků PHP, které můžete použít k rozšíření nebo úpravě funkcí pluginu.

Cesta

Tento filtr umožňuje upravit cestu ke složce bloku. Ve výchozím nastavení jde o blockstudio uvnitř aktuálně aktivního motivu. Případně můžete vytvořit novou instanci pro více zdrojových adresářů.

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

Inicializace

globální

Tato akce se spustí poté, co plugin zaregistruje všechny bloky.

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

instance

Tato akce se spustí poté, co plugin zaregistruje všechny bloky konkrétní instance. Segment $instance je cesta instance relativní k 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

Tato akce se spustí předtím, než plugin zaregistruje všechny bloky.

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

global/before/$instance

Tato akce se spustí předtím, než plugin zaregistruje všechny bloky konkrétní instance.

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

Bloky

vykreslení

Tento filtr umožňuje upravit výstup bloku před jeho vykreslením.

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

metadata

Tento filtr umožňuje upravit data souboru block.json před jeho registrací.

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

Výše uvedený kód by změnil ikonu všech bloků, jejichž název začíná na marketing.

podmínky

Tento filtr umožňuje přidávat vlastní podmínky, které lze používat v blocích. Každý typ podmínky odpovídá hodnotě, kterou editor porovnává s value podmínky. Viz Vlastní podmínky.

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

atributy

Tento filtr upravuje definici jednoho pole před registrací bloku. Filtrovaná definice řídí ovládací prvek editoru a ověřování hodnot při vykreslování. Další informace najdete v části Filtrování.

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

attributes/render

Tento filtr upravuje hodnotu jednoho pole před jejím předáním šabloně bloku. Spouští se jednou pro každé pole a přijímá tři argumenty: $value (vyřešená hodnota), $key (klíč pole používaný v $a) a $block (datové pole bloku, které šablony dostávají jako $block nebo $b). Zaregistrujte jej se třemi přijímanými argumenty. Další informace najdete v části Filtrování.

PHP
add_filter('blockstudio/blocks/attributes/render', function($value, $key, $block) {
  // Modify the value of one field before rendering.
  return $value;
}, 10, 3);

attributes/files/sizes

Pole files vrací každý obrázek s polem sizes, které obsahuje URL, šířku a výšku obrázku full i všech registrovaných velikostí obrázků, například $image['sizes']['thumbnail'] a $image['sizes']['thumbnail-width']. Každá velikost znamená jedno volání wp_get_attachment_image_src() na obrázek, takže se stále uplatňují jeho filtry. Šablony, které nikdy nečtou sizes, mohou seznam zkrátit nebo odstranit.

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 je seznam názvů velikostí, nejprve full (prázdný, pokud nejsou registrovány žádné mezilehlé velikosti). $id je ID přílohy a $size je velikost požadovaná pro hodnotu url. Filtr mění pole sizes všech hodnot typu files v požadavku. Bez něj zůstane pole beze změny.

Vraťte názvy velikostí jako řetězce. Neplatné položky se ignorují, duplicitní názvy se vyřeší pouze jednou a návratová hodnota, která není polem, velikosti přeskočí. Požadované url a další vlastnosti přílohy zůstanou beze změny. Tento hook se nespustí pro pole files s returnFormat: "url", které nevytváří mapu velikostí.

attributes/validate

Upravte nálezy z explicitních volání bs_validate_block(), například když vlastní renderovací filtr vyřeší uložené reference. Tím se nezapne automatická validace při ukládání ani vykreslování.

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

Vraťte seznam nálezů. Filtr se nevolá, pokud blok nemá pole Blockstudio ani odpovídající rozšíření (null).

attributes/schema

Upravte schéma JSON vrácené funkcí bs_block_schema(), například když vlastní renderovací filtr vyhodnocuje uložené reference.

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

Vraťte pole schématu. Filtr se nevolá, pokud blok nemá žádná pole Blockstudio ani odpovídající rozšíření (null).

attributes/populate

Tento filtr umožňuje přidat vlastní data do možností pole checkbox, select nebo radio. Další informace najdete v části Naplnění možností.

Filtr dostává jeden argument: pole všech vlastních datových sad, indexovaných podle názvu použitého v "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

Tento filtr umožňuje upravit výstup obsahu useBlockProps.

Všechny filtry komponent (use_block_props, inner_blocks a rich_text) dostávají blok jako poslední argument. $block je WP_Block_Type registrovaný pro vykreslovaný blok, takže $block->name je název bloku, například acme/hero.

$props je řetězec atributů HTML, nikoli pole. Na frontendu jde o výsledek get_block_wrapper_attributes(), například class="wp-block-acme-hero my-class". V editoru jde o atribut class prvku. Vraťte řetězec. V editoru se použije pouze atribut class vráceného řetězce.

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

Tento filtr umožňuje upravit výstup obsahu <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

Tento filtr umožňuje odebrat obal <InnerBlocks /> z frontendu.

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

components/rich_text/render

Tento filtr umožňuje upravit výstup obsahu <RichText />. Dostává hodnotu atributu a blok.

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

Značky bloků

blockstudio/block_tags/builders

Tento filtr registruje tvůrce polí bloků používané značkami bloků a vlastními bloky vybranými prostřednictvím blockstudio/parser/element_mapping. Každý tvůrce obdrží zpracované atributy a nezpracovaný vnitřní obsah.

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

Kompatibilní filtry blockstudio/block_tags/renderers a blockstudio/parser/renderers se spouštějí po tomto hooku a mohou přepsat stejný název bloku.

blockstudio/block_tags/tag_aliases

Tento filtr umožňuje registrovat vlastní pomlčkové autorské značky, které se před záložním zpracováním nezpracovaných značek HTML převedou na skutečné názvy bloků. Hodí se, když chce šablona nabídnout stručnou sadu značek specifickou pro projekt a přitom stále vykreslovat standardní bloky Blockstudio nebo jádra.

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

Tento filtr umožňuje mapovat zkratky prefixů na jeden nebo více jmenných prostorů bloků. Každý klíč je prefix psaný malými písmeny bez pomlček. Každou hodnotou může být řetězec jmenného prostoru nebo uspořádaný seznam jmenných prostorů.

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

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

<theme-card> se převede na theme-components/card. <theme-button> nejprve zkusí theme-components/button a poté přejde na bsui/button. Explicitní položky blockstudio/block_tags/tag_aliases mají u stejné značky přednost a nevyřešené značky s prefixem zůstanou beze změny.

Prefixy lze kombinovat: pokud se značku s prefixem nepodaří přímo vyřešit a její slug je sám registrovanou značkou prefixu, řešení pokračuje rekurzivně. S theme => ['theme-components'] a ui => ['bsui'] se <theme-ui-input> převede na prefix ui a vyřeší jako bsui/input. Registrované značky prefixů a aliasů se vykreslují také ve výstupu šablon bloků, nejen v obsahu stránek.

Nastavení

cesta

Tento filtr umožňuje upravit cestu k souboru blockstudio.json. Ve výchozím nastavení se nachází na cestě blockstudio.json v právě aktivní šabloně.

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

users/ids

Tento filtr umožňuje povolit editor pro konkrétní ID uživatelů.

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

users/roles

Tento filtr umožňuje povolit editor pro konkrétní uživatelské role.

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

assets/enqueue

Tento filtr umožňuje zapnout nebo vypnout zařazování assetů do fronty na frontendu a v editoru.

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

assets/reset/enabled

Tento filtr umožňuje zapnout nebo vypnout odstranění stylů bloků jádra WordPress a resetu rozvržení pomocných tříd editoru.

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

assets/reset/full_width

Tento filtr umožňuje určit, které typy příspěvků používají úpravy na celou šířku.

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

assets/minify/css

Tento filtr umožňuje zapnout nebo vypnout minifikaci CSS.

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

assets/minify/js

Tento filtr umožňuje zapnout nebo vypnout minifikaci JS.

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

assets/process/scss

Tento filtr umožňuje zapnout nebo vypnout zpracování SCSS v souborech .css.

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

assets/process/scss_files

Tento filtr umožňuje zapnout nebo vypnout zpracování souborů .scss na CSS.

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

assets/output

Tento filtr umožňuje určit, kam se zapisují zkompilované assety bloků.

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

assets/inline_limit

Filtruje, kolik bajtů externího CSS bloku se vloží do stránky.

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

cache/enabled

Tento filtr umožňuje zapnout nebo vypnout všechny běhové a editační mezipaměti souborů Blockstudio.

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

cache/path

Tento filtr umožňuje změnit adresář souborové mezipaměti Blockstudio.

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

cache/namespace_grace

Tento filtr umožňuje změnit dobu uchovávání vyřazeného jmenného prostoru mezipaměti před jeho odstraněním.

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

githooks/commit

Tento filtr zpřístupňuje informaci, zda je povolen commit hook PHPStan vlastněný Blockstudio.

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

content/enabled

Tento filtr umožňuje zapnout nebo vypnout synchronizaci obsahu.

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

content/id

Tento filtr umožňuje nastavit jmenný prostor vlastníka synchronizace obsahu.

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

content/path

Tento filtr umožňuje nastavit adresář souborů synchronizace obsahu.

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

content/include_page_sync_managed

Tento filtr umožňuje zahrnout nebo vyloučit příspěvky spravované synchronizací stránek.

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

content/authors

Tento filtr umožňuje nastavit zpracování autorů při synchronizaci obsahu.

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

content/post_types

Tento filtr umožňuje nastavit seznam povolených typů příspěvků pro synchronizaci obsahu.

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

content/taxonomies

Tento filtr umožňuje nastavit seznam povolených taxonomií pro synchronizaci obsahu.

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

content/media

Tento filtr umožňuje nastavit zpracování médií při synchronizaci obsahu.

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

tailwind/enabled

Tento filtr umožňuje zapnout nebo vypnout Tailwind.

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

tailwind/config

Tento filtr umožňuje přidat vlastní konfiguraci Tailwind CSS.

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

tailwind/output

Tento filtr umožňuje zvolit vložený výstup Tailwind CSS nebo výstup jako odkaz.

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

ui/enabled

Tento filtr umožňuje zapnout nebo vypnout přibalené komponenty UI.

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

editor/format_on_save

Tento filtr umožňuje zapnout nebo vypnout formátování kódu při ukládání.

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

editor/assets

Tento filtr umožňuje zařadit do fronty další assety v editoru.

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

editor/markup

Tento filtr umožňuje přidat na konec editoru další značky.

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

block_editor/disable_loading

Tento filtr umožňuje zakázat načítání bloků v editoru bloků.

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

block_editor/enhance

Tento filtr umožňuje povolit funkce editoru Blockstudio, například čistší styly při zaměření a obrysy při najetí nebo výběru.

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

block_editor/css_classes

Tento filtr umožňuje přidat šablony stylů, jejichž třídy budou k dispozici k výběru v poli tříd.

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

block_editor/css_variables

Tento filtr umožňuje přidat šablony stylů, jejichž proměnné CSS budou dostupné pro automatické doplňování v poli kódu.

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

block_editor/blocks/allow

Tento filtr umožňuje určit názvy bloků povolené v nabídce vkládání.

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

block_editor/blocks/deny

Tento filtr umožňuje odebrat názvy bloků z nabídky vkládání.

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

block_editor/blocks/directory

Tento filtr umožňuje zapnout nebo vypnout assety adresáře bloků WordPress v editoru.

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

block_editor/blocks/categories/allow

Tento filtr umožňuje určit, které slugy kategorií bloků zůstanou dostupné.

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

block_editor/blocks/categories/deny

Tento filtr umožňuje odebrat slugy kategorií bloků z nabídky vkládání.

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

block_editor/blocks/categories/rename

Tento filtr umožňuje přejmenovat názvy kategorií bloků podle slugu.

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

block_editor/blocks/categories/order

Tento filtr umožňuje seřadit slugy kategorií bloků v nabídce vkládání.

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

block_editor/blocks/styles/deny

Tento filtr umožňuje zrušit registraci stylů bloků registrovaných pomocí PHP podle názvu 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

Tento filtr umožňuje skrýt další starší widgety v bloku starších widgetů.

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

block_editor/patterns/core

Tento filtr umožňuje zapnout nebo vypnout vzory bloků jádra WordPress.

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

block_editor/patterns/remote

Tento filtr umožňuje zapnout nebo vypnout vzdálené vzory z adresáře vzorů WordPress.

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

block_editor/patterns/theme

Tento filtr umožňuje zapnout nebo vypnout vzory bloků poskytované šablonou.

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

block_editor/patterns/blockstudio

Tento filtr umožňuje zapnout nebo vypnout vzory založené na souborech Blockstudio.

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

block_editor/patterns/categories/allow

Tento filtr umožňuje určit, které slugy kategorií vzorů zůstanou dostupné.

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

block_editor/patterns/categories/deny

Tento filtr umožňuje odebrat slugy kategorií vzorů z nabídky vkládání vzorů.

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

block_editor/patterns/categories/rename

Tento filtr umožňuje přejmenovat názvy kategorií vzorů podle slugu.

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

block_editor/patterns/categories/order

Tento filtr umožňuje seřadit slugy kategorií vzorů v nabídce vkládání.

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

block_editor/media/openverse

Tento filtr umožňuje zapnout nebo vypnout kategorii médií Openverse v nabídce vkládání médií editoru bloků.

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

block_editor/media/image_sizes/allow

Tento filtr umožňuje určit, které názvy velikostí obrázků zůstanou dostupné v ovládacích prvcích médií editoru.

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

block_editor/media/image_sizes/deny

Tento filtr umožňuje odebrat názvy velikostí obrázků z ovládacích prvků médií editoru.

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

ai/enable_context_generation

Tento filtr umožňuje zapnout nebo vypnout generování kontextového souboru pro integraci s nástroji LLM. Je-li tato možnost zapnutá, kontextový soubor sestaví aktuální data bloků, nastavení Blockstudio aktuální instalace, všechna relevantní schémata a dokumentaci Blockstudio do jediného zdroje pro použití s vývojovými nástroji AI.

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

block_tags/enabled

Tento filtr umožňuje zapnout nebo vypnout vykreslování značek bloků na úrovni stránky.

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

block_tags/prefixes

Tento filtr umožňuje registrovat zkratky mapující prefixy na jmenné prostory pro značky bloků.

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

dev/grab/enabled

Tento filtr umožňuje zapnout nebo vypnout uchopovač prvků.

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

dev/perf

Tento filtr umožňuje zapnout nebo vypnout nástroj pro profilování výkonu.

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

dev/canvas/enabled

Tento filtr umožňuje zapnout nebo vypnout plátno.

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

dev/canvas/admin_bar

Tento filtr umožňuje zobrazit nebo skrýt administrační lištu WordPress na plátně.

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

WPML

blockstudio/wpml/config/label

Filtruje popisek každého klíče, který zapisuje wp bs wpml config. Kontextové pole najdete v části Změna popisků.

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

Plátno

blockstudio/canvas/inventory

Tento filtr upravuje inventář, který Plátno vrací pro výběr. Zpětné volání obdrží DTO inventáře, původní výběr a možnosti, se kterými bylo zavoláno.

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

blockstudio/canvas/documents

Tento filtr upravuje vykreslené dokumenty vracené Plátnem; přijímá stejné tři argumenty jako filtr inventáře.

blockstudio/canvas/item_loaded

Tato akce se spustí při načtení každého záznamu inventáře a obdrží typ inventáře, kanonické ID záznamu a normalizovaný záznam.

blockstudio/canvas/source_compiled

Tato akce se spustí po zkompilování zdrojového souboru pro Plátno a obdrží vybranou cestu ke zdroji a kanonický zdrojový záznam.

Přibalené UI

blockstudio/ui/directories

Tento filtr upravuje adresáře prohledávané kvůli přibaleným komponentám UI.

blockstudio/ui/inventory

Tento filtr upravuje veřejný inventář rodin UI.

blockstudio/ui/examples

Tento filtr upravuje příkladové záznamy UI; obdrží příklady a veřejný inventář UI, z něhož byly odvozeny.

Topologie

blockstudio/blocks/topology_refreshed

Tato akce se spustí po opětovném sestavení topologie bloků.

blockstudio/pages/topology_refreshed

Tato akce se spustí po opětovném sestavení topologie stránky.

blockstudio/pages/layout_error

Tato akce se spustí, když se rozvržení stránky nepodaří vykreslit, místo aby selhalo bez upozornění.

Běhové prostředí

blockstudio/runtime/initialized

Tato akce se spustí po vyřešení konfigurace běhového prostředí.

blockstudio/runtime/changed

Tato akce se spustí při změně identity vyřešeného běhového prostředí, která přesouvá jmenné prostory mezipaměti a stav statického předběžného vykreslení.

blockstudio/performance/default_config

Tento filtr upravuje výchozí nastavení výkonu před přidáním hodnot blockstudio.json vlastního projektu.

Obsah

blockstudio/content/orphan_action

Tento filtr určuje, co synchronizace obsahu udělá se záznamem, který už nemá zdroj.

Bootstrap

blockstudio/url

Tento filtr mění veřejné URL používané pro editor a administrační assety Blockstudio. Integrace Composer ho musí zaregistrovat před načtením souboru Blockstudio autoload. Druhým argumentem je fyzický adresář balíčku.

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

Mezipaměť běhového prostředí

blockstudio/cache/dir

Tento filtr obdrží vyřešený základní adresář mezipaměti před připojením rozsahu pro běhové prostředí, assety editoru nebo jinou mezipaměť.

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

blockstudio/cache/context

Tento filtr přidává serializovatelnou variantu běhového prostředí k identitám mezipaměti. Použijte ho, když tentýž zdroj zjišťování může vybrat různé logické inventáře.

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

Tento filtr mění identitu adresáře sítě/blogu pro hostitele s vlastní hranicí tenanta. Vrácená hodnota se před použitím očistí.

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

Tento filtr přidává fakta o hostiteli, která ovlivňují každý objekt v rozsahu běhového prostředí. Otisky zdrojů specifické pro jednotlivé položky by měl místo toho vlastník API předat jako explicitní závislosti.

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

Určuje počet sekund, po které lze znovu použít ověřený snímek sledování souborů bez další kontroly souborového systému. Výchozí hodnota je 0 v místním a vývojovém prostředí a 20 jinde.

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

blockstudio/cache/build_wait_budget

Určuje, jak dlouho (v milisekundách) požadavek čeká, než se zhorší jeho režim, pokud souběžný proces nezveřejní mezipaměť běhového prostředí nebo obnovené volby. Výchozí hodnota je 5000 pro strukturální opětovné sestavení a 4000 pro obnovení voleb.

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

blockstudio/cache/populate_debounce

Určuje počet sekund, po který se dávka změn obsahu, termínů, uživatelů nebo metadat sloučí do jednoho obnovení naplněných voleb. První zápis po době nečinnosti vyvolá okamžité obnovení; poslední zápis v dávce se projeví po uplynutí okna. Výchozí hodnota je 30. Vraťte 0, chcete-li obnovovat při každém zápisu.

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

blockstudio/cache/populate_ignored_meta_keys

Filtruje meta klíče, jejichž zápisy nikdy neobnovují naplněné volby. Ve výchozím nastavení jde o klíče, které WordPress zapisuje jako evidenci úprav a přihlášení: _edit_lock, které obnovují editor a Heartbeat, když je příspěvek otevřený, _edit_last, zapisovaný při uložení příspěvku, které už obnovení spouští, a session_tokens, zapisovaný při přihlášení a odhlášení. Přidejte klíče, které se často mění, ale nikdy neovlivňují dotaz pro naplnění voleb.

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

blockstudio/cache/max_files_per_scope

Určuje, kolik zveřejněných datových výstupů uchovává každý rozsah mezipaměti běhového prostředí.

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

blockstudio/cache/compress

Filtruje, zda datová část mezipaměti používá komprimovaná serializovaná data místo prostého pole PHP. Ve výchozím nastavení se prostý formát používá pouze pro datové části do 1 MiB, a to jen tehdy, když lze cílové umístění ukládat do sdílené paměti aktivní OPcache. Ostatní procesy, vyloučené soubory a větší datové části používají kompresi.

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

Vrácením false se zároveň obchází omezení velikosti. To může pomoci, když WP-CLI zahřívá soubory pro webové pracovní procesy s povolenou OPcache bez opcache.enable_cli, ale každý čtenář bez OPcache bude muset vygenerované pole analyzovat. U velkých sdílených datových částí zachovejte kompresi, pokud jsou její dodatečné nároky na paměť přijatelné. Výchozí ochranná opatření najdete v části formáty datové části mezipaměti.

blockstudio/cache/protected_paths

Úklid uchovávaných cest mezipaměti nesmí nikdy odstranit. Blockstudio naplní tento seznam všemi soubory, na které odkazuje nainstalovaná mapa předběžného obsloužení.

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

Tato akce hlásí sdílený rozsah mezipaměti a výsledek, například hit, build, miss-stale, stale-last-good nebo 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

Tento filtr obdrží konečné rozhodnutí o bezpečnosti anonymního přístupu a také vstupy serveru a souborů cookie. Vrácení hodnoty true vždy obejde statické obsloužení i generování.

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

Tento filtr poskytuje nebo upravuje úplný veřejný inventář URL používaný plánovaným zahříváním mezipaměti a explicitními nástroji pro práci s grafem.

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

To, co filtr vrátí, není konečný inventář. Výsledek se zpracuje kontrolou ukládatelnosti do mezipaměti, která vyřadí vše odpovídající nakonfigurované dynamické cestě a vše, co se standardně obchází: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, každou cestu obsahující /feed/ a výsledky hledání pod základní cestou hledání na domovské cestě webu (ve výchozím nastavení /search/). Přidaná položka URL proto může být bez upozornění vyřazena. Pokud v sestaveném inventáři chybí očekávaná trasa, nejprve ji porovnejte s těmito pravidly, než usoudíte, že se filtr nespustil.

blockstudio/static_prerender/render_internal

Tento filtr zajišťuje volitelný dávkový přenos v rámci procesu. Vraťte normalizované pole výsledku, nebo ponechte hodnotu beze změny, aby vykreslovač použil nakonfigurovaný záložní mechanismus HTTP. Výsledek obsahuje html a případně také status, dependencies, virtualHashes a headers; hlavičky uvedené v performance.staticPrerender.replayHeaders se uloží spolu s 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

Tento filtr rozhoduje jako poslední poté, co Blockstudio ověří, že výstup je úplný dokument HTML bez značky zákazu ukládání do mezipaměti a že pozorovaný stav odpovědi značí úspěch. Třetím argumentem je pozorovaný stav, nebo null, pokud nebyl žádný stav deklarován.

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

Tato akce hlásí výsledky statického předběžného vykreslení, včetně zásahů, minutí, zápisů, zápisů grafu, zastaralých položek a chyb.

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

blockstudio/tailwind/cache_max_files

Určuje maximální počet zkompilovaných položek Tailwind CSS. Výchozí hodnota je 1000.

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

blockstudio/tailwind/cache_max_age

Určuje maximální stáří zkompilovaných položek Tailwind CSS v sekundách. Výchozí hodnota je 30 dní a minimum jedna hodina.

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

Administrace

povoleno

Tento filtr umožňuje povolit nebo zakázat administrační stránku Blockstudio v nabídce Nástroje > Blockstudio.

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

Assety

editor/canvas/body_class

Je-li reset assetů povolen, tento filtr upravuje očištěné třídy těla frontendu, které se kopírují do plátna editoru bloků.

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

povolit

Tento filtr umožňuje zakázat zpracování a zařazování konkrétního typu assetů do fronty.

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

zakázat

Tento filtr umožňuje zakázat konkrétní assety podle jejich ID. Assety odpovídající ID ve vráceném poli se na frontendu nevykreslí.

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

process/scss/import_paths

Tento filtr umožňuje přidat další cesty do příkazu @import kompilátoru SCSS.

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

process/scss/prelude

Tento filtr umožňuje před kompilací každého souboru SCSS vložit sdílený kód Sass.

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

Tento filtr umožňuje upravit obsah souboru CSS před kompilací.

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

process/js/content

Tento filtr umožňuje upravit obsah souboru JS před kompilací.

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

Buffer

povoleno

Blockstudio ukládá odpověď frontendu do vyrovnávací paměti, aby bylo možné značky stylů a skriptů vykreslené uvnitř těla přesunout do hlavičky a patičky a aby Tailwind mohl zkontrolovat celý dokument. Ukládání do vyrovnávací paměti znamená držet a skenovat celý dokument při každém požadavku na frontend; web, který nevykresluje žádné assety bloků Blockstudio a nepoužívá Tailwind, může vrátit false a obojí přeskočit.

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

Bufferování je vypnuté také v administraci a náhledu Customizeru. Zavolejte bs_is_buffering() z wp_enqueue_scripts nebo později, abyste zjistili, zda je aktuální odpověď bufferována. Vrátí false, než se rozhodne v template_redirect.

výstup

Tento filtr obdrží kompletní dokument HTML ve vyrovnávací paměti před jeho odesláním. Vlastní přesun assetů Blockstudio probíhá s prioritou 1000000 a kompilace Tailwind s prioritou 999999, takže při dřívějším spuštění uvidíte dokument před těmito operacemi a při pozdějším jejich konečný výstup.

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

Vykreslování

závislosti

Tento filtr hlásí vybranou šablonu a závislosti assetů pokaždé, když Blockstudio vykreslí blok. Hodí se pro statické exportéry a další sběrače závislostí v rámci procesu.

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

globální

Tento filtr umožňuje upravit výstup stránky před vykreslením.

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

Tento filtr umožňuje upravit výstup značky <head> před jejím vykreslením. Spustí se pouze tehdy, když Blockstudio bufferuje odpověď; viz bs_is_buffering().

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

Tento filtr umožňuje upravit výstup prvku </body> před vykreslením.

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

Zpracování chyb

error/logged

Akce se spustí po zaznamenání chyby. Pomocí ní můžete odesílat chyby do externích služeb pro jejich zaznamenávání.

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

error/exception

Akce se spustí po zpracování výjimky.

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

Databáze

Všechny databázové hooky obdrží jedno pole $params.

db/before_create

Akce se spustí před vytvořením záznamu.

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

db/after_create

Akce se spustí po vytvoření záznamu.

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

Akce se spustí před aktualizací záznamu.

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

db/after_update

Akce se spustí po aktualizaci záznamu.

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

db/before_delete

Akce se spustí před odstraněním záznamu.

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

db/after_delete

Akce se spustí po odstranění záznamu.

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

RPC

Všechny hooky RPC obdrží jedno pole $params.

rpc/before_call

Akce se spustí před zavoláním funkce RPC.

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

rpc/after_call

Akce se spustí po zavolání funkce RPC.

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