Hook-uri PHP
Mai jos găsiți o listă cu toate hook-urile PHP disponibile, pe care le puteți folosi pentru a extinde sau ajusta funcționalitatea pluginului.
Cale
Acest filtru vă permite să ajustați calea folderului blocului. În mod implicit, acesta
se află în blockstudio în tema activă în prezent. Alternativ, puteți crea o instanță nouă pentru mai multe
directoare sursă.
add_filter('blockstudio/path', function() {
$path = get_stylesheet_directory() . '/blocks';
return $path;
});
Inițializare
global
Această acțiune se declanșează după ce pluginul a înregistrat toate blocurile.
add_action('blockstudio/init', function($blocks) {
// All blocks have been registered
});
instance
Această acțiune se declanșează după ce pluginul a înregistrat toate blocurile unei anumite
instanțe.
Segmentul $instance este calea instanței relativă la wp-content.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/$instance", function() {
// All blocks of this instance have been registered
});
global/before
Această acțiune se declanșează înainte ca pluginul să înregistreze toate blocurile.
add_action('blockstudio/init/before', function() {
// Before blocks are registered
});
global/before/$instance
Această acțiune se declanșează înainte ca pluginul să înregistreze toate blocurile unei anumite instanțe.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/before/$instance", function() {
// Before blocks of this instance are registered
});
Blocuri
render
Acest filtru vă permite să ajustați rezultatul unui bloc înainte ca acesta să fie randat.
add_filter('blockstudio/blocks/render', function($content, $block, $attributes) {
// Modify the block content
return $content;
}, 10, 3);
meta
Acest filtru vă permite să ajustați datele fișierului block.json înainte ca acesta să fie înregistrat.
add_filter('blockstudio/blocks/meta', function($meta, $block) {
if (str_starts_with($block['name'], 'marketing')) {
$meta['icon'] = 'megaphone';
}
return $meta;
}, 10, 2);
Codul de mai sus ar schimba pictograma tuturor blocurilor al căror nume începe cu marketing.
conditions
Acest filtru vă permite să adăugați condiții personalizate care pot fi folosite în blocuri. Fiecare tip de condiție corespunde unei valori pe care editorul o compară cu value condiției. Consultați Condiții personalizate.
add_filter('blockstudio/blocks/conditions', function($conditions) {
$conditions['myCustomCondition'] = 'expected';
return $conditions;
});
attributes
Acest filtru ajustează definiția unui câmp înainte de înregistrarea blocului. Definiția filtrată controlează elementul de interfață din editor și validarea valorii la randare. Consultați Filtrare pentru mai multe informații.
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
// Modify this field definition before registration.
return $attribute;
}, 10, 2);
attributes/render
Acest filtru ajustează valoarea unui câmp înainte ca aceasta să fie transmisă șablonului blocului. Se execută o dată pentru fiecare câmp și primește trei argumente: $value (valoarea rezolvată), $key (cheia câmpului, așa cum este folosită în $a) și $block (tabloul de date al blocului pe care îl primesc șabloanele ca $block sau $b). Înregistrați-l cu trei argumente acceptate. Consultați Filtrare pentru mai multe informații.
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
Un câmp files returnează fiecare imagine cu un tablou sizes care conține URL, lățimea și înălțimea imaginii full și ale fiecărei dimensiuni de imagine înregistrate, de exemplu $image['sizes']['thumbnail'] și $image['sizes']['thumbnail-width']. Pentru fiecare dimensiune se face un apel wp_get_attachment_image_src() per imagine, așadar filtrele aferente se aplică în continuare. Șabloanele care nu citesc niciodată sizes pot elimina sau scurta lista.
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 este lista numelor dimensiunilor, cu full pe primul loc (este goală dacă nu sunt înregistrate dimensiuni intermediare). $id este ID-ul atașamentului, iar $size este dimensiunea solicitată pentru url valorii. Filtrul modifică tabloul sizes pentru fiecare valoare de fișier din solicitare. În lipsa filtrului, tabloul rămâne neschimbat.
Returnați numele dimensiunilor ca șiruri. Intrările nevalide sunt ignorate, iar numele duplicate sunt procesate o singură dată. O valoare returnată care nu este un tablou omite dimensiunile. url solicitată și celelalte proprietăți ale atașamentului rămân neschimbate. Acest hook nu rulează pentru un câmp de tip fișier cu returnFormat: "url", care nu creează o mapare a dimensiunilor.
attributes/validate
Ajustați rezultatele apelurilor explicite bs_validate_block(), de exemplu când un filtru de randare personalizat rezolvă referințe stocate. Acest lucru nu activează validarea automată la salvare sau la randare.
add_filter('blockstudio/blocks/attributes/validate', function($findings, $name, $attrs) {
return $findings;
}, 10, 3);
Returnați o listă de rezultate. Filtrul nu este apelat când blocul nu are câmpuri Blockstudio sau extensii corespunzătoare (null).
attributes/schema
Ajustați Schema JSON returnată de bs_block_schema(), de exemplu atunci când un filtru de randare personalizat rezolvă referințe stocate.
add_filter('blockstudio/blocks/attributes/schema', function($schema, $name) {
return $schema;
}, 10, 2);
Returnați tabloul schemei. Filtrul nu este apelat dacă blocul nu are câmpuri Blockstudio sau extensii corespunzătoare (null).
attributes/populate
Acest filtru vă permite să adăugați date personalizate la opțiunile unui câmp checkbox,
select sau radio. Consultați Completarea opțiunilor pentru mai multe informații.
Filtrul primește un argument: un array cu toate seturile de date personalizate, indexate după
numele folosit în "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
Acest filtru vă permite să ajustați rezultatul conținutului useBlockProps.
Toate filtrele componentelor (use_block_props, inner_blocks și rich_text) primesc blocul ca ultim argument. $block este WP_Block_Type înregistrat pentru blocul randat, așadar $block->name este numele blocului, de exemplu acme/hero.
$props este un șir de atribute HTML, nu un tablou. În interfața publică este rezultatul get_block_wrapper_attributes(), de exemplu class="wp-block-acme-hero my-class". În editor, este atributul class al elementului. Returnați un șir. În editor se aplică doar atributul class al șirului returnat.
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
Acest filtru vă permite să ajustați rezultatul conținutului <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
Acest filtru vă permite să eliminați wrapperul <InnerBlocks /> din frontend.
add_filter('blockstudio/blocks/components/inner_blocks/frontend/wrap', function($wrap, $block) {
return false; // Remove wrapper
}, 10, 2);
components/rich_text/render
Acest filtru vă permite să ajustați rezultatul conținutului <RichText />. Primește valoarea atributului și blocul.
add_filter('blockstudio/blocks/components/rich_text/render', function($content, $block) {
return wp_kses_post($content);
}, 10, 2);
Etichete de bloc
blockstudio/block_tags/builders
Acest filtru înregistrează constructori de tablouri de blocuri, utilizați de etichetele de bloc și de blocurile personalizate selectate prin blockstudio/parser/element_mapping. Fiecare constructor primește atributele analizate și conținutul intern brut.
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);
Filtrele compatibile blockstudio/block_tags/renderers și blockstudio/parser/renderers rulează după acest hook și pot suprascrie același nume de bloc.
blockstudio/block_tags/tag_aliases
Acest filtru vă permite să înregistrați etichete de authoring personalizate, cu cratimă, care se rezolvă la nume reale de bloc înainte de fallback-ul pentru HTML brut. Este util când o temă dorește o sintaxă concisă de etichete, specifică proiectului, păstrând totodată randarea blocurilor standard Blockstudio sau de bază.
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
Acest filtru vă permite să mapați abrevieri de prefix la unul sau mai multe spații de nume pentru blocuri. Fiecare cheie este un prefix cu litere mici, fără cratime. Fiecare valoare poate fi un șir de spațiu de nume sau o listă ordonată de spații de nume.
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 rezolvă la theme-components/card. <theme-button> încearcă mai întâi theme-components/button, apoi revine la bsui/button. Intrările explicite blockstudio/block_tags/tag_aliases au prioritate pentru aceeași etichetă, iar etichetele cu prefix nerezolvate rămân neschimbate.
Prefixele se pot combina: dacă o etichetă cu prefix nu se rezolvă direct, iar slug-ul său este la rândul lui o etichetă cu prefix înregistrată, rezolvarea continuă recursiv. Cu theme => ['theme-components'] și ui => ['bsui'], <theme-ui-input> ajunge la prefixul ui și se rezolvă la bsui/input. Etichetele de prefix și alias înregistrate sunt randate și în rezultatul șabloanelor de blocuri, nu doar în conținutul paginilor.
Setări
cale
Acest filtru vă permite să ajustați calea fișierului blockstudio.json. În mod implicit, acesta se află la blockstudio.json în tema activă în prezent.
add_filter('blockstudio/settings/path', function() {
return get_stylesheet_directory() . '/config/blockstudio.json';
});
users/ids
Acest filtru vă permite să activați editorul pentru anumite ID-uri de utilizator.
add_filter('blockstudio/settings/users/ids', function() {
return [1];
});
users/roles
Acest filtru vă permite să activați editorul pentru anumite roluri de utilizator.
add_filter('blockstudio/settings/users/roles', function() {
return ['administrator', 'editor'];
});
assets/enqueue
Acest filtru vă permite să activați/dezactivați încărcarea resurselor în frontend și editor.
add_filter('blockstudio/settings/assets/enqueue', function() {
return false;
});
assets/reset/enabled
Acest filtru vă permite să activați/dezactivați eliminarea stilurilor blocurilor de bază WordPress și resetarea utilitară a aspectului editorului.
add_filter('blockstudio/settings/assets/reset/enabled', function() {
return true;
});
assets/reset/full_width
Acest filtru vă permite să controlați tipurile de postări care folosesc editarea pe toată lățimea.
add_filter('blockstudio/settings/assets/reset/full_width', function() {
return ['page'];
});
assets/minify/css
Acest filtru vă permite să activați/dezactivați minificarea CSS.
add_filter('blockstudio/settings/assets/minify/css', function() {
return true;
});
assets/minify/js
Acest filtru vă permite să activați/dezactivați minificarea JS.
add_filter('blockstudio/settings/assets/minify/js', function() {
return true;
});
assets/process/scss
Acest filtru vă permite să activați/dezactivați procesarea SCSS în fișierele .css.
add_filter('blockstudio/settings/assets/process/scss', function() {
return true;
});
assets/process/scss_files
Acest filtru vă permite să activați/dezactivați procesarea fișierelor .scss în CSS.
add_filter('blockstudio/settings/assets/process/scss_files', function() {
return true;
});
assets/output
Acest filtru vă permite să controlați unde sunt scrise resursele de bloc compilate.
add_filter('blockstudio/settings/assets/output', function() {
return 'cache';
});
assets/inline_limit
Acest filtru vă permite să controlați câți octeți din CSS al blocului extern sunt incluși direct în fiecare pagină.
add_filter('blockstudio/settings/assets/inline_limit', function() {
return 40000;
});
cache/enabled
Acest filtru vă permite să activați/dezactivați toate cache-urile de resurse runtime și editor bazate pe fișiere Blockstudio.
add_filter('blockstudio/settings/cache/enabled', function() {
return false;
});
cache/path
Acest filtru vă permite să schimbați directorul cache-ului bazat pe fișiere Blockstudio.
add_filter('blockstudio/settings/cache/path', function() {
return 'cache/blockstudio';
});
cache/namespace_grace
Acest filtru vă permite să schimbați durata de păstrare a unui spațiu de nume de cache retras înainte de a fi eliminat.
add_filter('blockstudio/settings/cache/namespace_grace', function() {
return 777600;
});
githooks/commit
Acest filtru indică dacă hook-ul de commit PHPStan deținut de Blockstudio este activat.
add_filter('blockstudio/settings/githooks/commit', function() {
return true;
});
content/enabled
Acest filtru vă permite să activați/dezactivați Content Sync.
add_filter('blockstudio/settings/content/enabled', function() {
return true;
});
content/id
Acest filtru vă permite să setați spațiul de nume al proprietarului Content Sync.
add_filter('blockstudio/settings/content/id', function() {
return 'docs';
});
content/path
Acest filtru vă permite să setați directorul de fișiere Content Sync.
add_filter('blockstudio/settings/content/path', function() {
return 'content';
});
content/include_page_sync_managed
Acest filtru vă permite să includeți sau să excludeți postările gestionate de Page Sync.
add_filter('blockstudio/settings/content/include_page_sync_managed', function() {
return false;
});
content/authors
Acest filtru vă permite să configurați gestionarea autorilor în Content Sync.
add_filter('blockstudio/settings/content/authors', function() {
return 'ignore';
});
content/post_types
Acest filtru vă permite să configurați listele de permisiuni pentru tipurile de postări din Content Sync.
add_filter('blockstudio/settings/content/post_types', function() {
return ['team_member'];
});
content/taxonomies
Acest filtru vă permite să configurați listele de permisiuni pentru taxonomiile din Content Sync.
add_filter('blockstudio/settings/content/taxonomies', function() {
return ['category', 'post_tag'];
});
content/media
Acest filtru vă permite să configurați gestionarea fișierelor media în Content Sync.
add_filter('blockstudio/settings/content/media', function() {
return 'manifest';
});
tailwind/enabled
Acest filtru vă permite să activați/dezactivați Tailwind.
add_filter('blockstudio/settings/tailwind/enabled', function() {
return true;
});
tailwind/config
Acest filtru vă permite să adăugați o configurație Tailwind CSS personalizată.
add_filter('blockstudio/settings/tailwind/config', function() {
return '@theme { --color-primary: pink; }';
});
tailwind/output
Acest filtru vă permite să alegeți între o ieșire Tailwind CSS încorporată și una legată.
add_filter('blockstudio/settings/tailwind/output', function() {
return 'link';
});
ui/enabled
Acest filtru vă permite să activați/dezactivați componentele UI incluse în pachet.
add_filter('blockstudio/settings/ui/enabled', function() {
return true;
});
editor/format_on_save
Acest filtru vă permite să activați/dezactivați formatarea codului la salvare.
add_filter('blockstudio/settings/editor/format_on_save', function() {
return true;
});
editor/assets
Acest filtru vă permite să încărcați resurse suplimentare în editor.
add_filter('blockstudio/settings/editor/assets', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
editor/markup
Acest filtru vă permite să adăugați marcaje suplimentare la sfârșitul editorului.
add_filter('blockstudio/settings/editor/markup', function() {
return '<style>body { background: black; }</style>';
});
block_editor/disable_loading
Acest filtru vă permite să dezactivați încărcarea blocurilor în Block Editor.
add_filter('blockstudio/settings/block_editor/disable_loading', function() {
return true;
});
block_editor/enhance
Acest filtru vă permite să activați facilitățile editorului Blockstudio, precum stiluri de focalizare mai curate și contururi la trecerea cursorului/selectare.
add_filter('blockstudio/settings/block_editor/enhance', function() {
return true;
});
block_editor/css_classes
Acest filtru vă permite să adăugați foi de stil ale căror clase pot fi alese în câmpul pentru clase.
add_filter('blockstudio/settings/block_editor/css_classes', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/css_variables
Acest filtru vă permite să adăugați foi de stil ale căror variabile CSS pot fi completate automat în câmpul de cod.
add_filter('blockstudio/settings/block_editor/css_variables', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/blocks/allow
Acest filtru vă permite să controlați numele blocurilor permise în inserter.
add_filter('blockstudio/settings/block_editor/blocks/allow', function() {
return ['core/*', 'acf/*', 'my-theme/*'];
});
block_editor/blocks/deny
Acest filtru vă permite să eliminați nume de blocuri din inserter.
add_filter('blockstudio/settings/block_editor/blocks/deny', function() {
return ['core/embed', 'core/freeform'];
});
block_editor/blocks/directory
Acest filtru vă permite să activați sau să dezactivați resursele directorului de blocuri WordPress din editor.
add_filter('blockstudio/settings/block_editor/blocks/directory', function() {
return false;
});
block_editor/blocks/categories/allow
Acest filtru vă permite să controlați slug-urile categoriilor de blocuri care rămân disponibile.
add_filter('blockstudio/settings/block_editor/blocks/categories/allow', function() {
return ['text', 'media', 'design'];
});
block_editor/blocks/categories/deny
Acest filtru vă permite să eliminați slug-uri de categorii de blocuri din inserter.
add_filter('blockstudio/settings/block_editor/blocks/categories/deny', function() {
return ['embed'];
});
block_editor/blocks/categories/rename
Acest filtru vă permite să redenumiți etichetele categoriilor de blocuri în funcție de slug.
add_filter('blockstudio/settings/block_editor/blocks/categories/rename', function() {
return [
'text' => 'Writing',
'design' => 'Layout'
];
});
block_editor/blocks/categories/order
Acest filtru vă permite să ordonați slug-urile categoriilor de blocuri în inserter.
add_filter('blockstudio/settings/block_editor/blocks/categories/order', function() {
return ['my-theme', 'text', 'media'];
});
block_editor/blocks/styles/deny
Acest filtru vă permite să anulați înregistrarea stilurilor de blocuri înregistrate de PHP, în funcție de numele blocului.
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
Acest filtru vă permite să ascundeți widgeturi vechi suplimentare din blocul pentru widgeturi vechi.
add_filter('blockstudio/settings/block_editor/blocks/legacy_widgets/hide', function() {
return ['archives', 'calendar'];
});
block_editor/patterns/core
Acest filtru vă permite să activați sau să dezactivați modelele de blocuri de bază WordPress.
add_filter('blockstudio/settings/block_editor/patterns/core', function() {
return false;
});
block_editor/patterns/remote
Acest filtru vă permite să activați sau să dezactivați modelele la distanță din directorul de modele WordPress.
add_filter('blockstudio/settings/block_editor/patterns/remote', function() {
return false;
});
block_editor/patterns/theme
Acest filtru vă permite să activați sau să dezactivați modelele de blocuri furnizate de temă.
add_filter('blockstudio/settings/block_editor/patterns/theme', function() {
return false;
});
block_editor/patterns/blockstudio
Acest filtru vă permite să activați sau să dezactivați modelele bazate pe fișiere Blockstudio.
add_filter('blockstudio/settings/block_editor/patterns/blockstudio', function() {
return false;
});
block_editor/patterns/categories/allow
Acest filtru vă permite să controlați slug-urile categoriilor de modele care rămân disponibile.
add_filter('blockstudio/settings/block_editor/patterns/categories/allow', function() {
return ['featured', 'buttons', 'columns'];
});
block_editor/patterns/categories/deny
Acest filtru vă permite să eliminați slug-uri de categorii de modele din inserterul de modele.
add_filter('blockstudio/settings/block_editor/patterns/categories/deny', function() {
return ['gallery'];
});
block_editor/patterns/categories/rename
Acest filtru vă permite să redenumiți etichetele categoriilor de modele în funcție de slug.
add_filter('blockstudio/settings/block_editor/patterns/categories/rename', function() {
return [
'featured' => 'Featured Layouts'
];
});
block_editor/patterns/categories/order
Acest filtru vă permite să ordonați slug-urile categoriilor de modele în inserter.
add_filter('blockstudio/settings/block_editor/patterns/categories/order', function() {
return ['featured', 'buttons'];
});
block_editor/media/openverse
Acest filtru vă permite să activați sau să dezactivați categoria media Openverse în inserterul media al editorului de blocuri.
add_filter('blockstudio/settings/block_editor/media/openverse', function() {
return false;
});
block_editor/media/image_sizes/allow
Acest filtru vă permite să controlați numele dimensiunilor de imagine care rămân disponibile în controalele media ale editorului.
add_filter('blockstudio/settings/block_editor/media/image_sizes/allow', function() {
return ['thumbnail', 'large'];
});
block_editor/media/image_sizes/deny
Acest filtru vă permite să eliminați nume de dimensiuni de imagine din controalele media ale editorului.
add_filter('blockstudio/settings/block_editor/media/image_sizes/deny', function() {
return ['medium_large'];
});
ai/enable_context_generation
Acest filtru vă permite să activați sau să dezactivați generarea fișierului de context pentru integrarea cu instrumente LLM. Când este activat, fișierul de context reunește date actualizate despre blocuri, setările Blockstudio ale instalării curente, toate schemele relevante și documentația Blockstudio într-o singură sursă pentru instrumentele de dezvoltare bazate pe AI.
add_filter('blockstudio/settings/ai/enable_context_generation', function() {
return true;
});
block_tags/enabled
Acest filtru vă permite să activați/dezactivați randarea etichetelor de bloc la nivel de pagină.
add_filter('blockstudio/settings/block_tags/enabled', function() {
return true;
});
block_tags/prefixes
Acest filtru vă permite să înregistrați abrevieri care mapează prefixele la spații de nume pentru etichetele de bloc.
add_filter('blockstudio/settings/block_tags/prefixes', function() {
return [
'theme' => ['theme-components', 'bsui']
];
});
dev/grab/enabled
Acest filtru vă permite să activați/dezactivați instrumentul de selectare a elementelor.
add_filter('blockstudio/settings/dev/grab/enabled', function() {
return false;
});
dev/perf
Acest filtru vă permite să activați/dezactivați profilatorul de performanță.
add_filter('blockstudio/settings/dev/perf', function() {
return false;
});
dev/canvas/enabled
Acest filtru vă permite să activați/dezactivați canvasul.
add_filter('blockstudio/settings/dev/canvas/enabled', function() {
return false;
});
dev/canvas/admin_bar
Acest filtru vă permite să afișați/ascundeți bara de administrare WordPress pe canvas.
add_filter('blockstudio/settings/dev/canvas/admin_bar', function() {
return true;
});
WPML
blockstudio/wpml/config/label
Filtrează eticheta fiecărei chei pe care o scrie wp bs wpml config. Consultați Modificați etichetele pentru tabloul de context.
add_filter('blockstudio/wpml/config/label', function($label, $context) {
return str_replace(' (optional)', '', $label);
}, 10, 2);
Canvas
blockstudio/canvas/inventory
Acest filtru ajustează inventarul raportat de Canvas pentru o selecție. Funcția callback primește DTO-ul inventarului, selecția inițială și opțiunile cu care a fost apelată.
add_filter('blockstudio/canvas/inventory', function(array $result, array $selection, array $options) {
return $result;
}, 10, 3);
blockstudio/canvas/documents
Acest filtru ajustează documentele randate returnate de Canvas, cu aceleași trei argumente ca filtrul inventarului.
blockstudio/canvas/item_loaded
Această acțiune se declanșează o dată pentru fiecare înregistrare din inventar la încărcare și primește tipul inventarului, ID-ul canonic al înregistrării și înregistrarea normalizată.
blockstudio/canvas/source_compiled
Această acțiune se declanșează după compilarea unui fișier sursă pentru Canvas și primește calea sursei selectate și înregistrarea canonică a sursei.
UI incluse în pachet
blockstudio/ui/directories
Acest filtru ajustează directoarele scanate pentru componentele UI incluse în pachet.
blockstudio/ui/inventory
Acest filtru ajustează inventarul public al familiei UI.
blockstudio/ui/examples
Acest filtru ajustează înregistrările de exemple UI și primește exemplele și inventarul public UI din care au fost derivate.
Topologie
blockstudio/blocks/topology_refreshed
Această acțiune se declanșează după reconstruirea topologiei blocurilor.
blockstudio/pages/topology_refreshed
Această acțiune se declanșează după reconstruirea topologiei paginilor.
blockstudio/pages/layout_error
Această acțiune se declanșează când randarea unui aspect de pagină eșuează, în loc ca eroarea să fie ignorată.
Runtime
blockstudio/runtime/initialized
Această acțiune se declanșează după ce runtime-ul și-a rezolvat configurația.
blockstudio/runtime/changed
Această acțiune se declanșează când se schimbă identitatea runtime-ului rezolvat, ceea ce mută spațiile de nume ale cache-ului și starea prerandată static.
blockstudio/performance/default_config
Acest filtru ajustează valorile implicite de performanță înainte de a suprapune valorile blockstudio.json proprii proiectului.
Conținut
blockstudio/content/orphan_action
Acest filtru decide ce face sincronizarea conținutului cu o înregistrare care nu mai are o sursă.
Bootstrap
blockstudio/url
Acest filtru schimbă URL public folosit pentru resursele editorului și de administrare ale Blockstudio. Integrările Composer trebuie să îl înregistreze înainte de încărcarea fișierului autoload al Blockstudio. Al doilea argument este directorul fizic al pachetului.
add_filter(
'blockstudio/url',
function(string $url, string $directory) {
return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
},
10,
2
);
Cache runtime
blockstudio/cache/dir
Acest filtru primește directorul de bază rezolvat al cache-ului înainte de adăugarea unui domeniu runtime, al resurselor editorului sau al altui domeniu de cache.
add_filter('blockstudio/cache/dir', function(string $directory) {
return WP_CONTENT_DIR . '/cache/blockstudio';
});
blockstudio/cache/context
Acest filtru adaugă o variantă serializabilă a runtime-ului la identitățile cache-ului. Folosiți-l când aceeași sursă de descoperire poate selecta inventare logice diferite.
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
Acest filtru schimbă identitatea directorului rețelei/blogului pentru gazdele cu propriile limite de tenant. Valoarea returnată este igienizată înainte de utilizare.
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
Acest filtru adaugă informații despre gazdă care afectează fiecare obiect dintr-un domeniu runtime. Amprentele sursei specifice unui element ar trebui transmise ca dependențe explicite de API responsabil.
add_filter(
'blockstudio/runtime/identity',
function(array $identity, string $scope) {
$identity['deployment'] = getenv('RELEASE_SHA') ?: 'local';
return $identity;
},
10,
2
);
blockstudio/cache/watch_debounce
Filtrează numărul de secunde cât poate fi reutilizată o instantanee validată de monitorizare a fișierelor fără o nouă verificare a sistemului de fișiere. Valoarea implicită este 0 în mediile locale și de dezvoltare și 20 în celelalte.
add_filter('blockstudio/cache/watch_debounce', function() {
return 30;
});
blockstudio/cache/build_wait_budget
Filtrează cât timp, în milisecunde, așteaptă o cerere ca un proces de construire concurent să publice cache-ul runtime sau să actualizeze opțiunile populate, înainte de a trece la un mod degradat. Valorile implicite sunt 5000 pentru reconstruirile structurale și 4000 pentru actualizările opțiunilor.
add_filter('blockstudio/cache/build_wait_budget', function() {
return 2000;
});
blockstudio/cache/populate_debounce
Filtrează câte secunde sunt comasate într-o singură actualizare a opțiunilor populate, în cazul unui val de scrieri de conținut, termeni, utilizatori sau metadate. Prima scriere după o perioadă de inactivitate declanșează actualizarea imediat; ultima scriere dintr-un val este reflectată după trecerea intervalului. Valoarea implicită este 30. Returnați 0 pentru a actualiza la fiecare scriere.
add_filter('blockstudio/cache/populate_debounce', function() {
return 120;
});
blockstudio/cache/populate_ignored_meta_keys
Filtrează cheile meta ale căror scrieri nu reîmprospătează niciodată opțiunile populate. În mod implicit, acestea sunt cheile pe care WordPress le scrie pentru evidența editării și a autentificării: _edit_lock, reîmprospătate de editor și de Heartbeat cât timp o postare este deschisă; _edit_last, scrise odată cu salvarea unei postări care declanșează deja o reîmprospătare; și session_tokens, scrise la autentificare și la deconectare. Adăugați cheile care se schimbă des, dar nu influențează niciodată o interogare de populare.
add_filter('blockstudio/cache/populate_ignored_meta_keys', function(array $keys) {
$keys[] = '_my_view_counter';
return $keys;
});
blockstudio/cache/max_files_per_scope
Filtrează câte payload-uri publicate păstrează fiecare domeniu al cache-ului runtime.
add_filter('blockstudio/cache/max_files_per_scope', function($maximum, $scope) {
return $scope === 'runtime' ? 50 : $maximum;
}, 10, 2);
blockstudio/cache/compress
Filtrează dacă un payload de cache folosește date serializate comprimate în locul unui tablou PHP simplu. În mod implicit, doar payloadurile de până la 1 MiB folosesc formatul simplu și numai dacă memoria partajată OPcache activă poate stoca în cache destinația. Celelalte procese, fișierele excluse și payloadurile mai mari folosesc comprimarea.
add_filter('blockstudio/cache/compress', function($compress, $scope) {
return $scope === 'runtime' ? false : $compress;
}, 10, 2);
Returnarea valorii false anulează și limita de dimensiune. Acest lucru poate fi util când WP-CLI încălzește fișierele pentru worker-ele web cu OPcache activat, fără opcache.enable_cli, însă fiecare cititor fără OPcache va analiza tabloul generat. Păstrați comprimarea pentru payloadurile partajate mari, cu excepția cazului în care costul suplimentar de memorie este acceptabil. Consultați formatele payloadurilor de cache pentru protecțiile implicite.
blockstudio/cache/protected_paths
Eliminarea periodică nu trebuie să evacueze căile cache-ului. Blockstudio îl inițializează cu fiecare fișier la care face referire harta instalată pentru servire anticipată.
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
Această acțiune raportează un domeniu de cache partajat și un rezultat, precum hit, build, miss-stale, stale-last-good sau 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
Acest filtru primește decizia finală privind siguranța anonimizării, precum și intrările serverului și ale cookie-urilor. Returnarea valorii true ocolește întotdeauna servirea și generarea statică.
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
Acest filtru furnizează sau ajustează inventarul public complet URL folosit de procesul programat de încălzire și de instrumentele explicite pentru grafuri.
add_filter('blockstudio/static_prerender/public_urls', function(array $urls) {
$urls[] = home_url('/custom-route/');
return array_values(array_unique($urls));
});
Valoarea returnată de filtru nu este inventarul final. Rezultatul trece printr-o etapă de verificare a posibilității de stocare în cache, care elimină tot ce corespunde unei căi dinamice configurate și tot ce este ocolit implicit: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, orice cale care conține /feed/ și rezultatele căutării aflate sub calea de bază a căutării, la calea principală a site-ului (/search/ în mod implicit). Prin urmare, o URL adăugată de dvs. poate fi eliminată fără avertisment. Dacă lipsește o rută așteptată din inventarul construit, verificați-o în raport cu aceste reguli înainte de a presupune că filtrul nu a rulat.
blockstudio/static_prerender/render_internal
Acest filtru implementează transportul opțional în lot, în același proces. Returnați un tablou de rezultate normalizat sau lăsați valoarea neschimbată pentru ca rendererul să folosească soluția de rezervă configurată HTTP. Rezultatul include html și, opțional, status, dependencies, virtualHashes și headers; antetele indicate în performance.staticPrerender.replayHeaders sunt stocate împreună cu documentul.
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
Acest filtru ia decizia finală după ce Blockstudio verifică dacă rezultatul este un document HTML complet, fără marcajul no-cache, și dacă starea observată a răspunsului indică succes. Al treilea argument este starea observată sau null dacă nu a fost declarată nicio stare.
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
Această acțiune raportează rezultatele prerandării statice, inclusiv accesări reușite și nereușite, scrieri, scrieri de grafuri, intrări învechite și eșecuri.
add_action('blockstudio/static_prerender/outcome', function(string $reason) {
my_metrics()->increment("blockstudio.prerender.{$reason}");
});
blockstudio/tailwind/cache_max_files
Filtrează numărul maxim de intrări compilate Tailwind CSS. Valoarea implicită este 1000.
add_filter('blockstudio/tailwind/cache_max_files', function() {
return 1500;
});
blockstudio/tailwind/cache_max_age
Filtrează vechimea maximă, în secunde, a intrărilor compilate Tailwind CSS. Valoarea implicită este de 30 de zile, iar limita minimă este de o oră.
add_filter('blockstudio/tailwind/cache_max_age', function() {
return 14 * DAY_IN_SECONDS;
});
Administrare
activat
Acest filtru vă permite să activați sau să dezactivați pagina de administrare Blockstudio din Tools > Blockstudio.
add_filter('blockstudio/admin/enabled', function() {
return false;
});
Resurse
editor/canvas/body_class
Când resetarea resurselor este activată, acest filtru ajustează clasele body igienizate din frontend, copiate în canvasul editorului de blocuri.
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
return array_values(array_diff($classes, ['logged-in']));
});
activare
Acest filtru vă permite să dezactivați procesarea și încărcarea unui anumit tip de resursă.
add_filter('blockstudio/assets/enable', function($enable, $type, $block) {
if ($type === 'css' && $block['name'] === 'my/block') {
return false;
}
return $enable;
}, 10, 3);
dezactivare
Acest filtru vă permite să dezactivați anumite resurse după ID. Resursele al căror ID apare în tabloul returnat nu vor fi randate în frontend.
add_filter('blockstudio/assets/disable', function($disabled) {
$disabled[] = 'my-block-style';
return $disabled;
});
process/scss/import_paths
Acest filtru vă permite să adăugați căi suplimentare la instrucțiunea @import a compilatorului SCSS.
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
$paths[] = get_stylesheet_directory() . '/scss';
return $paths;
});
process/scss/prelude
Acest filtru vă permite să adăugați cod Sass comun înainte de compilarea fiecărui fișier SCSS.
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
Acest filtru vă permite să ajustați conținutul fișierului CSS înainte de compilare.
add_filter('blockstudio/assets/process/css/content', function($content, $block) {
return str_replace('old-class', 'new-class', $content);
}, 10, 2);
process/js/content
Acest filtru vă permite să ajustați conținutul fișierului JS înainte de compilare.
add_filter('blockstudio/assets/process/js/content', function($content, $block) {
return $content;
}, 10, 2);
Buffer
activat
Blockstudio memorează în buffer răspunsul frontend, astfel încât etichetele de stil și script randate în body să poată fi mutate în head și footer, iar Tailwind să poată analiza întregul document. Memorizarea în buffer presupune păstrarea și scanarea întregului document la fiecare cerere frontend; un site care nu randează resurse pentru blocuri Blockstudio și nu folosește Tailwind poate returna false pentru a le omite pe amândouă.
add_filter('blockstudio/buffer/enabled', '__return_false');
Bufferizarea este dezactivată și în zona de administrare, precum și în previzualizarea din Customizer. Apelați bs_is_buffering() din wp_enqueue_scripts sau ulterior pentru a afla dacă răspunsul curent este bufferizat. Returnează false înainte de luarea deciziei în template_redirect.
ieșire
Acest filtru primește documentul complet HTML memorat în buffer înainte de trimitere. Mutarea propriilor resurse în head de către Blockstudio rulează la prioritatea 1000000, iar compilarea Tailwind la 999999; rulați mai devreme pentru a vedea documentul înaintea lor sau mai târziu pentru a vedea rezultatul final.
add_filter('blockstudio/buffer/output', function(string $html) {
return $html;
}, 2000000);
Randare
dependențe
Acest filtru raportează șablonul selectat și dependențele de resurse ori de câte ori Blockstudio randează un bloc. Este util pentru exportatoarele statice și pentru alți colectori de dependențe din proces.
add_filter(
'blockstudio/render/dependencies',
function($paths, $name, $block, $isEditor, $isPreview) {
my_dependency_graph()->add($name, $paths);
return $paths;
},
10,
5
);
global
Acest filtru vă permite să ajustați rezultatul paginii înainte de randare.
add_filter('blockstudio/render', function($content) {
return $content;
});
head
Acest filtru vă permite să ajustați rezultatul etichetei <head> înainte de randare. Rulează numai când Blockstudio bufferizează răspunsul; consultați bs_is_buffering().
add_filter('blockstudio/render/head', function($content) {
return $content . '<meta name="custom" content="value">';
});
footer
Acest filtru vă permite să ajustați rezultatul </body> înainte de randare.
add_filter('blockstudio/render/footer', function($content) {
return $content . '<script>console.log("loaded")</script>';
});
Gestionarea erorilor
error/logged
Acțiunea se declanșează după înregistrarea unei erori. Folosiți-o pentru a trimite erorile către servicii externe de jurnalizare.
add_action('blockstudio/error/logged', function($message, $level, $context) {
if ($level === 'error') {
my_external_logger($message, $context);
}
}, 10, 3);
error/exception
Acțiunea se declanșează după gestionarea unei excepții.
add_action('blockstudio/error/exception', function($exception, $context) {
my_error_tracker($exception);
}, 10, 2);
Bază de date
Toate hook-urile bazei de date primesc un singur tablou $params.
db/before_create
Acțiunea se declanșează înainte de crearea unei înregistrări.
add_action('blockstudio/db/before_create', function($params) {
// $params: block, schema, data, storage
});
db/after_create
Acțiunea se declanșează după crearea unei înregistrări.
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
Acțiunea se declanșează înainte de actualizarea unei înregistrări.
add_action('blockstudio/db/before_update', function($params) {
// $params: block, schema, id, data, storage
});
db/after_update
Acțiunea se declanșează după actualizarea unei înregistrări.
add_action('blockstudio/db/after_update', function($params) {
// $params: block, schema, id, record, storage
});
db/before_delete
Acțiunea se declanșează înainte de ștergerea unei înregistrări.
add_action('blockstudio/db/before_delete', function($params) {
// $params: block, schema, id, storage
});
db/after_delete
Acțiunea se declanșează după ștergerea unei înregistrări.
add_action('blockstudio/db/after_delete', function($params) {
// $params: block, schema, id, storage
});
RPC
Toate hook-urile RPC primesc un singur tablou $params.
rpc/before_call
Acțiunea se declanșează înainte de apelarea unei funcții RPC.
add_action('blockstudio/rpc/before_call', function($params) {
// $params: block, function, params
});
rpc/after_call
Acțiunea se declanșează după apelarea unei funcții RPC.
add_action('blockstudio/rpc/after_call', function($params) {
// $params: block, function, params, result
});