PHP hook’id
Altpoolt leiate kõigi saadaolevate PHP hook’ide loendi. Neid saab kasutada plugina funktsionaalsuse laiendamiseks või kohandamiseks.
Tee
See filter võimaldab muuta ploki kausta teed. Vaikimisi asub see aktiivse teema sees aadressil blockstudio. Alternatiivina saab luua uue eksemplari mitme lähtekataloogi jaoks.
add_filter('blockstudio/path', function() {
$path = get_stylesheet_directory() . '/blocks';
return $path;
});
Initsialiseerimine
globaalne
See toiming käivitub pärast seda, kui plugin on kõik plokid registreerinud.
add_action('blockstudio/init', function($blocks) {
// All blocks have been registered
});
eksemplar
See toiming käivitub pärast seda, kui plugin on konkreetse eksemplari kõik plokid registreerinud.
Segment $instance on eksemplari tee suhtes wp-content.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/$instance", function() {
// All blocks of this instance have been registered
});
global/before
See toiming käivitub enne, kui plugin on kõik plokid registreerinud.
add_action('blockstudio/init/before', function() {
// Before blocks are registered
});
global/before/$instance
See toiming käivitub enne, kui plugin on konkreetse eksemplari kõik plokid registreerinud.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/before/$instance", function() {
// Before blocks of this instance are registered
});
Plokid
render
See filter võimaldab muuta ploki väljundit enne selle renderdamist.
add_filter('blockstudio/blocks/render', function($content, $block, $attributes) {
// Modify the block content
return $content;
}, 10, 3);
meta
See filter võimaldab muuta faili block.json andmeid enne selle registreerimist.
add_filter('blockstudio/blocks/meta', function($meta, $block) {
if (str_starts_with($block['name'], 'marketing')) {
$meta['icon'] = 'megaphone';
}
return $meta;
}, 10, 2);
Ülaltoodud kood muudaks kõigi nimega marketing algavate plokkide ikooni.
tingimused
See filter võimaldab lisada kohandatud tingimusi, mida saab plokkides kasutada. Iga tingimuse tüüp vastab väärtusele, mida redaktor võrdleb tingimuse väärtusega value. Vaadake jaotist Kohandatud tingimused.
add_filter('blockstudio/blocks/conditions', function($conditions) {
$conditions['myCustomCondition'] = 'expected';
return $conditions;
});
atribuudid
See filter muudab enne ploki registreerimist ühe välja määratlust. Filtreeritud määratlus määrab redaktori juhtelemendi ja renderdamisaegse väärtuse valideerimise. Lisateavet leiate jaotisest Filtreerimine.
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
// Modify this field definition before registration.
return $attribute;
}, 10, 2);
attributes/render
See filter muudab ühe välja väärtust enne, kui see plokimallile edastatakse. Seda käivitatakse iga välja kohta üks kord ning see saab kolm argumenti: $value (lahendatud väärtus), $key (välja võti, nagu seda kasutatakse üksuses $a) ja $block (plokiandmete massiiv, mille mallid saavad kui $block või $b). Registreerimisel määra aktsepteeritavate argumentide arvuks kolm. Lisateavet leiate jaotisest Filtreerimine.
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
files väli tagastab iga pildi koos sizes massiiviga, mis sisaldab URL-t ning full ja iga registreeritud pildisuuruse laiust ja kõrgust, näiteks $image['sizes']['thumbnail'] ja $image['sizes']['thumbnail-width']. Iga suurus tähendab ühe wp_get_attachment_image_src() kutse tegemist pildi kohta, seega rakenduvad sellele endiselt filtrid. Mallid, mis ei loe kunagi sizes-t, võivad loendi eemaldada või seda lühendada.
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 on suuruste nimede loend; esimesena on full (tühi, kui vahesuurusi pole registreeritud). $id on manuse ID ja $size on suurus, mida väärtuse url jaoks taotletakse. Filter muudab päringu iga failiväärtuse sizes massiivi. Ilma selleta jääb massiiv muutmata.
Tagasta suuruste nimed stringidena. Vigased kirjed jäetakse vahele, korduvad nimed lahendatakse ühe korra ja massiivist erineva tagastusväärtuse korral suurusi ei töödelda. Taotletud url ja muud manuse omadused jäävad muutmata. Seda haaki ei käivitata faili välja puhul, millel on returnFormat: "url"; sel juhul suuruste vastendust ei looda.
attributes/validate
Kohanda selgesõnaliste bs_validate_block() kutsete tulemusi, näiteks siis, kui kohandatud renderdusfilter lahendab salvestatud viited. See ei luba salvestamisel ega renderdamisel automaatset valideerimist.
add_filter('blockstudio/blocks/attributes/validate', function($findings, $name, $attrs) {
return $findings;
}, 10, 3);
Tagasta leidude loend. Filtrit ei kutsuta, kui plokil pole Blockstudio välju ega sobivaid laiendusi (null).
attributes/schema
Kohandage JSON skeemi, mille tagastab bs_block_schema(), näiteks juhul, kui kohandatud renderdusfilter lahendab salvestatud viited.
add_filter('blockstudio/blocks/attributes/schema', function($schema, $name) {
return $schema;
}, 10, 2);
Tagastage skeemi massiiv. Filtrit ei kutsuta, kui plokil pole Blockstudio välju ega sobivaid laiendusi (null).
attributes/populate
See filter võimaldab lisada kohandatud andmeid välja checkbox, select või radio valikutesse. Lisateavet leiate jaotisest Valikute täitmine.
Filter saab ühe argumendi: kõigi kohandatud andmekogumite massiivi, mille võtmed on failis "populate": {"type": "custom", "custom": "myCustomOptions"} kasutatud nimed.
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
See filter võimaldab muuta sisu useBlockProps väljundit.
Kõik komponendifiltrid (use_block_props, inner_blocks ja rich_text) saavad ploki viimase argumendina. $block on renderdatava ploki jaoks registreeritud WP_Block_Type, seega on $block->name ploki nimi, näiteks acme/hero.
$props on string, mis sisaldab HTML atribuute, mitte massiiv. Eesosas on see väärtuse get_block_wrapper_attributes() tulemus, näiteks class="wp-block-acme-hero my-class". Redaktoris on see elemendi atribuut class. Tagasta string. Redaktoris rakendatakse tagastatud stringist ainult atribuuti class.
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
See filter võimaldab muuta sisu <InnerBlocks /> väljundit.
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
See filter võimaldab eemaldada kasutajaliidesest ümbrise <InnerBlocks />.
add_filter('blockstudio/blocks/components/inner_blocks/frontend/wrap', function($wrap, $block) {
return false; // Remove wrapper
}, 10, 2);
components/rich_text/render
See filter võimaldab kohandada sisu <RichText /> väljundit. See saab argumendiks atribuudi väärtuse ja ploki.
add_filter('blockstudio/blocks/components/rich_text/render', function($content, $block) {
return wp_kses_post($content);
}, 10, 2);
Plokisildid
blockstudio/block_tags/builders
See filter registreerib ploki massiivi koostajad, mida kasutavad plokisildid ja kohandatud plokid, mis on valitud blockstudio/parser/element_mapping kaudu. Iga koostaja saab parsitud atribuudid ja töötlemata sisuteksti.
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);
Ühilduvad filtrid blockstudio/block_tags/renderers ja blockstudio/parser/renderers käivituvad pärast seda hook’i ning võivad sama plokinime üle kirjutada.
blockstudio/block_tags/tag_aliases
See filter võimaldab registreerida kohandatud sidekriipsudega autorimissilte, mis teisendatakse tegelikeks plokinimedeks enne töötlemata HTML varuvariandi kasutamist. See on kasulik, kui teema vajab lühikesi projektipõhiseid silte, mis renderdavad siiski standardseid Blockstudio või tuumaplokke.
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
See filter võimaldab vastendada prefiksi lühivorme ühe või mitme plokinimeruumiga. Iga võti on väiketähtedest koosnev prefiks ilma sidekriipsudeta. Iga väärtus võib olla nimeruumi string või järjestatud nimeruumide loend.
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> lahendatakse kujule theme-components/card. <theme-button> proovib esmalt theme-components/button ja kasutab seejärel varuvariandina bsui/button. Selgesõnalised blockstudio/block_tags/tag_aliases kirjed on sama sildi puhul eelisjärjekorras ning lahendamata prefiksiga sildid jäetakse muutmata.
Prefikseid saab kombineerida: kui prefiksiga silti ei saa otse lahendada ja selle slug on ise registreeritud prefiksisilt, jätkub lahendamine rekursiivselt. theme => ['theme-components'] ja ui => ['bsui'] korral liigub <theme-ui-input> edasi prefiksile ui ja lahendatakse kujule bsui/input. Registreeritud prefiksi- ja alias-sildid renderdatakse ka plokimalli väljundis, mitte ainult lehe sisus.
Seaded
tee
See filter võimaldab muuta faili blockstudio.json teed. Vaikimisi asub see aktiivses teemas siin: blockstudio.json.
add_filter('blockstudio/settings/path', function() {
return get_stylesheet_directory() . '/config/blockstudio.json';
});
users/ids
See filter võimaldab lubada redaktori kindlatele kasutaja ID-dele.
add_filter('blockstudio/settings/users/ids', function() {
return [1];
});
users/roles
See filter võimaldab lubada redaktori kindlatele kasutajarollidele.
add_filter('blockstudio/settings/users/roles', function() {
return ['administrator', 'editor'];
});
assets/enqueue
See filter võimaldab lubada või keelata varade lisamise järjekorda nii saidi kasutajaliideses kui ka redaktoris.
add_filter('blockstudio/settings/assets/enqueue', function() {
return false;
});
assets/reset/enabled
See filter võimaldab lubada või keelata WordPress tuumaploki stiilide eemaldamise ning redaktori paigutuse lähtestamise utiliidi.
add_filter('blockstudio/settings/assets/reset/enabled', function() {
return true;
});
assets/reset/full_width
See filter võimaldab määrata, millised postitusetüübid kasutavad täislaiuses redigeerimist.
add_filter('blockstudio/settings/assets/reset/full_width', function() {
return ['page'];
});
assets/minify/css
See filter võimaldab lubada või keelata CSS minimeerimise.
add_filter('blockstudio/settings/assets/minify/css', function() {
return true;
});
assets/minify/js
See filter võimaldab lubada või keelata JS minimeerimise.
add_filter('blockstudio/settings/assets/minify/js', function() {
return true;
});
assets/process/scss
See filter võimaldab lubada või keelata SCSS töötlemise .css-failides.
add_filter('blockstudio/settings/assets/process/scss', function() {
return true;
});
assets/process/scss_files
See filter võimaldab lubada või keelata .scss-failide töötlemise kujule CSS.
add_filter('blockstudio/settings/assets/process/scss_files', function() {
return true;
});
assets/output
See filter võimaldab määrata, kuhu kompileeritud plokivarad kirjutatakse.
add_filter('blockstudio/settings/assets/output', function() {
return 'cache';
});
assets/inline_limit
See filter võimaldab määrata, mitu baiti välise ploki CSS andmeid lehekülje kohta kaasatakse.
add_filter('blockstudio/settings/assets/inline_limit', function() {
return 40000;
});
cache/enabled
See filter võimaldab lubada või keelata kõik Blockstudio failipõhised käitusaja- ja redaktori varade vahemälud.
add_filter('blockstudio/settings/cache/enabled', function() {
return false;
});
cache/path
See filter võimaldab muuta Blockstudio failipõhise vahemälu kataloogi.
add_filter('blockstudio/settings/cache/path', function() {
return 'cache/blockstudio';
});
cache/namespace_grace
See filter võimaldab muuta, kui kaua säilitatakse kasutuselt kõrvaldatud vahemälu nimeruumi enne selle kustutamist.
add_filter('blockstudio/settings/cache/namespace_grace', function() {
return 777600;
});
githooks/commit
See filter näitab, kas Blockstudio hallatav PHPStan commit-hook on lubatud.
add_filter('blockstudio/settings/githooks/commit', function() {
return true;
});
content/enabled
See filter võimaldab lubada või keelata sisusünkroonimise.
add_filter('blockstudio/settings/content/enabled', function() {
return true;
});
content/id
See filter võimaldab määrata sisusünkroonimise omandamise nimeruumi.
add_filter('blockstudio/settings/content/id', function() {
return 'docs';
});
content/path
See filter võimaldab määrata sisusünkroonimise failikataloogi.
add_filter('blockstudio/settings/content/path', function() {
return 'content';
});
content/include_page_sync_managed
See filter võimaldab kaasata või välistada Page Synci hallatavaid postitusi.
add_filter('blockstudio/settings/content/include_page_sync_managed', function() {
return false;
});
content/authors
See filter võimaldab seadistada sisusünkroonimise autorite käsitlemist.
add_filter('blockstudio/settings/content/authors', function() {
return 'ignore';
});
content/post_types
See filter võimaldab seadistada sisusünkroonimise postitusetüüpide lubatud loendeid.
add_filter('blockstudio/settings/content/post_types', function() {
return ['team_member'];
});
content/taxonomies
See filter võimaldab seadistada sisusünkroonimise taksonoomiate lubatud loendeid.
add_filter('blockstudio/settings/content/taxonomies', function() {
return ['category', 'post_tag'];
});
content/media
See filter võimaldab seadistada sisusünkroonimise meedia käsitlemist.
add_filter('blockstudio/settings/content/media', function() {
return 'manifest';
});
tailwind/enabled
See filter võimaldab lubada või keelata Tailwind.
add_filter('blockstudio/settings/tailwind/enabled', function() {
return true;
});
tailwind/config
See filter võimaldab lisada kohandatud Tailwind CSS konfiguratsiooni.
add_filter('blockstudio/settings/tailwind/config', function() {
return '@theme { --color-primary: pink; }';
});
tailwind/output
See filter võimaldab valida, kas Tailwind CSS väljund lisatakse tekstisiseselt või lingituna.
add_filter('blockstudio/settings/tailwind/output', function() {
return 'link';
});
ui/enabled
See filter võimaldab lubada või keelata komplekti kuuluvaid UI komponente.
add_filter('blockstudio/settings/ui/enabled', function() {
return true;
});
editor/format_on_save
See filter võimaldab lubada või keelata koodi vormindamise salvestamisel.
add_filter('blockstudio/settings/editor/format_on_save', function() {
return true;
});
editor/assets
See filter võimaldab lisada redaktorisse täiendavaid varasid.
add_filter('blockstudio/settings/editor/assets', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
editor/markup
See filter võimaldab lisada redaktori lõppu täiendavat märgendust.
add_filter('blockstudio/settings/editor/markup', function() {
return '<style>body { background: black; }</style>';
});
block_editor/disable_loading
See filter võimaldab keelata plokkide laadimise plokiredaktoris.
add_filter('blockstudio/settings/block_editor/disable_loading', function() {
return true;
});
block_editor/enhance
See filter võimaldab lubada Blockstudio redaktori funktsioone, nagu selgemad fookusstiilid ning hõljutamise ja valiku piirjooned.
add_filter('blockstudio/settings/block_editor/enhance', function() {
return true;
});
block_editor/css_classes
See filter võimaldab lisada laaditabeleid, mille klassid on klassiväljal valitavad.
add_filter('blockstudio/settings/block_editor/css_classes', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/css_variables
See filter võimaldab lisada laaditabeleid, mille CSS muutujad on koodiväljal automaatseks lõpetamiseks saadaval.
add_filter('blockstudio/settings/block_editor/css_variables', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/blocks/allow
See filter võimaldab määrata, millised plokinimed on lisajas lubatud.
add_filter('blockstudio/settings/block_editor/blocks/allow', function() {
return ['core/*', 'acf/*', 'my-theme/*'];
});
block_editor/blocks/deny
See filter võimaldab eemaldada plokinimed lisajast.
add_filter('blockstudio/settings/block_editor/blocks/deny', function() {
return ['core/embed', 'core/freeform'];
});
block_editor/blocks/directory
See filter võimaldab WordPress plokikataloogi varad redaktoris lubada või keelata.
add_filter('blockstudio/settings/block_editor/blocks/directory', function() {
return false;
});
block_editor/blocks/categories/allow
See filter võimaldab määrata, millised plokikategooriate slug’id jäävad kättesaadavaks.
add_filter('blockstudio/settings/block_editor/blocks/categories/allow', function() {
return ['text', 'media', 'design'];
});
block_editor/blocks/categories/deny
See filter võimaldab eemaldada plokikategooriate slug’id lisajast.
add_filter('blockstudio/settings/block_editor/blocks/categories/deny', function() {
return ['embed'];
});
block_editor/blocks/categories/rename
See filter võimaldab plokikategooriate silte slug’i järgi ümber nimetada.
add_filter('blockstudio/settings/block_editor/blocks/categories/rename', function() {
return [
'text' => 'Writing',
'design' => 'Layout'
];
});
block_editor/blocks/categories/order
See filter võimaldab määrata plokikategooriate slug’ide järjekorra lisajas.
add_filter('blockstudio/settings/block_editor/blocks/categories/order', function() {
return ['my-theme', 'text', 'media'];
});
block_editor/blocks/styles/deny
See filter võimaldab plokinime järgi tühistada PHP registreeritud plokistiilide registreeringu.
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
See filter võimaldab peita pärandvidina ploki eest täiendavaid pärandvidinaid.
add_filter('blockstudio/settings/block_editor/blocks/legacy_widgets/hide', function() {
return ['archives', 'calendar'];
});
block_editor/patterns/core
See filter võimaldab lubada või keelata WordPress tuumaplokimustrid.
add_filter('blockstudio/settings/block_editor/patterns/core', function() {
return false;
});
block_editor/patterns/remote
See filter võimaldab lubada või keelata kaughankega mustrid WordPress mustrikataloogist.
add_filter('blockstudio/settings/block_editor/patterns/remote', function() {
return false;
});
block_editor/patterns/theme
See filter võimaldab lubada või keelata teemaga kaasas olevaid plokimustreid.
add_filter('blockstudio/settings/block_editor/patterns/theme', function() {
return false;
});
block_editor/patterns/blockstudio
See filter võimaldab lubada või keelata Blockstudio failipõhiseid mustreid.
add_filter('blockstudio/settings/block_editor/patterns/blockstudio', function() {
return false;
});
block_editor/patterns/categories/allow
See filter võimaldab määrata, millised mustrikategooriate slug’id jäävad kättesaadavaks.
add_filter('blockstudio/settings/block_editor/patterns/categories/allow', function() {
return ['featured', 'buttons', 'columns'];
});
block_editor/patterns/categories/deny
See filter võimaldab eemaldada mustrikategooriate slug’id mustrilisajast.
add_filter('blockstudio/settings/block_editor/patterns/categories/deny', function() {
return ['gallery'];
});
block_editor/patterns/categories/rename
See filter võimaldab mustrikategooriate silte slug’i järgi ümber nimetada.
add_filter('blockstudio/settings/block_editor/patterns/categories/rename', function() {
return [
'featured' => 'Featured Layouts'
];
});
block_editor/patterns/categories/order
See filter võimaldab määrata mustrikategooriate slug’ide järjekorra lisajas.
add_filter('blockstudio/settings/block_editor/patterns/categories/order', function() {
return ['featured', 'buttons'];
});
block_editor/media/openverse
See filter võimaldab plokiredaktori meedialisajas Openverse meediakategooria lubada või keelata.
add_filter('blockstudio/settings/block_editor/media/openverse', function() {
return false;
});
block_editor/media/image_sizes/allow
See filter võimaldab määrata, millised pildisuuruste nimed jäävad redaktori meediajuhtelementides kättesaadavaks.
add_filter('blockstudio/settings/block_editor/media/image_sizes/allow', function() {
return ['thumbnail', 'large'];
});
block_editor/media/image_sizes/deny
See filter võimaldab eemaldada redaktori meediajuhtelementidest pildisuuruste nimesid.
add_filter('blockstudio/settings/block_editor/media/image_sizes/deny', function() {
return ['medium_large'];
});
ai/enable_context_generation
See filter võimaldab luua kontekstifaili LLM-i tööriistadega integreerimiseks. Kui see on lubatud, koondab kontekstifail ühte allikasse ajakohased plokiandmed, praeguse installi Blockstudio seaded, kõik asjakohased skeemid ja Blockstudio dokumentatsiooni, mida saavad kasutada tehisintellekti arendustööriistad.
add_filter('blockstudio/settings/ai/enable_context_generation', function() {
return true;
});
block_tags/enabled
See filter võimaldab lubada või keelata plokisiltide renderdamise lehe tasemel.
add_filter('blockstudio/settings/block_tags/enabled', function() {
return true;
});
block_tags/prefixes
See filter võimaldab registreerida prefiksi ja nimeruumi lühivormide vastendusi plokisiltidele.
add_filter('blockstudio/settings/block_tags/prefixes', function() {
return [
'theme' => ['theme-components', 'bsui']
];
});
dev/grab/enabled
See filter võimaldab lubada või keelata elemendi haaraja.
add_filter('blockstudio/settings/dev/grab/enabled', function() {
return false;
});
dev/perf
See filter võimaldab lubada või keelata jõudlusprofileri.
add_filter('blockstudio/settings/dev/perf', function() {
return false;
});
dev/canvas/enabled
See filter võimaldab lõuendi lubada või keelata.
add_filter('blockstudio/settings/dev/canvas/enabled', function() {
return false;
});
dev/canvas/admin_bar
See filter võimaldab lõuendil WordPress admini tööriistariba kuvada või peita.
add_filter('blockstudio/settings/dev/canvas/admin_bar', function() {
return true;
});
WPML
blockstudio/wpml/config/label
Filtreerib iga võtme silti, mille wp bs wpml config kirjutab. Kontekstimassiivi kohta vaata jaotist Siltide muutmine.
add_filter('blockstudio/wpml/config/label', function($label, $context) {
return str_replace(' (optional)', '', $label);
}, 10, 2);
Lõuend
blockstudio/canvas/inventory
See filter muudab valiku kohta esitatavat lõuendi varade loendit. Tagasihelistusfunktsioon saab varade loendi DTO, algse valiku ja sellele edastatud suvandid.
add_filter('blockstudio/canvas/inventory', function(array $result, array $selection, array $options) {
return $result;
}, 10, 3);
blockstudio/canvas/documents
See filter muudab lõuendi tagastatavaid renderdatud dokumente ning kasutab samu kolme argumenti nagu varade loendi filter.
blockstudio/canvas/item_loaded
See toiming käivitub iga varade kirje laadimisel ning saab varade tüübi, kanoonilise kirje ID ja normaliseeritud kirje.
blockstudio/canvas/source_compiled
See toiming käivitub pärast lähtefaili kompileerimist lõuendi jaoks ning saab valitud lähtefaili tee ja kanoonilise lähtekirje.
Komplekti kuuluvad UI
blockstudio/ui/directories
See filter muudab komplekti kuuluvate UI komponentide jaoks läbiotsitavaid katalooge.
blockstudio/ui/inventory
See filter muudab avalikku UI perekondade loendit.
blockstudio/ui/examples
See filter muudab näidiskirjeid UI ning saab näited ja avaliku UI loendi, millest need tuletati.
Topoloogia
blockstudio/blocks/topology_refreshed
See toiming käivitub pärast plokitopoloogia taastamist.
blockstudio/pages/topology_refreshed
See toiming käivitub pärast lehe topoloogia taastamist.
blockstudio/pages/layout_error
See toiming käivitub, kui lehe paigutuse renderdamine ebaõnnestub, et tõrke korral ei vaikita.
Käitusaeg
blockstudio/runtime/initialized
See toiming käivitub pärast seda, kui käituskeskkond on oma konfiguratsiooni lahendanud.
blockstudio/runtime/changed
See toiming käivitub, kui lahendatud käituskeskkonna identiteet muutub, mis muudab vahemälu nimeruume ja staatilist eelrenderdusolekut.
blockstudio/performance/default_config
See filter muudab jõudluse vaikesätteid enne, kui projekt lisab neile oma blockstudio.json väärtused.
Sisu
blockstudio/content/orphan_action
See filter määrab, mida sisusünkroonimine teeb kirjega, millel pole enam allikat.
Bootstrap
blockstudio/url
See filter muudab avalikku URL, mida Blockstudio kasutab redaktori- ja adminivarade jaoks. Composer integratsioonid peavad selle registreerima enne, kui laaditakse Blockstudio autolaaduri fail. Teine argument on paketi füüsiline kataloog.
add_filter(
'blockstudio/url',
function(string $url, string $directory) {
return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
},
10,
2
);
Käitusaja vahemälu
blockstudio/cache/dir
See filter saab lahendatud vahemälu baaskataloogi enne, kui sellele lisatakse käituskeskkonna, redaktori varade või muu vahemälu ulatus.
add_filter('blockstudio/cache/dir', function(string $directory) {
return WP_CONTENT_DIR . '/cache/blockstudio';
});
blockstudio/cache/context
See filter lisab vahemälu identiteetidele serialiseeritava käitusaja variandi. Kasutage seda juhul, kui sama avastusallikas võib valida erinevad loogilised varade loendid.
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
See filter muudab võrgu või ajaveebi kataloogi identiteeti hostide puhul, millel on oma rentniku piir. Tagastatud väärtus puhastatakse enne kasutamist.
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
See filter lisab hostiandmed, mis mõjutavad iga objekti käitusaja ulatuses. Üksusepõhised allika sõrmejäljed tuleks selle asemel edastada selgesõnaliste sõltuvustena vastutava API poolt.
add_filter(
'blockstudio/runtime/identity',
function(array $identity, string $scope) {
$identity['deployment'] = getenv('RELEASE_SHA') ?: 'local';
return $identity;
},
10,
2
);
blockstudio/cache/watch_debounce
Määrab sekundite arvu, mille jooksul saab valideeritud failijälgimise hetktõmmist korduskasutada ilma uut failisüsteemi stat-päringut tegemata. Vaikimisi on väärtus 0 kohalikes ja arenduskeskkondades ning 20 mujal.
add_filter('blockstudio/cache/watch_debounce', function() {
return 30;
});
blockstudio/cache/build_wait_budget
Määrab millisekundites, kui kaua päring ootab, kuni samaaegne koostaja avaldab käitusaja vahemälu või valikute värskenduse, enne kui töö jätkub vähendatud võimalustega. Vaikimisi on väärtus struktuursete taasloomiste puhul 5000 ja valikute värskenduste puhul 4000.
add_filter('blockstudio/cache/build_wait_budget', function() {
return 2000;
});
blockstudio/cache/populate_debounce
Määrab, mitu sekundit koondatakse sisu-, termini-, kasutaja- või metaandmete kirjutamiste tulv üheks täidetud valikute värskenduseks. Esimene kirjutamine pärast vaikset perioodi käivitab värskenduse kohe; tulva viimane kirjutamine kajastub pärast ajavahemiku möödumist. Vaikimisi on väärtus 30. Iga kirjutamise järel värskendamiseks tagastage 0.
add_filter('blockstudio/cache/populate_debounce', function() {
return 120;
});
blockstudio/cache/populate_ignored_meta_keys
Filtreerib meta võtmeid, mille kirjutamisel täidetud valikuid kunagi ei värskendata. Vaikimisi on need võtmed, mida WordPress kasutab muutmise ja sisselogimise arvestuseks: _edit_lock, mida värskendavad redaktor ja Heartbeat postituse avatud oleku ajal; _edit_last, mis kirjutatakse salvestamise käigus, millega värskendamine juba kaasneb; ning session_tokens, mis kirjutatakse sisse- ja väljalogimisel. Lisa võtmed, mis muutuvad sageli, kuid ei mõjuta kunagi täitmise päringut.
add_filter('blockstudio/cache/populate_ignored_meta_keys', function(array $keys) {
$keys[] = '_my_view_counter';
return $keys;
});
blockstudio/cache/max_files_per_scope
Määrab avaldatud koormuste arvu, mida iga käitusaja vahemälu ulatus säilitab.
add_filter('blockstudio/cache/max_files_per_scope', function($maximum, $scope) {
return $scope === 'runtime' ? 50 : $maximum;
}, 10, 2);
blockstudio/cache/compress
Filtreerib, kas vahemälu andmestikus kasutatakse tavalise PHP massiivi asemel tihendatud jadavormingus andmeid. Vaikimisi kasutatakse tavalist vormingut ainult kuni 1 MiB suuruste andmestike puhul ning üksnes siis, kui aktiivne OPcache’i jagatud mälu suudab sihtfaili vahemällu salvestada. Muud protsessid, välistatud failid ja suuremad andmestikud tihendatakse.
add_filter('blockstudio/cache/compress', function($compress, $scope) {
return $scope === 'runtime' ? false : $compress;
}, 10, 2);
Väärtuse false tagastamine tühistab ka suurusepiirangu. See võib olla abiks siis, kui WP-CLI soojendab OPcache’iga veebitöötajate jaoks faile ilma opcache.enable_cli, kuid iga OPcache’ita lugeja parsib genereeritud massiivi. Kasuta suurte jagatud andmestike puhul tihendamist, kui lisakulu mälule pole vastuvõetav. Vaikimisi kaitsemeetmete kohta vaata jaotist vahemälu andmestike vormingud.
blockstudio/cache/protected_paths
Vahemälu teede säilitamise puhastus ei tohi neid kunagi eemaldada. Blockstudio lisab sinna kõik failid, millele viitab installitud varase teenindamise kaart.
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
See toiming teatab jagatud vahemälu ulatusest ja tulemusest, näiteks hit, build, miss-stale, stale-last-good või 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
See filter saab lõpliku anonüümsuse tagamise otsuse ning serveri- ja küpsisepõhised sisendid. Väärtuse true tagastamisel jäetakse staatiline teenindamine ja genereerimine alati vahele.
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
See filter pakub või muudab täielikku avalikku URL loendit, mida kasutavad ajastatud soojendaja ja selgesõnalised graafikutööriistad.
add_filter('blockstudio/static_prerender/public_urls', function(array $urls) {
$urls[] = home_url('/custom-route/');
return array_values(array_unique($urls));
});
Filtri tagastatav väärtus ei ole lõplik loend. Tulemus läbib vahemällu salvestatavuse kontrolli, mis eemaldab kõik seadistatud dünaamilisele teele vastavad kirjed ning vaikimisi vahele jäetavad kirjed: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, kõik teed, mis sisaldavad /feed/, ning otsingutulemused saidi avalehe otsingupõhja all (vaikimisi /search/). Teie lisatud URL võidakse seega hoiatamata kõrvale jätta. Kui eeldatav marsruut puudub koostatud loendist, kontrollige enne filtri käivitumata jäämise järeldamist, kas see vastab neile reeglitele.
blockstudio/static_prerender/render_internal
See filter rakendab valikulist protsessisisest paketttransporti. Tagastage normaliseeritud tulemuste massiiv või jätke väärtus muutmata, et renderdaja kasutaks seadistatud HTTP varuvarianti. Tulemus sisaldab html ning valikuliselt status, dependencies, virtualHashes ja headers; päised, mille nimed on loetletud jaotises performance.staticPrerender.replayHeaders, salvestatakse koos dokumendiga.
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
See filter teeb lõpliku otsuse pärast seda, kui Blockstudio on kontrollinud, et väljund on täielik HTML dokument ilma vahemälu keelava markerita ning et tuvastatud vastuse olek on edukas. Kolmas argument on tuvastatud olek või null, kui olekut pole määratud.
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
See toiming teatab staatilise eelrenderduse tulemustest, sealhulgas vahemäluhittidest, möödalaskudest, kirjutamistest, graafikukirjutamistest, aegunud kirjetest ja tõrgetest.
add_action('blockstudio/static_prerender/outcome', function(string $reason) {
my_metrics()->increment("blockstudio.prerender.{$reason}");
});
blockstudio/tailwind/cache_max_files
Määrab kompileeritud Tailwind CSS kirjete suurima arvu. Vaikimisi on 1000.
add_filter('blockstudio/tailwind/cache_max_files', function() {
return 1500;
});
blockstudio/tailwind/cache_max_age
Määrab kompileeritud Tailwind CSS kirjete maksimaalse vanuse sekundites. Vaikimisi on 30 päeva ja miinimum on üks tund.
add_filter('blockstudio/tailwind/cache_max_age', function() {
return 14 * DAY_IN_SECONDS;
});
Haldusala
lubatud
See filter võimaldab lubada või keelata Blockstudio adminilehe menüüpunktis Tööriistad > Blockstudio.
add_filter('blockstudio/admin/enabled', function() {
return false;
});
Varad
editor/canvas/body_class
Kui varade lähtestamine on lubatud, muudab see filter puhastatud saidi kasutajaliidese body-klasse, mis kopeeritakse plokiredaktori lõuendile.
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
return array_values(array_diff($classes, ['logged-in']));
});
luba
See filter võimaldab konkreetse varatüübi töötlemise ja järjekorda lisamise keelata.
add_filter('blockstudio/assets/enable', function($enable, $type, $block) {
if ($type === 'css' && $block['name'] === 'my/block') {
return false;
}
return $enable;
}, 10, 3);
keela
See filter võimaldab varasid nende ID järgi keelata. Tagastatud massiivis olevale ID-le vastavaid varasid saidi kasutajaliideses ei renderdata.
add_filter('blockstudio/assets/disable', function($disabled) {
$disabled[] = 'my-block-style';
return $disabled;
});
process/scss/import_paths
See filter võimaldab lisada täiendavaid radu @import lausele SCSS kompilaatoris.
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
$paths[] = get_stylesheet_directory() . '/scss';
return $paths;
});
process/scss/prelude
See filter võimaldab lisada iga SCSS faili ette ühiskasutatava Sass koodi enne kompileerimist.
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
See filter võimaldab muuta CSS faili sisu enne selle kompileerimist.
add_filter('blockstudio/assets/process/css/content', function($content, $block) {
return str_replace('old-class', 'new-class', $content);
}, 10, 2);
process/js/content
See filter võimaldab muuta JS faili sisu enne selle kompileerimist.
add_filter('blockstudio/assets/process/js/content', function($content, $block) {
return $content;
}, 10, 2);
Puhver
lubatud
Blockstudio puhverdab saidi kasutajaliidese vastuse, et kehas renderdatud ploki stiili- ja skriptisildid saaks tõsta päisesse ja jalusesse ning Tailwind saaks skannida kogu dokumendi. Puhverdamine tähendab kogu dokumendi hoidmist ja skannimist iga kasutajaliidese päringu korral; sait, mis ei renderda Blockstudio ploki varasid ega kasuta Tailwind, võib tagastada false, et mõlemad vahele jätta.
add_filter('blockstudio/buffer/enabled', '__return_false');
Administraatorivaates ja Customizeri eelvaates puhverdamine samuti ei toimi. Kutsu bs_is_buffering() funktsiooni wp_enqueue_scripts kaudu või hiljem, et teada saada, kas praegune vastus on puhverdatud. Enne otsuse tegemist punktis template_redirect tagastab see väärtuse false.
väljund
See filter saab täieliku puhverdatud HTML dokumendi enne selle saatmist. Blockstudio enda varade tõstmine käivitub prioriteediga 1000000 ja Tailwind kompileerimine prioriteediga 999999, seega käivitage filter varem, et näha dokumenti enne neid, või hiljem, et näha lõplikku väljundit.
add_filter('blockstudio/buffer/output', function(string $html) {
return $html;
}, 2000000);
Renderdamine
sõltuvused
See filter teatab valitud mallist ja varade sõltuvustest iga kord, kui Blockstudio ploki renderdab. See on kasulik staatilistele eksportijatele ja teistele protsessisisestele sõltuvuste kogujatele.
add_filter(
'blockstudio/render/dependencies',
function($paths, $name, $block, $isEditor, $isPreview) {
my_dependency_graph()->add($name, $paths);
return $paths;
},
10,
5
);
globaalne
See filter võimaldab muuta lehe väljundit enne selle renderdamist.
add_filter('blockstudio/render', function($content) {
return $content;
});
päis
See filter võimaldab kohandada silti <head> enne renderdamist. See käivitub ainult siis, kui Blockstudio puhverdab vastuse; vaata jaotist bs_is_buffering().
add_filter('blockstudio/render/head', function($content) {
return $content . '<meta name="custom" content="value">';
});
jalus
See filter võimaldab muuta väljundit </body> enne selle renderdamist.
add_filter('blockstudio/render/footer', function($content) {
return $content . '<script>console.log("loaded")</script>';
});
Tõrgete käsitlemine
error/logged
Toiming käivitub pärast vea logimist. Selle abil saab saata vead välistesse logimisteenustesse.
add_action('blockstudio/error/logged', function($message, $level, $context) {
if ($level === 'error') {
my_external_logger($message, $context);
}
}, 10, 3);
error/exception
Toiming käivitub pärast erindi käsitlemist.
add_action('blockstudio/error/exception', function($exception, $context) {
my_error_tracker($exception);
}, 10, 2);
Andmebaas
Kõik andmebaasi hook’id saavad ühe $params massiivi.
db/before_create
Toiming käivitub enne kirje loomist.
add_action('blockstudio/db/before_create', function($params) {
// $params: block, schema, data, storage
});
db/after_create
Toiming käivitub pärast kirje loomist.
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
Toiming käivitub enne kirje uuendamist.
add_action('blockstudio/db/before_update', function($params) {
// $params: block, schema, id, data, storage
});
db/after_update
Toiming käivitub pärast kirje uuendamist.
add_action('blockstudio/db/after_update', function($params) {
// $params: block, schema, id, record, storage
});
db/before_delete
Toiming käivitub enne kirje kustutamist.
add_action('blockstudio/db/before_delete', function($params) {
// $params: block, schema, id, storage
});
db/after_delete
Toiming käivitub pärast kirje kustutamist.
add_action('blockstudio/db/after_delete', function($params) {
// $params: block, schema, id, storage
});
RPC
Kõik RPC hook’id saavad ühe $params massiivi.
rpc/before_call
Toiming käivitub enne funktsiooni RPC väljakutsumist.
add_action('blockstudio/rpc/before_call', function($params) {
// $params: block, function, params
});
rpc/after_call
Toiming käivitub pärast funktsiooni RPC väljakutsumist.
add_action('blockstudio/rpc/after_call', function($params) {
// $params: block, function, params, result
});