Pāriet uz saturu

PHP āķi

Tālāk ir pieejamo PHP āķu saraksts, ko var izmantot, lai paplašinātu vai pielāgotu spraudņa funkcionalitāti.

Ceļš

Šis filtrs ļauj pielāgot bloka mapes ceļu. Pēc noklusējuma tas atrodas aktīvajā tēmā mapē blockstudio. Varat arī izveidot jaunu instanci vairākām avota direktorijām.

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

Init

globāls

Šī darbība tiek izpildīta pēc tam, kad spraudnis ir reģistrējis visus blokus.

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

instance

Šī darbība tiek izpildīta pēc tam, kad spraudnis ir reģistrējis visus konkrētās instances blokus. Segments $instance ir instances ceļš attiecībā pret 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

Šī darbība tiek izpildīta pirms spraudnis ir reģistrējis visus blokus.

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

global/before/$instance

Šī darbība tiek izpildīta pirms spraudnis ir reģistrējis visus konkrētās instances blokus.

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

Bloki

render

Šis filtrs ļauj pielāgot bloka izvadi pirms tā attēlošanas.

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

meta

Šis filtrs ļauj pielāgot block.json faila datus pirms tā reģistrēšanas.

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

Iepriekš minētais kods mainītu visu bloku ikonu, kuru nosaukums sākas ar marketing.

conditions

Šis filtrs ļauj pievienot pielāgotus nosacījumus, ko var izmantot blokos. Katrs nosacījuma veids tiek sasaistīts ar vērtību, ko redaktors salīdzina ar nosacījuma value. Skatiet sadaļu Pielāgotie nosacījumi.

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

attributes

Šis filtrs maina viena lauka definīciju pirms bloka reģistrēšanas. Filtrētā definīcija nosaka redaktora vadīklu un vērtības validāciju renderēšanas laikā. Plašāku informāciju skatiet sadaļā Filtrēšana.

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

attributes/render

Šis filtrs pielāgo viena lauka vērtību, pirms tā tiek nodota bloka veidnei. Tas darbojas vienreiz katram laukam un saņem trīs argumentus: $value (atrisināto vērtību), $key (lauka atslēgu, kā tā izmantota $a) un $block (bloka datu masīvu, ko veidnes saņem kā $block vai $b). Reģistrējiet to ar trim pieņemtajiem argumentiem. Plašāku informāciju skatiet sadaļā Filtrēšana.

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

Lauks files atgriež katru attēlu ar masīvu sizes, kurā iekļauts URL, platums un augstums gan full, gan katram reģistrētajam attēla izmēram, piemēram, $image['sizes']['thumbnail'] un $image['sizes']['thumbnail-width']. Katram izmēram tiek veikts viens wp_get_attachment_image_src() izsaukums katram attēlam, tāpēc tā filtri joprojām tiek lietoti. Veidnes, kas nekad nenolasa sizes, var sarakstu izlaist vai saīsināt.

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 ir izmēru nosaukumu saraksts; pirmais ir full (tukšs, ja nav reģistrēti starpizmēri). $id ir pielikuma ID, bet $size — izmērs, kas pieprasīts vērtības url. Filtrs maina katras faila vērtības sizes masīvu pieprasījumā. Bez tā masīvs paliek nemainīgs.

Atgrieziet izmēru nosaukumus kā virknes. Nederīgi ieraksti tiek ignorēti, bet dublēti nosaukumi tiek apstrādāti tikai vienreiz. Ja tiek atgriezta vērtība, kas nav masīvs, izmēri tiek izlaisti. Pieprasītais url un citi pielikuma rekvizīti paliek nemainīti. Šis āķis nedarbojas failu laukam ar returnFormat: "url", jo tam netiek veidota izmēru karte.

attributes/validate

Pielāgojiet atradumus, kas iegūti ar tiešiem bs_validate_block() izsaukumiem, piemēram, ja pielāgots renderēšanas filtrs atrisina saglabātās atsauces. Tas neieslēdz automātisku validāciju saglabāšanas vai renderēšanas laikā.

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

Atgrieziet atradumu sarakstu. Filtrs netiek izsaukts, ja blokam nav Blockstudio lauku vai atbilstošu paplašinājumu (null).

attributes/schema

Pielāgojiet JSON shēmu, ko atgriež bs_block_schema() shēmas , piemēram, ja pielāgots renderēšanas filtrs atrisina saglabātās atsauces.

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

Atgrieziet shēmas masīvu. Filtrs netiek izsaukts, ja blokam nav Blockstudio lauku vai atbilstošu paplašinājumu (null).

attributes/populate

Šis filtrs ļauj pievienot pielāgotus datus lauka checkbox, select vai radio opcijām. Plašāku informāciju skatiet sadaļā Opciju aizpildīšana.

Filtrs saņem vienu argumentu: visu pielāgoto datu kopu masīvu, kura atslēgas ir nosaukumi, kas izmantoti "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

Šis filtrs ļauj pielāgot useBlockProps satura izvadi.

Visi komponentu filtri (use_block_props, inner_blocks un rich_text) saņem bloku kā pēdējo argumentu. $block ir šim renderētajam blokam reģistrētais WP_Block_Type, tāpēc $block->name ir bloka nosaukums, piemēram, acme/hero.

$props ir HTML atribūtu virkne, nevis masīvs. Priekšgalā tā ir get_block_wrapper_attributes() rezultāts, piemēram, class="wp-block-acme-hero my-class". Redaktorā tā ir elementa atribūts class. Atgrieziet virkni. Redaktorā tiek lietots tikai atgrieztās virknes atribūts class.

PHP
add_filter('blockstudio/blocks/components/use_block_props/render', function($props, $block) {
  if ($block->name !== 'acme/hero') {
    return $props;
  }

  return str_replace('class="', 'class="my-custom-class ', $props);
}, 10, 2);

components/inner_blocks/render

Šis filtrs ļauj pielāgot <InnerBlocks /> satura izvadi.

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

Šis filtrs ļauj noņemt <InnerBlocks /> ietvaru priekšgalā.

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

components/rich_text/render

Šis filtrs ļauj pielāgot <RichText /> satura izvadi. Tas saņem atribūta vērtību un bloku.

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

Bloku tagi

blockstudio/block_tags/builders

Šis filtrs reģistrē bloku masīvu veidotājus, ko izmanto bloku tagi un pielāgoti bloki, kas atlasīti, izmantojot blockstudio/parser/element_mapping. Katrs veidotājs saņem parsētus atribūtus un neapstrādātu iekšējo saturu.

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

Saderīgie filtri blockstudio/block_tags/renderers un blockstudio/parser/renderers tiek izpildīti pēc šī āķa un var pārrakstīt to pašu bloka nosaukumu.

blockstudio/block_tags/tag_aliases

Šis filtrs ļauj reģistrēt pielāgotus tagus ar defisēm, kas pirms neapstrādāta HTML rezerves risinājuma tiek sasaistīti ar īstiem bloku nosaukumiem. Tas noder, ja tēma vēlas īsu, projektam specifisku tagu kopu, vienlaikus atveidojot standarta Blockstudio vai pamatblokus.

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

Šis filtrs ļauj sasaistīt prefiksu saīsinājumus ar vienu vai vairākām bloku nosaukumvietām. Katra atslēga ir mazo burtu prefikss bez defisēm. Katra vērtība var būt nosaukumvietas virkne vai sakārtots nosaukumvietu saraksts.

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> tiek sasaistīts ar theme-components/card. <theme-button> vispirms izmēģina theme-components/button, pēc tam izmanto bsui/button kā rezerves variantu. Skaidri norādītiem blockstudio/block_tags/tag_aliases ierakstiem ir prioritāte attiecībā uz to pašu tagu, un nesasaistīti tagi ar prefiksu paliek nemainīti.

Prefiksus var kombinēt: ja tagu ar prefiksu nevar sasaistīt tieši un tā slug ir reģistrēts prefiksa tags, sasaistīšana tiek turpināta rekursīvi. Ar theme => ['theme-components'] un ui => ['bsui'] gadījumā <theme-ui-input> tiek turpināts ar prefiksu ui un tiek sasaistīts ar bsui/input. Reģistrētie prefiksu un aizstājvārdu tagi tiek atveidoti arī bloku veidņu izvadē, ne tikai lapas saturā.

Iestatījumi

ceļš

Šis filtrs ļauj pielāgot faila blockstudio.json ceļu. Pēc noklusējuma tas atrodas pašlaik aktīvās tēmas mapē blockstudio.json.

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

users/ids

Šis filtrs ļauj iespējot redaktoru noteiktiem lietotāju ID.

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

users/roles

Šis filtrs ļauj iespējot redaktoru noteiktām lietotāju lomām.

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

assets/enqueue

Šis filtrs ļauj iespējot vai atspējot līdzekļu pievienošanu rindai priekšgalā un redaktorā.

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

assets/reset/enabled

Šis filtrs ļauj iespējot vai atspējot pamatbloku stilu WordPress un redaktora utilītu izkārtojuma atiestatīšanas noņemšanu.

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

assets/reset/full_width

Šis filtrs ļauj noteikt, kuriem ziņu veidiem izmantot pilna platuma rediģēšanu.

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

assets/minify/css

Šis filtrs ļauj iespējot vai atspējot CSS minifikāciju.

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

assets/minify/js

Šis filtrs ļauj iespējot vai atspējot JS minifikāciju.

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

assets/process/scss

Šis filtrs ļauj iespējot vai atspējot SCSS apstrādi .css failos.

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

assets/process/scss_files

Šis filtrs ļauj iespējot vai atspējot .scss failu apstrādi līdz CSS.

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

assets/output

Šis filtrs ļauj noteikt, kur tiek rakstīti kompilētie bloku līdzekļi.

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

assets/inline_limit

Filtrē, cik baitu ārējā bloka CSS tiek iekļauts katras lapas kodā.

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

cache/enabled

Šis filtrs ļauj iespējot vai atspējot visas Blockstudio failu kešatmiņas izpildlaika un redaktora līdzekļiem.

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

cache/path

Šis filtrs ļauj mainīt Blockstudio failu kešatmiņas direktoriju.

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

cache/namespace_grace

Šis filtrs ļauj mainīt, cik ilgi tiek saglabāta novecojusi kešatmiņas nosaukumvieta, pirms tā tiek notīrīta.

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

githooks/commit

Šis filtrs norāda, vai Blockstudio pārvaldītais PHPStan saistību āķis ir iespējots.

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

content/enabled

Šis filtrs ļauj iespējot vai atspējot satura sinhronizāciju.

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

content/id

Šis filtrs ļauj iestatīt satura sinhronizācijas īpašumtiesību nosaukumvietu.

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

content/path

Šis filtrs ļauj iestatīt satura sinhronizācijas failu direktoriju.

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

content/include_page_sync_managed

Šis filtrs ļauj iekļaut vai izslēgt ar lapu sinhronizāciju pārvaldītās ziņas.

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

content/authors

Šis filtrs ļauj konfigurēt satura sinhronizācijas autoru apstrādi.

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

content/post_types

Šis filtrs ļauj konfigurēt satura sinhronizācijas atļauto ziņu veidu sarakstus.

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

content/taxonomies

Šis filtrs ļauj konfigurēt satura sinhronizācijas atļauto taksonomiju sarakstus.

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

content/media

Šis filtrs ļauj konfigurēt satura sinhronizācijas multivides apstrādi.

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

tailwind/enabled

Šis filtrs ļauj iespējot vai atspējot Tailwind.

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

tailwind/config

Šis filtrs ļauj pievienot pielāgotu Tailwind CSS konfigurāciju.

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

tailwind/output

Šis filtrs ļauj izvēlēties iegultu vai saistītu Tailwind CSS izvadi.

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

ui/enabled

Šis filtrs ļauj iespējot vai atspējot komplektā iekļautos UI komponentus.

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

editor/format_on_save

Šis filtrs ļauj iespējot vai atspējot koda formatēšanu saglabāšanas laikā.

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

editor/assets

Šis filtrs ļauj pievienot rindai papildu līdzekļus redaktorā.

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

editor/markup

Šis filtrs ļauj pievienot redaktora beigās papildu marķējumu.

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

block_editor/disable_loading

Šis filtrs ļauj atspējot bloku ielādi bloku redaktorā.

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

block_editor/enhance

Šis filtrs ļauj iespējot Blockstudio redaktora funkcijas, piemēram, tīrākus fokusa stilus un kontūras, kas norāda uz iezīmēšanu un atlasīšanu.

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

block_editor/css_classes

Šis filtrs ļauj pievienot stilu lapas, kuru klases varēs izvēlēties klašu laukā.

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

block_editor/css_variables

Šis filtrs ļauj pievienot stilu lapas, kuru CSS mainīgie būs pieejami koda lauka automātiskajai pabeigšanai.

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

block_editor/blocks/allow

Šis filtrs ļauj noteikt, kuri bloku nosaukumi ir pieejami ievietotājā.

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

block_editor/blocks/deny

Šis filtrs ļauj noņemt bloku nosaukumus no ievietotāja.

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

block_editor/blocks/directory

Šis filtrs ļauj iespējot vai atspējot WordPress bloku direktorijas līdzekļus redaktorā.

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

block_editor/blocks/categories/allow

Šis filtrs ļauj noteikt, kuri bloku kategoriju slug paliek pieejami.

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

block_editor/blocks/categories/deny

Šis filtrs ļauj noņemt bloku kategoriju slug no ievietotāja.

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

block_editor/blocks/categories/rename

Šis filtrs ļauj pārdēvēt bloku kategoriju etiķetes pēc slug.

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

block_editor/blocks/categories/order

Šis filtrs ļauj sakārtot bloku kategoriju slug ievietotājā.

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

block_editor/blocks/styles/deny

Šis filtrs ļauj atcelt pēc PHP reģistrēto bloku stilu reģistrāciju pēc bloka nosaukuma.

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

Šis filtrs ļauj paslēpt papildu mantotos logrīkus mantoto logrīku blokā.

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

block_editor/patterns/core

Šis filtrs ļauj iespējot vai atspējot WordPress pamatbloku paraugus.

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

block_editor/patterns/remote

Šis filtrs ļauj iespējot vai atspējot attālos paraugus no WordPress paraugu direktorijas.

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

block_editor/patterns/theme

Šis filtrs ļauj iespējot vai atspējot tēmas nodrošinātos bloku paraugus.

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

block_editor/patterns/blockstudio

Šis filtrs ļauj iespējot vai atspējot Blockstudio failu paraugus.

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

block_editor/patterns/categories/allow

Šis filtrs ļauj noteikt, kuri paraugu kategoriju slug paliek pieejami.

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

block_editor/patterns/categories/deny

Šis filtrs ļauj noņemt paraugu kategoriju slug no paraugu ievietotāja.

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

block_editor/patterns/categories/rename

Šis filtrs ļauj pārdēvēt paraugu kategoriju etiķetes pēc slug.

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

block_editor/patterns/categories/order

Šis filtrs ļauj sakārtot paraugu kategoriju slug ievietotājā.

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

block_editor/media/openverse

Šis filtrs ļauj iespējot vai atspējot Openverse multivides kategoriju bloku redaktora multivides ievietotājā.

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

block_editor/media/image_sizes/allow

Šis filtrs ļauj noteikt, kuri attēlu izmēru nosaukumi paliek pieejami redaktora multivides vadīklās.

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

block_editor/media/image_sizes/deny

Šis filtrs ļauj noņemt attēlu izmēru nosaukumus no redaktora multivides vadīklām.

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

ai/enable_context_generation

Šis filtrs ļauj iespējot vai atspējot konteksta faila ģenerēšanu LLM rīku integrācijai. Kad tas ir iespējots, konteksta fails vienā avotā apkopo atjauninātus bloku datus, pašreizējās instalācijas Blockstudio iestatījumus, visas attiecīgās shēmas un Blockstudio dokumentāciju, ko izmantot ar mākslīgā intelekta izstrādes rīkiem.

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

block_tags/enabled

Šis filtrs ļauj iespējot vai atspējot bloku tagu atveidošanu lapas līmenī.

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

block_tags/prefixes

Šis filtrs ļauj reģistrēt prefiksu un nosaukumvietu saīsinājumus bloku tagiem.

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

dev/grab/enabled

Šis filtrs ļauj iespējot vai atspējot elementu satvērēju.

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

dev/perf

Šis filtrs ļauj iespējot vai atspējot veiktspējas profilētāju.

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

dev/canvas/enabled

Šis filtrs ļauj iespējot vai atspējot kanvu.

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

dev/canvas/admin_bar

Šis filtrs ļauj rādīt vai paslēpt WordPress administrēšanas joslu kanvā.

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

WPML

blockstudio/wpml/config/label

Filtrē katras atslēgas etiķeti, ko raksta wp bs wpml config. Skatiet Etiķešu maiņa konteksta masīvam.

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

Kanva

blockstudio/canvas/inventory

Šis filtrs pielāgo kanvas sniegto atlases inventāru. Atzvanīšanas funkcija saņem inventāra DTO, sākotnējo atlasi un tai nodotās opcijas.

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

blockstudio/canvas/documents

Šis filtrs pielāgo kanvas atgrieztos atveidotos dokumentus, un tam ir tie paši trīs argumenti kā inventāra filtram.

blockstudio/canvas/item_loaded

Šī darbība tiek izpildīta, ielādējot katru inventāra ierakstu. Tā saņem inventāra tipu, kanonisko ieraksta ID un normalizēto ierakstu.

blockstudio/canvas/source_compiled

Šī darbība tiek izpildīta pēc avota faila kompilēšanas kanvai. Tā saņem atlasīto avota ceļu un kanonisko avota ierakstu.

Komplektā iekļautie UI

blockstudio/ui/directories

Šis filtrs pielāgo direktorijas, kurās tiek meklēti komplektā iekļautie UI komponenti.

blockstudio/ui/inventory

Šis filtrs pielāgo publisko UI saimes inventāru.

blockstudio/ui/examples

Šis filtrs pielāgo UI paraugu ierakstus un saņem paraugus un publisko UI inventāru, no kura tie tika iegūti.

Topoloģija

blockstudio/blocks/topology_refreshed

Šī darbība tiek izpildīta pēc bloku topoloģijas atjaunošanas.

blockstudio/pages/topology_refreshed

Šī darbība tiek izpildīta pēc lapas topoloģijas atjaunošanas.

blockstudio/pages/layout_error

Šī darbība tiek izpildīta, ja lapas izkārtojuma atveidošana neizdodas, lai kļūda netiktu noklusēta.

Izpildlaiks

blockstudio/runtime/initialized

Šī darbība tiek izpildīta, tiklīdz izpildlaikā ir atrasta konfigurācija.

blockstudio/runtime/changed

Šī darbība tiek izpildīta, kad mainās atrastā izpildlaika identitāte, tādējādi mainot kešatmiņas nosaukumvietas un statiskās priekšatveides stāvokli.

blockstudio/performance/default_config

Šis filtrs pielāgo veiktspējas noklusējuma iestatījumus, pirms tiem tiek pievienotas projekta vērtības blockstudio.json.

Saturs

blockstudio/content/orphan_action

Šis filtrs nosaka, ko satura sinhronizācija dara ar ierakstu, kuram vairs nav avota.

Bootstrap

blockstudio/url

Šis filtrs maina publisko URL, ko Blockstudio izmanto redaktora un administrēšanas līdzekļiem. Composer integrācijām tas jāreģistrē pirms Blockstudio automātiskās ielādes faila ielādes. Otrais arguments ir fiziskā pakotnes direktorija.

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

Izpildlaika kešatmiņa

blockstudio/cache/dir

Šis filtrs saņem atrasto kešatmiņas pamata direktoriju, pirms tai tiek pievienota izpildlaika, redaktora līdzekļu vai cita kešatmiņas apgabala apakšdirektorija.

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

blockstudio/cache/context

Šis filtrs kešatmiņas identitātēm pievieno serializējamu izpildlaika variantu. Izmantojiet to, ja viens un tas pats atklāšanas avots var atlasīt atšķirīgus loģiskos inventārus.

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

Šis filtrs maina tīkla/emuāra direktorijas identitāti resursdatoriem ar savu nomnieka robežu. Atgrieztā vērtība pirms izmantošanas tiek attīrīta.

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

Šis filtrs pievieno resursdatora faktus, kas ietekmē ikvienu objektu izpildlaika apgabalā. Konkrētam vienumam specifiski avota pirkstu nospiedumi tā vietā ir jānodod kā skaidras atkarības, ko norāda atbildīgais 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

Filtrē, cik sekundes validētu failu pārraudzības momentuzņēmumu var izmantot atkārtoti bez jaunas failu sistēmas statusa pārbaudes. Noklusējums lokālajā un izstrādes vidē ir 0, bet citur — 20.

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

blockstudio/cache/build_wait_budget

Filtrē, cik ilgi milisekundēs pieprasījums gaida, kamēr vienlaicīgs veidotājs publicē izpildlaika kešatmiņu vai atjaunina aizpildītās izvēles, pirms tiek izmantots rezerves variants. Noklusējums strukturālai atjaunošanai ir 5000, bet izvēļu atjaunošanai — 4000.

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

blockstudio/cache/populate_debounce

Filtrē, cik sekundes satura, terminu, lietotāju vai metadatu ierakstu sērija tiek apvienota vienā aizpildīto izvēļu atjaunināšanā. Pirmais ieraksts pēc klusuma perioda izraisa tūlītēju atjaunināšanu; pēdējais ieraksts sērijā tiek atspoguļots pēc norādītā laika loga. Noklusējums ir 30. Atgrieziet 0, lai atjauninātu pēc katra ieraksta.

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

blockstudio/cache/populate_ignored_meta_keys

Filtrē meta atslēgas, kuru vērtību ierakstīšana nekad neatjauno aizpildītās izvēles. Pēc noklusējuma tās ir atslēgas, ko WordPress raksta kā rediģēšanas un pieteikšanās uzskaites datus: _edit_lock, ko atjauno redaktors un Heartbeat, kamēr ziņa ir atvērta, _edit_last, ko ieraksta līdztekus ziņas saglabāšanai, kas jau veic atjaunošanu, un session_tokens, ko ieraksta, piesakoties un atsakoties. Pievienojiet atslēgas, kas bieži mainās, bet nekad neietekmē aizpildīšanas vaicājumu.

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

blockstudio/cache/max_files_per_scope

Filtrē, cik publicētu datu kopu saglabā katrs izpildlaika kešatmiņas apgabals.

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

blockstudio/cache/compress

Filtrē, vai kešatmiņas datu kopā tiek izmantoti saspiesti serializēti dati, nevis parasts PHP masīvs. Pēc noklusējuma vienkāršajā formātā tiek glabātas tikai datu kopas, kuru lielums nepārsniedz 1 MiB, turklāt tikai tad, ja galamērķi var saglabāt aktīvās OPcache koplietojamajā atmiņā. Citi procesi, izslēgtie faili un lielākas datu kopas tiek saspiestas.

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

Atgriežot false, tiek atcelts arī izmēra ierobežojums. Tas var palīdzēt, ja WP-CLI bez opcache.enable_cli iesilda failus OPcache iespējotiem tīmekļa darbinātājiem, taču katram lasītājam bez OPcache būs jāparsē ģenerētais masīvs. Lielām koplietojamām datu kopām izmantojiet saspiešanu, ja vien papildu atmiņas izmaksas nav pieņemamas. Informāciju par noklusējuma aizsardzības ierobežojumiem skatiet kešatmiņas datu kopu formāti.

blockstudio/cache/protected_paths

Kešatmiņas ceļu notīrīšana nedrīkst nekad noņemt. Blockstudio aizpilda šo sarakstu ar visiem failiem, uz kuriem atsaucas instalētā agrīnās apkalpošanas karte.

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

Šī darbība ziņo par koplietojamu kešatmiņas apgabalu un rezultātu, piemēram, hit, build, miss-stale, stale-last-good vai 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

Šis filtrs saņem galīgo lēmumu par anonīmu drošību, kā arī servera un sīkdatņu ievaddatus. Atgriežot true, vienmēr tiek apieta statiskā apkalpošana un ģenerēšana.

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

Šis filtrs nodrošina vai pielāgo pilnu publisko URL inventāru, ko izmanto ieplānotais sildītājs un tieši izmantotie grafu rīki.

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

Filtra atgrieztais rezultāts nav galīgais inventārs. Tas tiek nodots kešatmiņā ievietojamības pārbaudei, kas izmet visu, kas atbilst konfigurētam dinamiskajam ceļam, un visu, kas pēc noklusējuma tiek apiets: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, jebkuru ceļu, kurā ir /feed/, kā arī meklēšanas rezultātus zem meklēšanas pamata vietnes sākumceļā (pēc noklusējuma /search/). Tāpēc jūsu pievienoto URL var atmest bez brīdinājuma. Ja būvētajā inventārā trūkst gaidītā maršruta, pirms pieņemat, ka filtrs nav darbojies, pārbaudiet, vai uz to attiecas šie noteikumi.

blockstudio/static_prerender/render_internal

Šis filtrs nodrošina neobligāto pakešu transportu procesā. Atgrieziet normalizētu rezultātu masīvu vai atstājiet vērtību nemainītu, lai renderētājs izmantotu konfigurēto HTTP rezerves variantu. Rezultātā ir html un pēc izvēles arī status, dependencies, virtualHashes un headers; galvenes, kas nosauktas sadaļā performance.staticPrerender.replayHeaders, tiek saglabātas kopā ar dokumentu.

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

Šis filtrs pieņem galīgo lēmumu pēc tam, kad Blockstudio pārbauda, vai izvade ir pilnīgs HTML dokuments bez kešatmiņas atspējošanas marķiera un vai novērotais atbildes statuss norāda uz panākumiem. Trešais arguments ir novērotais statuss vai null, ja statuss nav norādīts.

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

Šī darbība ziņo par statiskās priekšatveides rezultātiem, tostarp trāpījumiem, netrāpījumiem, ierakstēm, grafa ierakstēm, novecojušiem ierakstiem un kļūmēm.

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

blockstudio/tailwind/cache_max_files

Filtrē kompilēto Tailwind CSS ierakstu maksimālo skaitu. Noklusējums ir 1000.

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

blockstudio/tailwind/cache_max_age

Filtrē kompilēto Tailwind CSS ierakstu maksimālo vecumu sekundēs. Noklusējums ir 30 dienas, bet minimums — viena stunda.

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

Administrēšana

iespējots

Šis filtrs ļauj iespējot vai atspējot Blockstudio administrēšanas lapu sadaļā Rīki > Blockstudio.

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

Līdzekļi

editor/canvas/body_class

Kad līdzekļu atiestatīšana ir iespējota, šis filtrs pielāgo attīrītās priekšgala pamatdaļas klases, kas tiek kopētas uz bloku redaktora kanvu.

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

iespējot

Šis filtrs ļauj atspējot konkrēta līdzekļa veida apstrādi un pievienošanu rindai.

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

atspējot

Šis filtrs ļauj atspējot konkrētus līdzekļus pēc to ID. Līdzekļi, kuru ID ir atgrieztajā masīvā, priekšgalā netiks atveidoti.

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

process/scss/import_paths

Šis filtrs ļauj pievienot papildu ceļus SCSS kompilatora @import priekšrakstam.

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

process/scss/prelude

Šis filtrs ļauj katra SCSS faila kompilēšanas laikā pievienot sākumā koplietojamu Sass kodu.

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

Šis filtrs ļauj pielāgot faila CSS saturu pirms tā kompilēšanas.

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

process/js/content

Šis filtrs ļauj pielāgot faila JS saturu pirms tā kompilēšanas.

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

Buferis

iespējots

Blockstudio buferē priekšgala atbildi, lai pamatdaļā atveidotās bloku stila un skriptu birkas varētu pārvietot uz galveni un kājeni un lai Tailwind varētu skenēt visu dokumentu. Buferēšana nozīmē visa dokumenta glabāšanu un skenēšanu katrā priekšgala pieprasījumā; vietne, kas neatveido Blockstudio bloku līdzekļus un neizmanto Tailwind, var atgriezt false, lai izlaistu abas darbības.

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

Administrēšanas saskarnē un Customizer priekšskatījumā buferizācija arī ir izslēgta. Izsauciet bs_is_buffering() no wp_enqueue_scripts vai jaunākas versijas, lai noskaidrotu, vai pašreizējā atbilde tiek buferizēta. Pirms lēmuma pieņemšanas pie template_redirect funkcija atgriež false.

izvade

Šis filtrs saņem pilnu buferēto HTML dokumentu pirms tā nosūtīšanas. Blockstudio paša līdzekļu pārvietošana notiek ar prioritāti 1000000, bet Tailwind kompilēšana — ar prioritāti 999999, tāpēc izpildiet to agrāk, lai redzētu dokumentu pirms šīm darbībām, vai vēlāk, lai redzētu galīgo izvadi.

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

Atveidošana

atkarības

Šis filtrs ziņo par atlasītās veidnes un līdzekļu atkarībām ikreiz, kad Blockstudio atveido bloku. Tas noder statiskajiem eksportētājiem un citiem iekšprocesa atkarību apkopotājiem.

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

globāls

Šis filtrs ļauj pielāgot lapas izvadi pirms tās atveidošanas.

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

Šis filtrs ļauj pielāgot <head> taga izvadi pirms tā renderēšanas. Tas darbojas tikai tad, ja Blockstudio buferizē atbildi; skatiet bs_is_buffering().

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

Šis filtrs ļauj pielāgot </body> izvadi pirms tās atveidošanas.

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

Kļūdu apstrāde

error/logged

Darbība tiek izpildīta pēc kļūdas reģistrēšanas. Izmantojiet to, lai nosūtītu kļūdas uz ārējiem reģistrēšanas pakalpojumiem.

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

error/exception

Darbība tiek izpildīta pēc izņēmuma apstrādes.

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

Datubāze

Visi datubāzes āķi saņem vienu $params masīvu.

db/before_create

Darbība tiek izpildīta pirms ieraksta izveides.

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

db/after_create

Darbība tiek izpildīta pēc ieraksta izveides.

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

Darbība tiek izpildīta pirms ieraksta atjaunināšanas.

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

db/after_update

Darbība tiek izpildīta pēc ieraksta atjaunināšanas.

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

db/before_delete

Darbība tiek izpildīta pirms ieraksta dzēšanas.

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

db/after_delete

Darbība tiek izpildīta pēc ieraksta dzēšanas.

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

RPC

Visi RPC āķi saņem vienu $params masīvu.

rpc/before_call

Darbība tiek izpildīta pirms funkcijas RPC izsaukšanas.

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

rpc/after_call

Darbība tiek izpildīta pēc funkcijas RPC izsaukšanas.

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