Kavlji PHP
Spodaj je seznam vseh razpoložljivih kavljev PHP, s katerimi lahko razširite ali prilagodite delovanje vtičnika.
Pot
S tem filtrom lahko prilagodite pot do mape bloka. Privzeto je to blockstudio znotraj trenutno aktivne teme. Lahko pa ustvarite nov primerek za več izvornih map.
add_filter('blockstudio/path', function() {
$path = get_stylesheet_directory() . '/blocks';
return $path;
});
Inicializacija
Globalno
To dejanje se sproži, ko vtičnik registrira vse bloke.
add_action('blockstudio/init', function($blocks) {
// All blocks have been registered
});
Primerek
To dejanje se sproži, ko vtičnik registrira vse bloke določenega
primerka.
Segment $instance je pot primerka glede na wp-content.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/$instance", function() {
// All blocks of this instance have been registered
});
global/before
To dejanje se sproži, preden vtičnik registrira vse bloke.
add_action('blockstudio/init/before', function() {
// Before blocks are registered
});
global/before/$instance
To dejanje se sproži, preden vtičnik registrira vse bloke določenega primerka.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/before/$instance", function() {
// Before blocks of this instance are registered
});
Bloki
Izris
S tem filtrom lahko prilagodite izhod bloka pred njegovim izrisom.
add_filter('blockstudio/blocks/render', function($content, $block, $attributes) {
// Modify the block content
return $content;
}, 10, 3);
Metapodatki
S tem filtrom lahko prilagodite podatke datoteke block.json, preden je registrirana.
add_filter('blockstudio/blocks/meta', function($meta, $block) {
if (str_starts_with($block['name'], 'marketing')) {
$meta['icon'] = 'megaphone';
}
return $meta;
}, 10, 2);
Zgornja koda bi spremenila ikono vseh blokov, katerih ime se začne z marketing.
Pogoji
Ta filter omogoča dodajanje pogojev po meri, ki jih lahko uporabljate v blokih. Vsaka vrsta pogoja je povezana z vrednostjo, ki jo urejevalnik primerja z vrednostjo value pogoja. Glejte Pogoji po meri.
add_filter('blockstudio/blocks/conditions', function($conditions) {
$conditions['myCustomCondition'] = 'expected';
return $conditions;
});
Atributi
Ta filter spremeni definicijo enega polja pred registracijo bloka. Filtrirana definicija določa kontrolnik urejevalnika in preverjanje veljavnosti vrednosti med izrisom. Več informacij najdete v razdelku Filtriranje.
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
// Modify this field definition before registration.
return $attribute;
}, 10, 2);
attributes/render
Ta filter prilagodi vrednost posameznega polja, preden jo posreduje predlogi bloka. Zažene se enkrat za vsako polje in prejme tri argumente: $value (razrešena vrednost), $key (ključ polja, kot se uporablja v $a) in $block (polje s podatki bloka, ki ga predloge prejmejo kot $block ali $b). Registrirajte ga s tremi sprejetimi argumenti. Za več informacij glejte Filtriranje.
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
Polje files za vsako sliko vrne tudi polje sizes, ki vsebuje URL, širino in višino slike full ter vseh registriranih velikosti slik, na primer $image['sizes']['thumbnail'] in $image['sizes']['thumbnail-width']. Za vsako velikost se izvede en klic wp_get_attachment_image_src() na sliko, zato zanjo še vedno veljajo filtri. Predloge, ki nikoli ne berejo sizes, lahko seznam izpustijo ali skrajšajo.
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 imen velikosti, najprej full (prazen, če niso registrirane nobene vmesne velikosti). $id je ID priloge, $size pa velikost, zahtevana za vrednostni url. Filter spremeni polje sizes vsake vrednosti vrste files v zahtevi. Brez njega polje ostane nespremenjeno.
Imena velikosti vrnite kot nize. Neveljavne vnose prezre, podvojena imena pa razreši samo enkrat. Če vrnjena vrednost ni polje, velikosti preskoči. Zahtevana url in druge lastnosti priloge ostanejo nespremenjene. Ta kavelj se ne izvede za polje files z returnFormat: "url", ki ne zgradi zemljevida velikosti.
attributes/validate
Prilagodite ugotovitve iz izrecnih klicev bs_validate_block(), na primer kadar filter za upodabljanje po meri razreši shranjene sklice. To ne omogoči samodejnega preverjanja ob shranjevanju ali upodabljanju.
add_filter('blockstudio/blocks/attributes/validate', function($findings, $name, $attrs) {
return $findings;
}, 10, 3);
Vrnite seznam ugotovitev. Filter se ne pokliče, kadar blok nima polj Blockstudio ali ustreznih razširitev (null).
attributes/schema
Prilagodite shemo JSON, ki jo vrne filter bs_block_schema(), na primer kadar filter za upodabljanje po meri razreši shranjene reference.
add_filter('blockstudio/blocks/attributes/schema', function($schema, $name) {
return $schema;
}, 10, 2);
Vrne polje sheme. Filter se ne pokliče, če blok nima polj Blockstudio ali ustreznih razširitev (null).
attributes/populate
S tem filtrom lahko podatke po meri dodate med možnosti polja checkbox,
select ali radio. Več informacij najdete v razdelku Polnjenje možnosti.
Filter prejme en argument: polje vseh naborov podatkov po meri, indeksiranih
po imenu, uporabljenem v "populate": {"type": "custom", "custom": "myCustomOptions"}.
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
S tem filtrom lahko prilagodite izhod vsebine useBlockProps.
Vsi filtri komponent (use_block_props, inner_blocks in rich_text) prejmejo blok kot zadnji argument. $block je WP_Block_Type, registriran za blok, ki se upodablja, zato je $block->name ime bloka, na primer acme/hero.
$props je niz atributov HTML, ne polje. Na sprednjem delu je rezultat get_block_wrapper_attributes(), na primer class="wp-block-acme-hero my-class". V urejevalniku je to atribut class elementa. Vrnite niz. V urejevalniku se uporabi samo atribut class vrnjenega niza.
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
S tem filtrom lahko prilagodite izhod vsebine <InnerBlocks />.
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
S tem filtrom lahko odstranite ovoj <InnerBlocks /> z vmesnika.
add_filter('blockstudio/blocks/components/inner_blocks/frontend/wrap', function($wrap, $block) {
return false; // Remove wrapper
}, 10, 2);
components/rich_text/render
Ta filter vam omogoča prilagoditev izhoda vsebine <RichText />. Prejme vrednost atributa in blok.
add_filter('blockstudio/blocks/components/rich_text/render', function($content, $block) {
return wp_kses_post($content);
}, 10, 2);
Oznake blokov
blockstudio/block_tags/builders
Ta filter registrira gradnike polj blokov, ki jih uporabljajo oznake blokov in bloki po meri, izbrani prek blockstudio/parser/element_mapping. Vsak gradnik prejme razčlenjene atribute in neobdelano notranjo vsebino.
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);
Združljiva filtra blockstudio/block_tags/renderers in
blockstudio/parser/renderers se sprožita po tej kljuki in lahko preglasita isto ime bloka.
blockstudio/block_tags/tag_aliases
Ta filter omogoča registracijo oznak za urejanje po meri z vezaji, ki se pred nadomestnim postopkom za neobdelani HTML razrešijo v prava imena blokov. Uporaben je, kadar tema želi kratke oznake, specifične za projekt, hkrati pa še vedno prikazuje standardne bloke Blockstudio ali jedrne bloke.
add_filter('blockstudio/block_tags/tag_aliases', function($aliases) {
$aliases['theme-button'] = 'bsui/button';
$aliases['theme-card'] = 'theme/card';
return $aliases;
});
<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
Ta filter omogoča preslikavo okrajšav predpon v eno ali več imenskih področij blokov. Vsak ključ je predpona z malimi črkami, brez vezajev. Vsaka vrednost je lahko niz z imenskim področjem ali urejen seznam imenskih področij.
add_filter('blockstudio/block_tags/prefixes', function($prefixes) {
$prefixes['theme'] = ['theme-components', 'bsui'];
return $prefixes;
});
<theme-card title="Homepage" />
<theme-button label="Get started" />
<theme-ui-feature-matrix />
<theme-card> se razreši v theme-components/card. <theme-button> najprej poskusi theme-components/button, nato pa uporabi bsui/button. Izrecni vnosi blockstudio/block_tags/tag_aliases imajo prednost pri isti oznaki, nerazrešene oznake s predpono pa ostanejo nespremenjene.
Predpone se lahko sestavljajo: če oznake s predpono ni mogoče razrešiti neposredno, njena oznaka pa je sama registrirana kot oznaka s predpono, se razreševanje nadaljuje rekurzivno. Z theme => ['theme-components'] in ui => ['bsui'] se <theme-ui-input> preusmeri na predpono ui in razreši v bsui/input. Registrirane oznake predpon in vzdevkov se izrišejo tudi v izhodu predloge bloka, ne le v vsebini strani.
Nastavitve
pot
Ta filter omogoča prilagajanje poti do datoteke blockstudio.json. Privzeto je ta datoteka v blockstudio.json znotraj trenutno aktivne teme.
add_filter('blockstudio/settings/path', function() {
return get_stylesheet_directory() . '/config/blockstudio.json';
});
users/ids
Ta filter omogoča vklop urejevalnika za določene ID-je uporabnikov.
add_filter('blockstudio/settings/users/ids', function() {
return [1];
});
users/roles
Ta filter omogoča vklop urejevalnika za določene uporabniške vloge.
add_filter('blockstudio/settings/users/roles', function() {
return ['administrator', 'editor'];
});
assets/enqueue
Ta filter omogoča vklop ali izklop dodajanja sredstev v čakalno vrsto na zunanjem delu in v urejevalniku.
add_filter('blockstudio/settings/assets/enqueue', function() {
return false;
});
assets/reset/enabled
Ta filter omogoča vklop ali izklop odstranitve slogov jedrnih blokov WordPress in ponastavitve postavitve pripomočkov urejevalnika.
add_filter('blockstudio/settings/assets/reset/enabled', function() {
return true;
});
assets/reset/full_width
Ta filter omogoča nadzor nad vrstami objav, ki uporabljajo urejanje v polni širini.
add_filter('blockstudio/settings/assets/reset/full_width', function() {
return ['page'];
});
assets/minify/css
Ta filter omogoča vklop ali izklop pomanjševanja CSS.
add_filter('blockstudio/settings/assets/minify/css', function() {
return true;
});
assets/minify/js
Ta filter omogoča vklop ali izklop pomanjševanja JS.
add_filter('blockstudio/settings/assets/minify/js', function() {
return true;
});
assets/process/scss
Ta filter omogoča vklop ali izklop obdelave SCSS v datotekah .css.
add_filter('blockstudio/settings/assets/process/scss', function() {
return true;
});
assets/process/scss_files
Ta filter omogoča vklop ali izklop obdelave datotek .scss v CSS.
add_filter('blockstudio/settings/assets/process/scss_files', function() {
return true;
});
assets/output
Ta filter omogoča nadzor nad mestom shranjevanja prevedenih sredstev blokov.
add_filter('blockstudio/settings/assets/output', function() {
return 'cache';
});
assets/inline_limit
S tem filtrom določite, koliko bajtov zunanjega bloka CSS se vstavi v vsako stran.
add_filter('blockstudio/settings/assets/inline_limit', function() {
return 40000;
});
cache/enabled
Ta filter omogoča vklop ali izklop vseh predpomnilnikov izvajalnega okolja in sredstev urejevalnika Blockstudio, ki temeljijo na datotekah.
add_filter('blockstudio/settings/cache/enabled', function() {
return false;
});
cache/path
Ta filter omogoča spreminjanje imenika predpomnilnika Blockstudio, ki temelji na datotekah.
add_filter('blockstudio/settings/cache/path', function() {
return 'cache/blockstudio';
});
cache/namespace_grace
Ta filter omogoča spreminjanje časa hrambe umaknjenega imenskega prostora predpomnilnika, preden se počisti.
add_filter('blockstudio/settings/cache/namespace_grace', function() {
return 777600;
});
githooks/commit
Ta filter razkrije, ali je omogočena kljuka za potrditev PHPStan, ki jo upravlja Blockstudio.
add_filter('blockstudio/settings/githooks/commit', function() {
return true;
});
content/enabled
Ta filter omogoča vklop ali izklop sinhronizacije vsebine.
add_filter('blockstudio/settings/content/enabled', function() {
return true;
});
content/id
Ta filter omogoča nastavitev imenskega prostora za lastništvo sinhronizacije vsebine.
add_filter('blockstudio/settings/content/id', function() {
return 'docs';
});
content/path
Ta filter omogoča nastavitev imenika datotek za sinhronizacijo vsebine.
add_filter('blockstudio/settings/content/path', function() {
return 'content';
});
content/include_page_sync_managed
Ta filter omogoča vključitev ali izključitev objav, ki jih upravlja sinhronizacija strani.
add_filter('blockstudio/settings/content/include_page_sync_managed', function() {
return false;
});
content/authors
Ta filter omogoča nastavitev obravnave avtorjev pri sinhronizaciji vsebine.
add_filter('blockstudio/settings/content/authors', function() {
return 'ignore';
});
content/post_types
Ta filter omogoča nastavitev dovoljenih seznamov vrst objav za sinhronizacijo vsebine.
add_filter('blockstudio/settings/content/post_types', function() {
return ['team_member'];
});
content/taxonomies
Ta filter omogoča nastavitev dovoljenih seznamov taksonomij za sinhronizacijo vsebine.
add_filter('blockstudio/settings/content/taxonomies', function() {
return ['category', 'post_tag'];
});
content/media
Ta filter omogoča nastavitev obravnave predstavnosti pri sinhronizaciji vsebine.
add_filter('blockstudio/settings/content/media', function() {
return 'manifest';
});
tailwind/enabled
Ta filter omogoča vklop ali izklop Tailwind.
add_filter('blockstudio/settings/tailwind/enabled', function() {
return true;
});
tailwind/config
Ta filter omogoča dodajanje konfiguracije Tailwind CSS po meri.
add_filter('blockstudio/settings/tailwind/config', function() {
return '@theme { --color-primary: pink; }';
});
tailwind/output
Ta filter omogoča izbiro med vdelanim izhodom Tailwind CSS in izhodom s povezavo.
add_filter('blockstudio/settings/tailwind/output', function() {
return 'link';
});
ui/enabled
Ta filter omogoča vklop ali izklop vključenih komponent UI.
add_filter('blockstudio/settings/ui/enabled', function() {
return true;
});
editor/format_on_save
Ta filter omogoča vklop ali izklop oblikovanja kode ob shranjevanju.
add_filter('blockstudio/settings/editor/format_on_save', function() {
return true;
});
editor/assets
Ta filter omogoča dodajanje dodatnih sredstev v čakalno vrsto urejevalnika.
add_filter('blockstudio/settings/editor/assets', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
editor/markup
Ta filter omogoča dodajanje dodatnih oznak na konec urejevalnika.
add_filter('blockstudio/settings/editor/markup', function() {
return '<style>body { background: black; }</style>';
});
block_editor/disable_loading
Ta filter omogoča onemogočanje nalaganja blokov v urejevalniku blokov.
add_filter('blockstudio/settings/block_editor/disable_loading', function() {
return true;
});
block_editor/enhance
Ta filter omogoča vklop pripomočkov urejevalnika Blockstudio, kot so preglednejši slogi fokusa ter obrisi ob pomiku in izbiri.
add_filter('blockstudio/settings/block_editor/enhance', function() {
return true;
});
block_editor/css_classes
Ta filter omogoča dodajanje slogovnih datotek, katerih razredi bodo na voljo za izbiro v polju razreda.
add_filter('blockstudio/settings/block_editor/css_classes', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/css_variables
Ta filter omogoča dodajanje slogovnih datotek, katerih spremenljivke CSS bodo na voljo za samodokončanje v polju kode.
add_filter('blockstudio/settings/block_editor/css_variables', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/blocks/allow
Ta filter omogoča nadzor nad imeni blokov, dovoljenimi v vstavljalniku.
add_filter('blockstudio/settings/block_editor/blocks/allow', function() {
return ['core/*', 'acf/*', 'my-theme/*'];
});
block_editor/blocks/deny
Ta filter omogoča odstranjevanje imen blokov iz vstavljalnika.
add_filter('blockstudio/settings/block_editor/blocks/deny', function() {
return ['core/embed', 'core/freeform'];
});
block_editor/blocks/directory
Ta filter omogoča vklop ali izklop sredstev imenika blokov WordPress v urejevalniku.
add_filter('blockstudio/settings/block_editor/blocks/directory', function() {
return false;
});
block_editor/blocks/categories/allow
Ta filter omogoča nadzor nad oznakami kategorij blokov, ki ostanejo na voljo.
add_filter('blockstudio/settings/block_editor/blocks/categories/allow', function() {
return ['text', 'media', 'design'];
});
block_editor/blocks/categories/deny
Ta filter omogoča odstranjevanje oznak kategorij blokov iz vstavljalnika.
add_filter('blockstudio/settings/block_editor/blocks/categories/deny', function() {
return ['embed'];
});
block_editor/blocks/categories/rename
Ta filter omogoča preimenovanje oznak kategorij blokov glede na oznako.
add_filter('blockstudio/settings/block_editor/blocks/categories/rename', function() {
return [
'text' => 'Writing',
'design' => 'Layout'
];
});
block_editor/blocks/categories/order
Ta filter omogoča razvrščanje oznak kategorij blokov v vstavljalniku.
add_filter('blockstudio/settings/block_editor/blocks/categories/order', function() {
return ['my-theme', 'text', 'media'];
});
block_editor/blocks/styles/deny
Ta filter omogoča odregistracijo slogov blokov, registriranih z PHP, glede na ime bloka.
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
Ta filter omogoča skrivanje dodatnih podedovanih gradnikov iz bloka podedovanih gradnikov.
add_filter('blockstudio/settings/block_editor/blocks/legacy_widgets/hide', function() {
return ['archives', 'calendar'];
});
block_editor/patterns/core
Ta filter omogoča vklop ali izklop jedrnih vzorcev blokov WordPress.
add_filter('blockstudio/settings/block_editor/patterns/core', function() {
return false;
});
block_editor/patterns/remote
Ta filter omogoča vklop ali izklop oddaljenih vzorcev iz imenika vzorcev WordPress.
add_filter('blockstudio/settings/block_editor/patterns/remote', function() {
return false;
});
block_editor/patterns/theme
Ta filter omogoča vklop ali izklop vzorcev blokov, ki jih zagotavlja tema.
add_filter('blockstudio/settings/block_editor/patterns/theme', function() {
return false;
});
block_editor/patterns/blockstudio
Ta filter omogoča vklop ali izklop vzorcev Blockstudio, ki temeljijo na datotekah.
add_filter('blockstudio/settings/block_editor/patterns/blockstudio', function() {
return false;
});
block_editor/patterns/categories/allow
Ta filter omogoča nadzor nad oznakami kategorij vzorcev, ki ostanejo na voljo.
add_filter('blockstudio/settings/block_editor/patterns/categories/allow', function() {
return ['featured', 'buttons', 'columns'];
});
block_editor/patterns/categories/deny
Ta filter omogoča odstranjevanje oznak kategorij vzorcev iz vstavljalnika vzorcev.
add_filter('blockstudio/settings/block_editor/patterns/categories/deny', function() {
return ['gallery'];
});
block_editor/patterns/categories/rename
Ta filter omogoča preimenovanje oznak kategorij vzorcev glede na oznako.
add_filter('blockstudio/settings/block_editor/patterns/categories/rename', function() {
return [
'featured' => 'Featured Layouts'
];
});
block_editor/patterns/categories/order
Ta filter omogoča razvrščanje oznak kategorij vzorcev v vstavljalniku.
add_filter('blockstudio/settings/block_editor/patterns/categories/order', function() {
return ['featured', 'buttons'];
});
block_editor/media/openverse
Ta filter omogoča vklop ali izklop kategorije predstavnosti Openverse v vstavljalniku predstavnosti urejevalnika blokov.
add_filter('blockstudio/settings/block_editor/media/openverse', function() {
return false;
});
block_editor/media/image_sizes/allow
Ta filter omogoča nadzor nad imeni velikosti slik, ki ostanejo na voljo v kontrolnikih predstavnosti urejevalnika.
add_filter('blockstudio/settings/block_editor/media/image_sizes/allow', function() {
return ['thumbnail', 'large'];
});
block_editor/media/image_sizes/deny
Ta filter omogoča odstranjevanje imen velikosti slik iz kontrolnikov predstavnosti urejevalnika.
add_filter('blockstudio/settings/block_editor/media/image_sizes/deny', function() {
return ['medium_large'];
});
ai/enable_context_generation
Ta filter omogoča vklop ali izklop ustvarjanja kontekstne datoteke za integracijo orodij LLM. Ko je omogočena, kontekstna datoteka združi posodobljene podatke o blokih, nastavitve Blockstudio trenutne namestitve, vse ustrezne sheme in dokumentacijo Blockstudio v en vir za uporabo z orodji za razvoj z UI.
add_filter('blockstudio/settings/ai/enable_context_generation', function() {
return true;
});
block_tags/enabled
Ta filter omogoča vklop ali izklop izrisovanja oznak blokov na ravni strani.
add_filter('blockstudio/settings/block_tags/enabled', function() {
return true;
});
block_tags/prefixes
Ta filter omogoča registracijo okrajšav, ki preslikajo predpone v imenska področja za oznake blokov.
add_filter('blockstudio/settings/block_tags/prefixes', function() {
return [
'theme' => ['theme-components', 'bsui']
];
});
dev/grab/enabled
Ta filter omogoča vklop ali izklop prijemala elementov.
add_filter('blockstudio/settings/dev/grab/enabled', function() {
return false;
});
dev/perf
Ta filter omogoča vklop ali izklop profilatorja zmogljivosti.
add_filter('blockstudio/settings/dev/perf', function() {
return false;
});
dev/canvas/enabled
Ta filter omogoča vklop ali izklop platna.
add_filter('blockstudio/settings/dev/canvas/enabled', function() {
return false;
});
dev/canvas/admin_bar
Ta filter omogoča prikaz ali skrivanje skrbniške vrstice WordPress na platnu.
add_filter('blockstudio/settings/dev/canvas/admin_bar', function() {
return true;
});
WPML
blockstudio/wpml/config/label
Filtrira oznako vsakega ključa, ki ga zapiše wp bs wpml config. Za kontekstno polje glejte Spremenite oznake.
add_filter('blockstudio/wpml/config/label', function($label, $context) {
return str_replace(' (optional)', '', $label);
}, 10, 2);
Platno
blockstudio/canvas/inventory
Ta filter prilagodi podatke o inventarju, ki jih Canvas vrne za izbor. Povratni klic prejme objekt DTO inventarja, prvotni izbor in možnosti, s katerimi je bil poklican.
add_filter('blockstudio/canvas/inventory', function(array $result, array $selection, array $options) {
return $result;
}, 10, 3);
blockstudio/canvas/documents
Ta filter prilagodi izrisane dokumente, ki jih vrne Canvas, in prejme enake tri argumente kot filter inventarja.
blockstudio/canvas/item_loaded
To dejanje se sproži ob nalaganju vsakega zapisa inventarja ter prejme vrsto inventarja, kanonični ID zapisa in normalizirani zapis.
blockstudio/canvas/source_compiled
To dejanje se sproži po prevedbi izvorne datoteke za Canvas ter prejme izbrano pot do vira in kanonični izvorni zapis.
Vključeni UI
blockstudio/ui/directories
Ta filter prilagodi imenike, ki se pregledujejo za vključene komponente UI.
blockstudio/ui/inventory
Ta filter prilagodi javni inventar družin UI.
blockstudio/ui/examples
Ta filter prilagodi vzorčne zapise UI ter prejme primere in javni inventar UI, iz katerega so bili izpeljani.
Topologija
blockstudio/blocks/topology_refreshed
To dejanje se sproži po ponovni izgradnji topologije blokov.
blockstudio/pages/topology_refreshed
To dejanje se sproži po ponovni izgradnji topologije strani.
blockstudio/pages/layout_error
To dejanje se sproži, kadar izris postavitve strani ne uspe, namesto da bi napaka ostala tiha.
Izvajalno okolje
blockstudio/runtime/initialized
To dejanje se sproži, ko izvajalno okolje razreši svojo konfiguracijo.
blockstudio/runtime/changed
To dejanje se sproži, ko se spremeni razrešena identiteta izvajalnega okolja, kar povzroči premik imenskih prostorov predpomnilnika in stanja statičnega predizrisovanja.
blockstudio/performance/default_config
Ta filter prilagodi privzete nastavitve zmogljivosti, preden se nanje naložijo vrednosti blockstudio.json projekta.
Vsebina
blockstudio/content/orphan_action
Ta filter določi, kaj sinhronizacija vsebine naredi z zapisom, ki nima več vira.
Bootstrap
blockstudio/url
Ta filter spremeni javni URL, ki se uporablja za urejevalnik in skrbniška sredstva Blockstudio. Integracije Composer ga morajo registrirati, preden naložijo datoteko za samodejno nalaganje Blockstudio. Drugi argument je fizični imenik paketa.
add_filter(
'blockstudio/url',
function(string $url, string $directory) {
return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
},
10,
2
);
Predpomnilnik izvajalnega okolja
blockstudio/cache/dir
Ta filter prejme razrešeni osnovni imenik predpomnilnika, preden se doda obseg izvajalnega okolja, sredstev urejevalnika ali drugega predpomnilnika.
add_filter('blockstudio/cache/dir', function(string $directory) {
return WP_CONTENT_DIR . '/cache/blockstudio';
});
blockstudio/cache/context
Ta filter identitetam predpomnilnika doda serializabilno različico izvajalnega okolja. Uporabite ga, kadar lahko isti vir odkrivanja izbere različne logične inventarje.
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
Ta filter spremeni identiteto imenika omrežja oziroma bloga za gostitelje z lastno mejo najemnika. Vrnjena vrednost se pred uporabo sanitizira.
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
Ta filter doda dejstva o gostitelju, ki vplivajo na vsak objekt v obsegu izvajalnega okolja. Prstne odtise virov, specifične za posamezne elemente, naj raje posreduje kot izrecne odvisnosti lastniški API.
add_filter(
'blockstudio/runtime/identity',
function(array $identity, string $scope) {
$identity['deployment'] = getenv('RELEASE_SHA') ?: 'local';
return $identity;
},
10,
2
);
blockstudio/cache/watch_debounce
Filtrira število sekund, v katerih je mogoče znova uporabiti preverjen posnetek opazovanja datotek, ne da bi se ponovno pregledal datotečni sistem. Privzeta vrednost je 0 v lokalnih in razvojnih okoljih ter 20 drugje.
add_filter('blockstudio/cache/watch_debounce', function() {
return 30;
});
blockstudio/cache/build_wait_budget
Filtrira čas v milisekundah, ki ga zahteva čaka, da sočasni gradnik objavi predpomnilnik izvajalnega okolja ali osvežitev nabora izbir, preden preide v degradiran način. Privzeta vrednost je 5000 za strukturne ponovne gradnje in 4000 za osvežitve izbir.
add_filter('blockstudio/cache/build_wait_budget', function() {
return 2000;
});
blockstudio/cache/populate_debounce
Filtrira število sekund, v katerih se zaporedni zapisi vsebine, izrazov, uporabnikov ali metapodatkov združijo v eno osvežitev nabora izbir. Prvi zapis po obdobju mirovanja sproži takojšnjo osvežitev; zadnji zapis v nizu se upošteva po preteku časovnega okna. Privzeta vrednost je 30. Vrnite 0 za osvežitev ob vsakem zapisu.
add_filter('blockstudio/cache/populate_debounce', function() {
return 120;
});
blockstudio/cache/populate_ignored_meta_keys
Filtrira ključe metapodatkov, katerih zapisi nikoli ne osvežijo izpolnjenih možnosti. Privzeto so to ključi, ki jih WordPress zapisuje za evidenco urejanja in prijav: _edit_lock, ki ju osvežita urejevalnik in Heartbeat, ko je objava odprta; _edit_last, zapisano ob shranjevanju objave, ki že sproži osvežitev; ter session_tokens, zapisano ob prijavi in odjavi. Dodajte ključe, ki se pogosto spreminjajo, vendar nikoli ne vplivajo na poizvedbo za izpolnjevanje.
add_filter('blockstudio/cache/populate_ignored_meta_keys', function(array $keys) {
$keys[] = '_my_view_counter';
return $keys;
});
blockstudio/cache/max_files_per_scope
Filtrira število objavljenih podatkovnih vsebin, ki jih ohrani vsak obseg predpomnilnika izvajalnega okolja.
add_filter('blockstudio/cache/max_files_per_scope', function($maximum, $scope) {
return $scope === 'runtime' ? 50 : $maximum;
}, 10, 2);
blockstudio/cache/compress
Filtrira, ali vsebina predpomnilnika uporablja stisnjene serializirane podatke namesto navadnega polja PHP. Privzeto se za navadni format uporabljajo samo vsebine do velikosti 1 MiB, pa še to le, kadar lahko cilj predpomni skupni pomnilnik aktivnega OPcache. Za druge procese, izključene datoteke in večje vsebine se uporabi stiskanje.
add_filter('blockstudio/cache/compress', function($compress, $scope) {
return $scope === 'runtime' ? false : $compress;
}, 10, 2);
Če vrnete false, se prezre tudi omejitev velikosti. To je lahko koristno, kadar WP-CLI brez opcache.enable_cli pripravi datoteke za spletne delavce z omogočenim OPcache, vendar bo vsak bralnik brez OPcache razčlenil ustvarjeno polje. Za velike vsebine, ki si jih deli več procesov, ohranite stiskanje, razen če je dodatna poraba pomnilnika sprejemljiva. Za privzete zaščitne ukrepe glejte oblike vsebine predpomnilnika.
blockstudio/cache/protected_paths
Čiščenje poti predpomnilnika nikoli ne sme izbrisati. Blockstudio jih inicializira z vsako datoteko, na katero se sklicuje nameščeni zemljevid za zgodnje streženje.
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
To dejanje sporoči skupni obseg predpomnilnika in izid, kot so hit, build, miss-stale, stale-last-good ali write-failure.
add_action('blockstudio/cache/outcome', function(string $scope, string $reason) {
my_metrics()->increment("blockstudio.cache.{$scope}.{$reason}");
}, 10, 2);
blockstudio/static_prerender/request_bypass
Ta filter prejme končno odločitev o anonimni varnosti ter podatke o strežniku in piškotkih. Vrnitev true vedno obide statično streženje in generiranje.
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
Ta filter zagotovi ali prilagodi celoten javni inventar URL, ki ga uporabljata načrtovano segrevanje predpomnilnika in izrecna orodja za grafe.
add_filter('blockstudio/static_prerender/public_urls', function(array $urls) {
$urls[] = home_url('/custom-route/');
return array_values(array_unique($urls));
});
Vrednost, ki jo vrne filter, ni končni inventar. Rezultat se obdela za preverjanje možnosti predpomnjenja, pri čemer se izpusti vse, kar ustreza konfigurirani dinamični poti, in vse, kar se privzeto obide: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, vse poti, ki vsebujejo /feed/, ter rezultati iskanja pod osnovno potjo iskanja na domači poti spletnega mesta (privzeto /search/). Dodani URL je zato lahko izpuščen brez opozorila. Če pričakovana pot manjka v zgrajenem inventarju, jo preverite glede na ta pravila, preden sklenete, da se filter ni izvedel.
blockstudio/static_prerender/render_internal
Ta filter implementira izbirni prenos paketov znotraj procesa. Vrne normalizirano polje z rezultati ali pusti vrednost nespremenjeno, da lahko upodabljalnik uporabi konfigurirano nadomestno možnost HTTP. Rezultat vsebuje html in po želji še status, dependencies, virtualHashes ter headers; glave, navedene v performance.staticPrerender.replayHeaders, se shranijo z dokumentom.
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
Ta filter sprejme končno odločitev, potem ko Blockstudio preveri, ali je izhod popoln dokument HTML brez oznake brez predpomnilnika in ali je opažena koda stanja odgovora uspešna. Tretji argument je opažena koda stanja ali null, če koda stanja ni bila navedena.
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
To dejanje sporoči izide statičnega predizrisovanja, vključno z zadetki, zgrešitvami, zapisi, zapisi grafov, zastarelimi vnosi in napakami.
add_action('blockstudio/static_prerender/outcome', function(string $reason) {
my_metrics()->increment("blockstudio.prerender.{$reason}");
});
blockstudio/tailwind/cache_max_files
Filtrira največje število prevedenih vnosov Tailwind CSS. Privzeta vrednost je 1000.
add_filter('blockstudio/tailwind/cache_max_files', function() {
return 1500;
});
blockstudio/tailwind/cache_max_age
Filtrira najdaljšo starost prevedenih vnosov Tailwind CSS v sekundah. Privzeta vrednost je 30 dni, najmanjša pa ena ura.
add_filter('blockstudio/tailwind/cache_max_age', function() {
return 14 * DAY_IN_SECONDS;
});
Skrbništvo
omogočeno
Ta filter omogoča vklop ali izklop skrbniške strani Blockstudio pod Orodja > Blockstudio.
add_filter('blockstudio/admin/enabled', function() {
return false;
});
Sredstva
editor/canvas/body_class
Ko je ponastavitev sredstev omogočena, ta filter prilagodi sanitizirane razrede telesa zunanjega dela, ki se kopirajo na platno urejevalnika blokov.
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
return array_values(array_diff($classes, ['logged-in']));
});
omogoči
Ta filter omogoča onemogočanje obdelave sredstev in njihovega dodajanja v čakalno vrsto za določeno vrsto sredstva.
add_filter('blockstudio/assets/enable', function($enable, $type, $block) {
if ($type === 'css' && $block['name'] === 'my/block') {
return false;
}
return $enable;
}, 10, 3);
onemogoči
Ta filter omogoča onemogočanje posameznih sredstev glede na njihov ID. Sredstva, katerih ID je v vrnjenem polju, ne bodo izrisana na zunanjem delu.
add_filter('blockstudio/assets/disable', function($disabled) {
$disabled[] = 'my-block-style';
return $disabled;
});
process/scss/import_paths
Ta filter omogoča dodajanje dodatnih poti v stavek @import prevajalnika SCSS.
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
$paths[] = get_stylesheet_directory() . '/scss';
return $paths;
});
process/scss/prelude
Ta filter omogoča dodajanje skupne kode Sass pred vsako datoteko SCSS pred prevajanjem.
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
Ta filter omogoča prilagajanje vsebine datoteke CSS pred njenim prevajanjem.
add_filter('blockstudio/assets/process/css/content', function($content, $block) {
return str_replace('old-class', 'new-class', $content);
}, 10, 2);
process/js/content
Ta filter omogoča prilagajanje vsebine datoteke JS pred njenim prevajanjem.
add_filter('blockstudio/assets/process/js/content', function($content, $block) {
return $content;
}, 10, 2);
Medpomnilnik
omogočeno
Blockstudio medpomni odgovor zunanjega dela, da se lahko oznake slogov in skript, izrisane znotraj telesa, premaknejo v glavo in nogo ter da lahko Tailwind pregleda celoten dokument. Medpomnjenje pomeni, da se celoten dokument zadrži in pregleda ob vsaki zahtevi zunanjega dela; spletno mesto, ki ne izrisuje sredstev blokov Blockstudio in ne uporablja Tailwind, lahko vrne false in tako preskoči oboje.
add_filter('blockstudio/buffer/enabled', '__return_false');
Medpomnjenje je izklopljeno tudi v skrbniškem vmesniku in predogledu v Prilagajalniku. Pokličite bs_is_buffering() iz wp_enqueue_scripts ali pozneje, da ugotovite, ali je trenutni odgovor medpomnjen. Pred odločitvijo pri template_redirect vrne false.
izhod
Ta filter prejme celoten dokument HTML v medpomnilniku, preden je poslan. Lastno premikanje sredstev Blockstudio se izvede s prioriteto 1000000, prevajanje Tailwind pa s prioriteto 999999; za ogled dokumenta pred njima zaženite filter prej, za ogled končnega izhoda pa pozneje.
add_filter('blockstudio/buffer/output', function(string $html) {
return $html;
}, 2000000);
Izris
odvisnosti
Ta filter sporoči izbrano predlogo in odvisnosti sredstev, kadar Blockstudio izriše blok. Uporaben je za statične izvoznike in druge zbiralnike odvisnosti znotraj procesa.
add_filter(
'blockstudio/render/dependencies',
function($paths, $name, $block, $isEditor, $isPreview) {
my_dependency_graph()->add($name, $paths);
return $paths;
},
10,
5
);
Globalno
Ta filter omogoča prilagajanje izhoda strani pred izrisom.
add_filter('blockstudio/render', function($content) {
return $content;
});
glava
Ta filter vam omogoča prilagoditev izhoda oznake <head>, preden se upodobi. Izvede se samo, kadar Blockstudio medpomni odgovor; glejte bs_is_buffering().
add_filter('blockstudio/render/head', function($content) {
return $content . '<meta name="custom" content="value">';
});
noga
Ta filter omogoča prilagajanje izhoda </body> pred izrisom.
add_filter('blockstudio/render/footer', function($content) {
return $content . '<script>console.log("loaded")</script>';
});
Obravnava napak
error/logged
Dejanje se sproži po zabeleženju napake. Uporabite ga za pošiljanje napak zunanjim storitvam za beleženje.
add_action('blockstudio/error/logged', function($message, $level, $context) {
if ($level === 'error') {
my_external_logger($message, $context);
}
}, 10, 3);
error/exception
Dejanje se sproži po obravnavi izjeme.
add_action('blockstudio/error/exception', function($exception, $context) {
my_error_tracker($exception);
}, 10, 2);
Zbirka podatkov
Vse kljuke podatkovne zbirke prejmejo eno samo polje $params.
db/before_create
Dejanje se sproži pred ustvarjanjem zapisa.
add_action('blockstudio/db/before_create', function($params) {
// $params: block, schema, data, storage
});
db/after_create
Dejanje se sproži po ustvarjanju zapisa.
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
Dejanje se sproži pred posodobitvijo zapisa.
add_action('blockstudio/db/before_update', function($params) {
// $params: block, schema, id, data, storage
});
db/after_update
Dejanje se sproži po posodobitvi zapisa.
add_action('blockstudio/db/after_update', function($params) {
// $params: block, schema, id, record, storage
});
db/before_delete
Dejanje se sproži pred izbrisom zapisa.
add_action('blockstudio/db/before_delete', function($params) {
// $params: block, schema, id, storage
});
db/after_delete
Dejanje se sproži po izbrisu zapisa.
add_action('blockstudio/db/after_delete', function($params) {
// $params: block, schema, id, storage
});
RPC
Vse kljuke RPC prejmejo eno samo polje $params.
rpc/before_call
Dejanje se sproži pred klicem funkcije RPC.
add_action('blockstudio/rpc/before_call', function($params) {
// $params: block, function, params
});
rpc/after_call
Dejanje se sproži po klicu funkcije RPC.
add_action('blockstudio/rpc/after_call', function($params) {
// $params: block, function, params, result
});