Preskočiť na obsah

Háčiky PHP

Nižšie nájdete zoznam všetkých dostupných háčikov PHP, ktoré môžete použiť na rozšírenie alebo úpravu funkcií pluginu.

Cesta

Tento filter umožňuje upraviť cestu k priečinku bloku. Predvolene sa nachádza blockstudio v aktuálne aktívnej téme. Prípadne môžete vytvoriť novú inštanciu pre viacero zdrojových priečinkov.

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

Inicializácia

globálne

Táto akcia sa spustí po tom, čo plugin zaregistruje všetky bloky.

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

inštancia

Táto akcia sa spustí po tom, čo plugin zaregistruje všetky bloky konkrétnej inštancie. Úsek $instance je cesta k inštancii vzhľadom na 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

Táto akcia sa spustí pred registráciou všetkých blokov pluginom.

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

global/before/$instance

Táto akcia sa spustí pred registráciou všetkých blokov konkrétnej inštancie pluginom.

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

Bloky

vykreslenie

Tento filter umožňuje upraviť výstup bloku pred jeho vykreslením.

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

meta

Tento filter umožňuje upraviť údaje súboru block.json pred jeho registráciou.

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

Vyššie uvedený kód zmení ikonu všetkých blokov, ktorých názov sa začína na marketing.

podmienky

Tento filter umožňuje pridať vlastné podmienky, ktoré možno použiť v blokoch. Každý typ podmienky zodpovedá hodnote, ktorú editor porovnáva s value podmienky. Pozrite si časť Vlastné podmienky.

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

atribúty

Tento filter upravuje definíciu jedného poľa pred registráciou bloku. Filtrovaná definícia určuje ovládací prvok editora a validáciu hodnoty pri vykresľovaní. Ďalšie informácie nájdete v časti Filtrovanie.

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

attributes/render

Tento filter upraví hodnotu jedného poľa pred jej odovzdaním šablóne bloku. Spustí sa raz pre každé pole a prijíma tri argumenty: $value (vyriešená hodnota), $key (kľúč poľa používaný v $a) a $block (dátové pole bloku, ktoré šablóny dostávajú ako $block alebo $b). Zaregistrujte ho s tromi prijímanými argumentmi. Ďalšie informácie nájdete v časti Filtrovanie.

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 vráti každý obrázok spolu s poľom sizes, ktoré obsahuje URL, šírku a výšku obrázka full a každej registrovanej veľkosti obrázka, napríklad $image['sizes']['thumbnail'] a $image['sizes']['thumbnail-width']. Každá veľkosť znamená jedno volanie wp_get_attachment_image_src() pre každý obrázok, takže jeho filtre sa stále uplatnia. V šablónach, ktoré nikdy nečítajú sizes, možno zoznam vynechať alebo skrátiť.

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 zoznam názvov veľkostí, pričom full je na prvom mieste (prázdny, ak nie sú zaregistrované žiadne priebežné veľkosti). $id je ID prílohy a $size je veľkosť požadovaná pre hodnotu url. Filter mení pole sizes každej hodnoty typu files v požiadavke. Bez neho zostane pole nezmenené.

Názvy veľkostí vráťte ako reťazce. Neplatné položky sa ignorujú, duplicitné názvy sa spracujú iba raz a návratová hodnota, ktorá nie je poľom, preskočí veľkosti. Požadované url a ostatné vlastnosti prílohy zostanú nezmenené. Tento hook sa nespustí pre pole files s returnFormat: "url", ktoré nevytvára mapu veľkostí.

attributes/validate

Upravuje zistenia z explicitných volaní bs_validate_block(), napríklad keď vlastný renderovací filter vyrieši uložené odkazy. Tým sa nepovolí automatická validácia pri ukladaní ani renderovaní.

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

Vráťte zoznam zistení. Filter sa nevolá, keď blok nemá polia Blockstudio ani zodpovedajúce rozšírenia (null).

attributes/schema

Upravte schému JSON vrátenú funkciou bs_block_schema(), napríklad keď vlastný renderovací filter vyrieši uložené referencie.

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

Vráťte pole schémy. Filter sa nevolá, ak blok nemá žiadne polia Blockstudio ani zodpovedajúce rozšírenia (null).

attributes/populate

Tento filter umožňuje pridať vlastné údaje do možností poľa checkbox, select alebo radio. Ďalšie informácie nájdete v časti Napĺňanie možností.

Filter prijíma jeden argument: pole všetkých vlastných súborov údajov, ktorých kľúčom je názov použitý 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 filter umožňuje upraviť výstup obsahu useBlockProps.

Všetky filtre komponentov (use_block_props, inner_blocks a rich_text) dostávajú blok ako posledný argument. $block je WP_Block_Type zaregistrovaný pre vykresľovaný blok, takže $block->name je názov bloku, napríklad acme/hero.

$props je reťazec atribútov HTML, nie pole. Na frontende je výsledkom get_block_wrapper_attributes(), napríklad class="wp-block-acme-hero my-class". V editore ide o atribút class prvku. Vráťte reťazec. V editore sa použije iba atribút class vráteného reťazca.

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 filter umožňuje upraviť 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 filter umožňuje odstrániť 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 filter umožňuje upraviť výstup obsahu <RichText />. Dostáva hodnotu atribútu a blok.

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

Značky blokov

blockstudio/block_tags/builders

Tento filter registruje tvorcov polí blokov, ktoré používajú značky blokov a vlastné bloky vybrané cez blockstudio/parser/element_mapping. Každý tvorca dostane analyzované atribúty a surový vnútorný 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é filtre blockstudio/block_tags/renderers a blockstudio/parser/renderers sa spustia po tomto háku a môžu prepísať rovnaký názov bloku.

blockstudio/block_tags/tag_aliases

Tento filter umožňuje registrovať vlastné značky na tvorbu s pomlčkami, ktoré sa pred záložným spracovaním surového HTML preložia na skutočné názvy blokov. Hodí sa, keď chce téma používať stručné značky špecifické pre projekt a zároveň vykresľovať štandardné bloky Blockstudio alebo jadra.

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 filter umožňuje mapovať skrátené prefixy na jeden alebo viac menných priestorov blokov. Každý kľúč je prefix písaný malými písmenami bez pomlčiek. Každá hodnota môže byť reťazec menného priestoru alebo usporiadaný zoznam menných priestorov.

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> sa preloží na theme-components/card. <theme-button> najprv skúsi theme-components/button a potom použije záložnú možnosť bsui/button. Explicitné položky blockstudio/block_tags/tag_aliases majú prednosť pri rovnakej značke a nevyriešené značky s prefixom zostanú nezmenené.

Prefixy sa skladajú: ak sa značka s prefixom nevyrieši priamo a jej slug je sám zaregistrovanou značkou prefixu, rozlíšenie pokračuje rekurzívne. Pri theme => ['theme-components'] a ui => ['bsui'] sa <theme-ui-input> presmeruje na prefix ui a vyrieši sa ako bsui/input. Zaregistrované značky prefixov a aliasov sa vykresľujú aj vo výstupe šablóny bloku, nielen v obsahu stránky.

Nastavenia

cesta

Tento filter umožňuje upraviť cestu k súboru blockstudio.json. Predvolene ide o blockstudio.json v aktuálne aktívnej téme.

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

users/ids

Tento filter umožňuje zapnúť editor pre konkrétne ID používateľov.

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

users/roles

Tento filter umožňuje zapnúť editor pre konkrétne roly používateľov.

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

assets/enqueue

Tento filter umožňuje zapnúť alebo vypnúť zaradenie zdrojov do frontendu a editora.

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

assets/reset/enabled

Tento filter umožňuje zapnúť alebo vypnúť odstránenie štýlov blokov jadra WordPress a resetu rozloženia pomocných prvkov editora.

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

assets/reset/full_width

Tento filter umožňuje určiť, ktoré typy príspevkov používajú úpravy na celú šírku.

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

assets/minify/css

Tento filter umožňuje zapnúť alebo vypnúť minifikáciu CSS.

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

assets/minify/js

Tento filter umožňuje zapnúť alebo vypnúť minifikáciu JS.

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

assets/process/scss

Tento filter umožňuje zapnúť alebo vypnúť spracovanie SCSS v súboroch .css.

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

assets/process/scss_files

Tento filter umožňuje zapnúť alebo vypnúť spracovanie súborov .scss do CSS.

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

assets/output

Tento filter umožňuje určiť, kam sa zapisujú skompilované zdroje blokov.

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

assets/inline_limit

Filtruje, koľko bajtov externého CSS bloku sa vloží priamo do každej stránky.

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

cache/enabled

Tento filter umožňuje zapnúť alebo vypnúť všetky runtime a editorové vyrovnávacie pamäte súborov Blockstudio.

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

cache/path

Tento filter umožňuje zmeniť adresár vyrovnávacej pamäte založenej na súboroch Blockstudio.

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

cache/namespace_grace

Tento filter umožňuje určiť, ako dlho sa ponechá vyradený menný priestor vyrovnávacej pamäte, kým sa odstráni.

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

githooks/commit

Tento filter sprístupňuje informáciu o tom, či je zapnutý hák potvrdenia PHPStan spravovaný Blockstudio.

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

content/enabled

Tento filter umožňuje zapnúť alebo vypnúť synchronizáciu obsahu.

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

content/id

Tento filter umožňuje nastaviť menný priestor vlastníctva synchronizácie obsahu.

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

content/path

Tento filter umožňuje nastaviť adresár súborov synchronizácie obsahu.

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

content/include_page_sync_managed

Tento filter umožňuje zahrnúť alebo vylúčiť príspevky spravované synchronizáciou stránok.

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

content/authors

Tento filter umožňuje nastaviť spracovanie autorov pri synchronizácii obsahu.

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

content/post_types

Tento filter umožňuje nastaviť zoznam povolených typov príspevkov pri synchronizácii obsahu.

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

content/taxonomies

Tento filter umožňuje nastaviť zoznam povolených taxonómií pri synchronizácii obsahu.

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

content/media

Tento filter umožňuje nastaviť spracovanie médií pri synchronizácii obsahu.

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

tailwind/enabled

Tento filter umožňuje zapnúť alebo vypnúť Tailwind.

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

tailwind/config

Tento filter umožňuje pridať vlastnú konfiguráciu Tailwind CSS.

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

tailwind/output

Tento filter umožňuje vybrať vložený alebo prepojený výstup Tailwind CSS.

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

ui/enabled

Tento filter umožňuje zapnúť alebo vypnúť pribalené komponenty UI.

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

editor/format_on_save

Tento filter umožňuje zapnúť alebo vypnúť formátovanie kódu pri ukladaní.

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

editor/assets

Tento filter umožňuje zaradiť do fronty ďalšie zdroje v editore.

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

editor/markup

Tento filter umožňuje pridať ďalšie značky na koniec editora.

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

block_editor/disable_loading

Tento filter umožňuje vypnúť načítavanie blokov v editore blokov.

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

block_editor/enhance

Tento filter umožňuje zapnúť funkcie editora Blockstudio, ako sú prehľadnejšie štýly zamerania a obrysy pri ukázaní alebo výbere.

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

block_editor/css_classes

Tento filter umožňuje pridať šablóny štýlov, ktorých triedy budú dostupné na výber v poli triedy.

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

block_editor/css_variables

Tento filter umožňuje pridať šablóny štýlov, ktorých premenné CSS budú dostupné na automatické dopĺňanie v poli kódu.

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

block_editor/blocks/allow

Tento filter umožňuje určiť názvy blokov, ktoré možno vložiť pomocou nástroja na vkladanie.

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

block_editor/blocks/deny

Tento filter umožňuje odstrániť názvy blokov z nástroja na vkladanie.

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

block_editor/blocks/directory

Tento filter umožňuje zapnúť alebo vypnúť zdroje adresára blokov WordPress v editore.

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

block_editor/blocks/categories/allow

Tento filter umožňuje určiť, ktoré slugy kategórií blokov zostanú dostupné.

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

block_editor/blocks/categories/deny

Tento filter umožňuje odstrániť slugy kategórií blokov z nástroja na vkladanie.

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

block_editor/blocks/categories/rename

Tento filter umožňuje premenovať názvy kategórií blokov podľa slugu.

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

block_editor/blocks/categories/order

Tento filter umožňuje usporiadať slugy kategórií blokov v nástroji na vkladanie.

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

block_editor/blocks/styles/deny

Tento filter umožňuje zrušiť registráciu štýlov blokov zaregistrovaných cez PHP podľa 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 filter umožňuje skryť ďalšie zastarané widgety z bloku zastaraných widgetov.

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

block_editor/patterns/core

Tento filter umožňuje zapnúť alebo vypnúť vzory blokov jadra WordPress.

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

block_editor/patterns/remote

Tento filter umožňuje zapnúť alebo vypnúť vzdialené vzory z adresára vzorov WordPress.

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

block_editor/patterns/theme

Tento filter umožňuje zapnúť alebo vypnúť vzory blokov poskytované témou.

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

block_editor/patterns/blockstudio

Tento filter umožňuje zapnúť alebo vypnúť vzory založené na súboroch Blockstudio.

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

block_editor/patterns/categories/allow

Tento filter umožňuje určiť, ktoré slugy kategórií vzorov zostanú dostupné.

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

block_editor/patterns/categories/deny

Tento filter umožňuje odstrániť slugy kategórií vzorov z nástroja na vkladanie vzorov.

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

block_editor/patterns/categories/rename

Tento filter umožňuje premenovať názvy kategórií vzorov podľa slugu.

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

block_editor/patterns/categories/order

Tento filter umožňuje usporiadať slugy kategórií vzorov v nástroji na vkladanie.

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

block_editor/media/openverse

Tento filter umožňuje zapnúť alebo vypnúť kategóriu médií Openverse v nástroji na vkladanie médií editora blokov.

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

block_editor/media/image_sizes/allow

Tento filter umožňuje určiť, ktoré názvy veľkostí obrázkov zostanú dostupné v ovládacích prvkoch médií editora.

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

block_editor/media/image_sizes/deny

Tento filter umožňuje odstrániť názvy veľkostí obrázkov z ovládacích prvkov médií editora.

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

ai/enable_context_generation

Tento filter umožňuje zapnúť alebo vypnúť generovanie súboru kontextu na integráciu nástrojov LLM. Ak je zapnuté, súbor kontextu zhromaždí aktuálne údaje o blokoch, nastavenia Blockstudio aktuálnej inštalácie, všetky relevantné schémy a dokumentáciu Blockstudio do jedného zdroja pre vývojové nástroje s AI.

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

block_tags/enabled

Tento filter umožňuje zapnúť alebo vypnúť vykresľovanie značiek blokov na úrovni stránky.

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

block_tags/prefixes

Tento filter umožňuje registrovať skrátené prefixy mapované na menné priestory pre značky blokov.

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

dev/grab/enabled

Tento filter umožňuje zapnúť alebo vypnúť nástroj na uchopenie prvkov.

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

dev/perf

Tento filter umožňuje zapnúť alebo vypnúť profilovač výkonu.

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

dev/canvas/enabled

Tento filter umožňuje zapnúť alebo vypnúť plátno.

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

dev/canvas/admin_bar

Tento filter umožňuje zobraziť alebo skryť administračný panel WordPress na plátne.

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

WPML

blockstudio/wpml/config/label

Filtruje označenie každého kľúča, ktorý zapisuje wp bs wpml config. Kontextové pole nájdete v časti Zmena označení.

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

Plátno

blockstudio/canvas/inventory

Tento filter upravuje inventár, ktorý plátno vracia pre výber. Spätné volanie dostane DTO inventára, pôvodný výber a možnosti, s ktorými bolo zavolané.

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

blockstudio/canvas/documents

Tento filter upravuje vykreslené dokumenty, ktoré plátno vracia, a používa rovnaké tri argumenty ako filter inventára.

blockstudio/canvas/item_loaded

Táto akcia sa spustí pri načítaní každého záznamu inventára a dostane typ inventára, kanonické ID záznamu a normalizovaný záznam.

blockstudio/canvas/source_compiled

Táto akcia sa spustí po skompilovaní zdrojového súboru pre plátno a dostane vybranú cestu k zdroju a kanonický zdrojový záznam.

Pribalené UI

blockstudio/ui/directories

Tento filter upravuje adresáre prehľadávané pri hľadaní pribalených komponentov UI.

blockstudio/ui/inventory

Tento filter upravuje verejný inventár rodín UI.

blockstudio/ui/examples

Tento filter upravuje ukážkové záznamy UI a dostane ukážky aj verejný inventár UI, z ktorého boli odvodené.

Topológia

blockstudio/blocks/topology_refreshed

Táto akcia sa spustí po opätovnom zostavení topológie blokov.

blockstudio/pages/topology_refreshed

Táto akcia sa spustí po opätovnom zostavení topológie stránky.

blockstudio/pages/layout_error

Táto akcia sa spustí, keď sa rozloženie stránky nepodarí vykresliť, namiesto toho, aby zlyhalo bez upozornenia.

Runtime

blockstudio/runtime/initialized

Táto akcia sa spustí po vyriešení konfigurácie runtime prostredím.

blockstudio/runtime/changed

Táto akcia sa spustí pri zmene vyriešenej identity runtime prostredia, ktorá spôsobí presun menných priestorov vyrovnávacej pamäte a stavu statického predvykreslenia.

blockstudio/performance/default_config

Tento filter upravuje predvolené nastavenia výkonu pred pridaním vlastných hodnôt projektu blockstudio.json.

Obsah

blockstudio/content/orphan_action

Tento filter určuje, čo synchronizácia obsahu urobí so záznamom, ktorý už nemá zdroj.

Bootstrap

blockstudio/url

Tento filter mení verejné URL používané pre aktíva editora a administrácie Blockstudio. Integrácie Composer ho musia zaregistrovať pred načítaním súboru automatického načítania Blockstudio. Druhým argumentom je fyzický adresár balíka.

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

Vyrovnávacia pamäť runtime prostredia

blockstudio/cache/dir

Tento filter dostane vyriešený základný adresár vyrovnávacej pamäte pred pridaním rozsahu runtime prostredia, aktív editora alebo iného rozsahu vyrovnávacej pamäte.

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

blockstudio/cache/context

Tento filter pridáva do identít vyrovnávacej pamäte serializovateľný variant runtime prostredia. Použite ho, keď ten istý zdroj zisťovania môže vybrať rôzne logické inventáre.

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 filter mení identitu adresára siete/blogu pre hostiteľov s vlastnou hranicou nájomcu. Vrátená hodnota sa pred 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 filter pridáva fakty o hostiteľovi, ktoré ovplyvňujú každý objekt v rozsahu runtime prostredia. Odtlačky prstov zdrojov špecifické pre položku má namiesto toho ako explicitné závislosti odovzdávať príslušný 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

Určuje počet sekúnd, počas ktorých možno opakovane použiť overenú snímku sledovania súborov bez ďalšej kontroly stavu súborového systému. Predvolená hodnota je 0 v lokálnych a vývojových prostrediach a 20 inde.

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

blockstudio/cache/build_wait_budget

Určuje, ako dlho v milisekundách bude požiadavka čakať na súbežného tvorcu, ktorý zverejní vyrovnávaciu pamäť runtime prostredia alebo obnoví naplnené voľby, kým prejde do obmedzeného režimu. Predvolená hodnota je 5000 pri štrukturálnom opätovnom zostavení a 4000 pri obnove volieb.

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

blockstudio/cache/populate_debounce

Určuje počet sekúnd, počas ktorých sa zhluk zápisov obsahu, termínov, používateľov alebo metaúdajov zlúči do jednej obnovy naplnených volieb. Prvý zápis po období nečinnosti spustí obnovu okamžite; posledný zápis v zhluku sa premietne po uplynutí okna. Predvolená hodnota je 30. Vráťte 0, ak chcete obnovovať po každom zápise.

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

blockstudio/cache/populate_ignored_meta_keys

Filtruje meta kľúče, ktorých zápisy nikdy neobnovia naplnené možnosti. Predvolene ide o kľúče WordPress zapisované pri úpravách a evidencii prihlásení: _edit_lock, ktoré obnovuje editor a Heartbeat, keď je príspevok otvorený, _edit_last, zapisované pri ukladaní príspevku, ktoré už obnovu spúšťa, a session_tokens, zapisované pri prihlásení a odhlásení. Pridajte kľúče, ktoré sa často menia, ale nikdy neovplyvňujú dopyt na naplnenie možností.

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, koľko publikovaných dátových balíkov uchová každý rozsah vyrovnávacej pamäte runtime prostredia.

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

blockstudio/cache/compress

Filtruje, či sa v dátach vyrovnávacej pamäte použijú komprimované serializované údaje namiesto obyčajného poľa PHP. Predvolene sa obyčajný formát používa iba pre dáta s veľkosťou do 1 MiB, a to len vtedy, keď aktívna zdieľaná pamäť OPcache dokáže uložiť cieľ. Ostatné procesy, vylúčené súbory a väčšie dáta používajú kompresiu.

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

Vrátenie hodnoty false obíde aj limit veľkosti. Môže to pomôcť, keď WP-CLI bez opcache.enable_cli pripraví súbory pre webových pracovníkov s povoleným OPcache, no každý čitateľ bez OPcache bude musieť vygenerované pole spracovať. Pri veľkých zdieľaných dátach ponechajte kompresiu, pokiaľ súvisiace náklady na pamäť nie sú prijateľné. Predvolené ochranné opatrenia nájdete v časti formáty dát vyrovnávacej pamäte.

blockstudio/cache/protected_paths

Prerezávanie uchovávania vyrovnávacej pamäte nesmie nikdy odstrániť tieto cesty. Blockstudio ich doplní o každý súbor, na ktorý odkazuje nainštalovaná mapa skorého poskytovania.

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

Táto akcia hlási zdieľaný rozsah vyrovnávacej pamäte a výsledok, napríklad hit, build, miss-stale, stale-last-good alebo 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 filter dostane konečné rozhodnutie o anonymnej bezpečnosti spolu so vstupmi servera a súborov cookie. Vrátením hodnoty true sa vždy obíde statické poskytovanie aj generovanie.

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 filter poskytuje alebo upravuje kompletný verejný inventár URL, ktorý používajú plánované zahrievanie a explicitné nástroje grafov.

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

Hodnota vrátená filtrom nie je konečný inventár. Výsledok prejde kontrolou možnosti uloženia do vyrovnávacej pamäte, ktorá odstráni všetko zodpovedajúce nakonfigurovanej dynamickej ceste a všetko, čo sa predvolene obchádza: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, každú cestu obsahujúcu /feed/ a výsledky vyhľadávania pod základnou cestou vyhľadávania v domovskej ceste webu (predvolene /search/). Pridaná hodnota URL sa preto môže zahodiť bez upozornenia. Ak v zostavenom inventári chýba očakávaná trasa, predpokladom, že sa filter nespustil, najprv overte, či ju nevylučujú tieto pravidlá.

blockstudio/static_prerender/render_internal

Tento filter implementuje voliteľný dávkový prenos v rámci procesu. Vráťte normalizované pole výsledkov alebo ponechajte hodnotu nezmenenú, aby vykresľovač použil nakonfigurovanú záložnú možnosť HTTP. Výsledok obsahuje html a voliteľne aj status, dependencies, virtualHashes a headers; hlavičky uvedené v performance.staticPrerender.replayHeaders sa ukladajú spolu s dokumentom.

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 filter prijme konečné rozhodnutie po tom, ako Blockstudio overí, že výstup je úplný dokument HTML bez značky „no-cache“ a že zaznamenaný stav odpovede signalizuje úspech. Tretí argument je zaznamenaný stav alebo null, ak nebol deklarovaný žiadny stav.

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

Táto akcia hlási výsledky statického predvykresľovania vrátane zásahov do vyrovnávacej pamäte, neúspešných načítaní, zápisov, zápisov grafu, zastaraných položiek a zlyhaní.

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

blockstudio/tailwind/cache_max_files

Určuje maximálny počet skompilovaných položiek Tailwind CSS. Predvolená hodnota je 1000.

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

blockstudio/tailwind/cache_max_age

Určuje maximálny vek skompilovaných položiek Tailwind CSS v sekundách. Predvolená hodnota je 30 dní a minimum jedna hodina.

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

Administrácia

zapnuté

Tento filter umožňuje zapnúť alebo vypnúť administračnú stránku Blockstudio v časti Nástroje > Blockstudio.

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

Zdroje

editor/canvas/body_class

Keď je reset zdrojov zapnutý, tento filter upravuje očistené triedy tela frontendu skopírované na plátno editora blokov.

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

zapnúť

Tento filter umožňuje vypnúť spracovanie a zaradenie konkrétneho typu zdroja 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);

vypnúť

Tento filter umožňuje vypnúť konkrétne zdroje podľa ich ID. Zdroje, ktorých ID sa nachádza vo vrátenom poli, sa na frontende nevykreslia.

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

process/scss/import_paths

Tento filter umožňuje pridať ďalšie cesty do príkazu @import kompilátora SCSS.

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

process/scss/prelude

Tento filter umožňuje pripojiť zdieľaný kód Sass pred kompiláciu každého súboru 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

Tento filter umožňuje upraviť obsah súboru CSS pred jeho kompiláciou.

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 filter umožňuje upraviť obsah súboru JS pred jeho kompiláciou.

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

Buffer

zapnuté

Blockstudio ukladá odpoveď frontendu do vyrovnávacej pamäte, aby sa značky štýlov a skriptov vykreslené v tele mohli presunúť do hlavičky a päty a aby Tailwind mohlo prehľadať celý dokument. Ukladanie do vyrovnávacej pamäte znamená podržať a prehľadať celý dokument pri každej požiadavke frontendu; web, ktorý nevykresľuje žiadne zdroje blokov Blockstudio a nepoužíva Tailwind, môže vrátiť false a preskočiť oboje.

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

Ukladanie do vyrovnávacej pamäte je vypnuté aj v administrácii a v ukážke nástroja Customizer. Zavolajte bs_is_buffering() z wp_enqueue_scripts alebo neskôr, aby ste zistili, či sa aktuálna odpoveď ukladá do vyrovnávacej pamäte. Pred rozhodnutím v template_redirect vráti false.

výstup

Tento filter dostane celý dokument HTML uložený vo vyrovnávacej pamäti pred odoslaním. Vlastné presúvanie zdrojov Blockstudio sa vykoná s prioritou 1000000 a kompilácia Tailwind s prioritou 999999, preto ho spustite skôr, ak chcete vidieť dokument pred týmito operáciami, alebo neskôr, ak chcete vidieť konečný výstup.

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

Vykresľovanie

závislosti

Tento filter hlási vybrané závislosti šablóny a zdrojov vždy, keď Blockstudio vykreslí blok. Hodí sa pre statické exportéry a ďalšie zberač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álne

Tento filter umožňuje upraviť výstup stránky pred jej vykreslením.

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

Tento filter umožňuje upraviť výstup značky <head> pred jej vykreslením. Spustí sa iba vtedy, keď Blockstudio ukladá odpoveď do vyrovnávacej pamäte; pozrite si bs_is_buffering().

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

Tento filter umožňuje upraviť výstup prvku </body> pred jeho vykreslením.

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

Spracovanie chýb

error/logged

Akcia sa spustí po zaznamenaní chyby. Použite ju na odosielanie chýb do externých služieb na zaznamenávanie udalostí.

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

error/exception

Akcia sa spustí po spracovaní výnimky.

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

Databáza

Všetky databázové háky dostanú jedno pole $params.

db/before_create

Akcia sa spustí pred vytvorením záznamu.

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

db/after_create

Akcia sa spustí po vytvorení 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

Akcia sa spustí pred aktualizáciou záznamu.

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

db/after_update

Akcia sa spustí po aktualizácii záznamu.

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

db/before_delete

Akcia sa spustí pred odstránením záznamu.

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

db/after_delete

Akcia sa spustí po odstránení záznamu.

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

RPC

Všetky háky RPC dostanú jedno pole $params.

rpc/before_call

Akcia sa spustí pred zavolaním funkcie RPC.

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

rpc/after_call

Akcia sa spustí po zavolaní funkcie RPC.

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