PHP kabliukai
Toliau pateikiamas visų galimų PHP kabliukų, kuriais galima išplėsti arba pakeisti papildinio funkcijas, sąrašas.
Kelias
Šis filtras leidžia keisti bloko aplanko kelią. Pagal numatytuosius nustatymus tai yra blockstudio dabartinėje aktyvioje temoje. Taip pat galite sukurti naują egzempliorių keliems šaltinio katalogams.
add_filter('blockstudio/path', function() {
$path = get_stylesheet_directory() . '/blocks';
return $path;
});
Inicijavimas
Globalus
Šis veiksmas suveikia papildiniui užregistravus visus blokus.
add_action('blockstudio/init', function($blocks) {
// All blocks have been registered
});
Egzempliorius
Šis veiksmas suveikia papildiniui užregistravus visus konkretaus egzemplioriaus blokus.
$instance segmentas yra egzemplioriaus kelias, santykinis su wp-content.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/$instance", function() {
// All blocks of this instance have been registered
});
global/before
Šis veiksmas suveikia prieš papildiniui užregistruojant visus blokus.
add_action('blockstudio/init/before', function() {
// Before blocks are registered
});
global/before/$instance
Šis veiksmas suveikia prieš papildiniui užregistruojant konkretaus egzemplioriaus blokus.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/before/$instance", function() {
// Before blocks of this instance are registered
});
Blokai
Atvaizdavimas
Šis filtras leidžia keisti bloko išvestį prieš jį atvaizduojant.
add_filter('blockstudio/blocks/render', function($content, $block, $attributes) {
// Modify the block content
return $content;
}, 10, 3);
Metaduomenys
Šis filtras leidžia keisti block.json failo duomenis prieš jį registruojant.
add_filter('blockstudio/blocks/meta', function($meta, $block) {
if (str_starts_with($block['name'], 'marketing')) {
$meta['icon'] = 'megaphone';
}
return $meta;
}, 10, 2);
Aukščiau pateiktas kodas pakeistų visų blokų, kurių pavadinimas prasideda marketing, piktogramą.
Sąlygos
Šis filtras leidžia pridėti pasirinktines sąlygas, kurias galima naudoti blokuose. Kiekvienas sąlygos tipas susiejamas su reikšme, kurią rengyklė palygina su sąlygos value. Žr. Pasirinktinės sąlygos.
add_filter('blockstudio/blocks/conditions', function($conditions) {
$conditions['myCustomCondition'] = 'expected';
return $conditions;
});
Atributai
Šis filtras keičia vieno lauko apibrėžtį prieš registruojant bloką. Filtruota apibrėžtis lemia redaktoriaus valdiklį ir reikšmės tikrinimą atvaizdavimo metu. Daugiau informacijos rasite skiltyje Filtravimas.
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
// Modify this field definition before registration.
return $attribute;
}, 10, 2);
attributes/render
Šis filtras pakeičia vieno lauko reikšmę prieš perduodant ją bloko šablonui. Jis vykdomas vieną kartą kiekvienam laukui ir gauna tris argumentus: $value (išspręsta reikšmė), $key (lauko raktas, naudojamas $a) ir $block (bloko duomenų masyvas, kurį šablonai gauna kaip $block arba $b). Užregistruokite jį nurodydami tris priimamus argumentus. Daugiau informacijos rasite skiltyje Filtravimas.
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 laukas grąžina kiekvieną vaizdą su sizes masyvu, kuriame pateikti URL, full matmenys ir kiekvieno registruoto vaizdo dydžio plotis bei aukštis, pavyzdžiui, $image['sizes']['thumbnail'] ir $image['sizes']['thumbnail-width']. Kiekvienam dydžiui kiekvienam vaizdui iškviečiama po vieną wp_get_attachment_image_src(), todėl jo filtrai vis dar taikomi. Šablonai, kuriuose niekada neskaitomas sizes, gali sąrašą pašalinti arba sutrumpinti.
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 yra dydžių pavadinimų sąrašas, pirmiausia full (tuščias, jei neužregistruoti tarpiniai dydžiai). $id yra priedo ID, o $size – dydis, kurio prašoma reikšmės url. Filtras pakeičia kiekvienos failo reikšmės užklausoje sizes masyvą. Be šio filtro masyvas lieka nepakeistas.
Grąžinkite dydžių pavadinimus kaip eilutes. Netinkami įrašai ignoruojami, pasikartojantys pavadinimai apdorojami vieną kartą, o jei grąžinama ne masyvo reikšmė, dydžiai praleidžiami. Prašomas url ir kitos priedo savybės nepakeičiamos. Šis kabliukas nevykdomas, kai laukas yra failų tipo ir turi returnFormat: "url", nes tokiu atveju dydžių atvaizdis nesudaromas.
attributes/validate
Koreguokite išvadas, gautas per aiškius bs_validate_block() iškvietimus, pavyzdžiui, kai tinkinta atvaizdavimo filtro funkcija išsprendžia išsaugotas nuorodas. Tai neįjungia automatinio tikrinimo išsaugant ar atvaizduojant.
add_filter('blockstudio/blocks/attributes/validate', function($findings, $name, $attrs) {
return $findings;
}, 10, 3);
Grąžinkite išvadų sąrašą. Filtras nekviečiamas, kai bloke nėra Blockstudio laukų ar atitinkančių plėtinių (null).
attributes/schema
Koreguokite JSON schemą, kurią grąžina bs_block_schema() , pavyzdžiui, kai pasirinktinis atvaizdavimo filtras išsprendžia išsaugotas nuorodas.
add_filter('blockstudio/blocks/attributes/schema', function($schema, $name) {
return $schema;
}, 10, 2);
Grąžinkite schemos masyvą. Filtras nekviečiamas, jei blokas neturi laukų Blockstudio ar atitinkančių plėtinių (null).
attributes/populate
Šis filtras leidžia pridėti pasirinktinių duomenų į checkbox, select arba radio lauko parinktis. Daugiau informacijos rasite skiltyje Parinkčių užpildymas.
Filtras gauna vieną argumentą – visų pasirinktinių duomenų rinkinių masyvą, kurio raktai yra "populate": {"type": "custom", "custom": "myCustomOptions"} naudojami pavadinimai.
add_filter('blockstudio/blocks/attributes/populate', function($options) {
$options['myCustomOptions'] = [
['value' => '1', 'label' => 'Option 1'],
['value' => '2', 'label' => 'Option 2'],
];
return $options;
});
components/use_block_props/render
Šis filtras leidžia keisti useBlockProps turinio išvestį.
Visi komponentų filtrai (use_block_props, inner_blocks ir rich_text) gauna bloką kaip paskutinį argumentą. $block yra WP_Block_Type, užregistruotas atvaizduojamam blokui, todėl $block->name yra bloko pavadinimas, pavyzdžiui, acme/hero.
$props yra HTML atributų eilutė, o ne masyvas. Svetainės pusėje tai yra get_block_wrapper_attributes() rezultatas, pavyzdžiui, class="wp-block-acme-hero my-class". Redaktoriuje tai yra elemento atributas class. Grąžinkite eilutę. Redaktoriuje pritaikomas tik grąžintos eilutės atributas 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
Šis filtras leidžia keisti <InnerBlocks /> turinio išvestį.
add_filter('blockstudio/blocks/components/inner_blocks/render', function($content, $block) {
return '<div class="inner-wrapper">' . $content . '</div>';
}, 10, 2);
components/inner_blocks/frontend/wrap
Šis filtras leidžia pašalinti <InnerBlocks /> apvalkalą iš išorinės sąsajos.
add_filter('blockstudio/blocks/components/inner_blocks/frontend/wrap', function($wrap, $block) {
return false; // Remove wrapper
}, 10, 2);
components/rich_text/render
Šis filtras leidžia koreguoti <RichText /> turinio išvestį. Jis gauna atributo reikšmę ir bloką.
add_filter('blockstudio/blocks/components/rich_text/render', function($content, $block) {
return wp_kses_post($content);
}, 10, 2);
Blokų žymos
blockstudio/block_tags/builders
Šis filtras registruoja blokų masyvų kūrimo funkcijas, naudojamas blokų žymų ir pasirinktinių blokų, pasirinktų per blockstudio/parser/element_mapping. Kiekviena kūrimo funkcija gauna išanalizuotus atributus ir neapdorotą vidinį turinį.
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);
Suderinami filtrai blockstudio/block_tags/renderers ir blockstudio/parser/renderers vykdomi po šio kablio ir gali pakeisti tą patį bloko pavadinimą.
blockstudio/block_tags/tag_aliases
Šis filtras leidžia registruoti pasirinktines brūkšneliu atskirtas kūrimo žymas, kurios prieš grįžtant prie neapdoroto HTML nustato tikruosius blokų pavadinimus. Tai naudinga, kai tema nori glaustos, konkrečiam projektui pritaikytos žymų sintaksės ir kartu pateikia standartinius Blockstudio arba pagrindinius blokus.
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
Šis filtras leidžia susieti prefiksų trumpinius su viena ar keliomis blokų vardų sritimis. Kiekvienas raktas yra mažosiomis raidėmis užrašytas prefiksas be brūkšnelių. Kiekviena reikšmė gali būti vardų srities eilutė arba išdėstytas vardų sričių sąrašas.
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> nustatoma kaip theme-components/card. <theme-button> pirmiausia bando theme-components/button, o tada grįžta prie bsui/button. Aiškiai nurodyti blockstudio/block_tags/tag_aliases įrašai turi pirmenybę tai pačiai žymai, o prefiksų žymos, kurių nepavyksta nustatyti, paliekamos nepakeistos.
Prefiksai gali būti jungiami: jei prefiksuotos žymos nepavyksta nustatyti tiesiogiai, o jos tekstas pats yra registruota prefikso žyma, nustatymas vykdomas rekursyviai. Naudojant theme => ['theme-components'] ir ui => ['bsui'], <theme-ui-input> pereina prie prefikso ui ir nustatoma kaip bsui/input. Registruotos prefiksų ir slapyvardžių žymos atvaizduojamos ir blokų šablonų išvestyje, ne tik puslapio turinyje.
Nustatymai
kelias
Šis filtras leidžia koreguoti failo blockstudio.json kelią. Pagal numatytuosius nustatymus jis yra blockstudio.json šiuo metu aktyvioje temoje.
add_filter('blockstudio/settings/path', function() {
return get_stylesheet_directory() . '/config/blockstudio.json';
});
users/ids
Šis filtras leidžia įjungti redaktorių konkretiems naudotojų ID.
add_filter('blockstudio/settings/users/ids', function() {
return [1];
});
users/roles
Šis filtras leidžia įjungti redaktorių konkretiems naudotojų vaidmenims.
add_filter('blockstudio/settings/users/roles', function() {
return ['administrator', 'editor'];
});
assets/enqueue
Šis filtras leidžia įjungti arba išjungti išteklių įtraukimą į frontendą ir redaktorių.
add_filter('blockstudio/settings/assets/enqueue', function() {
return false;
});
assets/reset/enabled
Šis filtras leidžia įjungti arba išjungti pagrindinių blokų stilių WordPress ir redaktoriaus pagalbinio maketo nustatymo iš naujo pašalinimą.
add_filter('blockstudio/settings/assets/reset/enabled', function() {
return true;
});
assets/reset/full_width
Šis filtras leidžia nustatyti, kuriuose įrašų tipuose naudojamas viso pločio redagavimas.
add_filter('blockstudio/settings/assets/reset/full_width', function() {
return ['page'];
});
assets/minify/css
Šis filtras leidžia įjungti arba išjungti CSS minifikavimą.
add_filter('blockstudio/settings/assets/minify/css', function() {
return true;
});
assets/minify/js
Šis filtras leidžia įjungti arba išjungti JS minifikavimą.
add_filter('blockstudio/settings/assets/minify/js', function() {
return true;
});
assets/process/scss
Šis filtras leidžia įjungti arba išjungti SCSS apdorojimą .css failuose.
add_filter('blockstudio/settings/assets/process/scss', function() {
return true;
});
assets/process/scss_files
Šis filtras leidžia įjungti arba išjungti .scss failų apdorojimą į CSS.
add_filter('blockstudio/settings/assets/process/scss_files', function() {
return true;
});
assets/output
Šis filtras leidžia nustatyti, kur įrašomi sukompiliuoti blokų ištekliai.
add_filter('blockstudio/settings/assets/output', function() {
return 'cache';
});
assets/inline_limit
Filtruoja, kiek išorinio bloko CSS baitų įterpiama į kiekvieną puslapį.
add_filter('blockstudio/settings/assets/inline_limit', function() {
return 40000;
});
cache/enabled
Šis filtras leidžia įjungti arba išjungti visas failais pagrįstas Blockstudio vykdymo aplinkos ir redaktoriaus išteklių talpyklas.
add_filter('blockstudio/settings/cache/enabled', function() {
return false;
});
cache/path
Šis filtras leidžia pakeisti Blockstudio failais pagrįstos talpyklos katalogą.
add_filter('blockstudio/settings/cache/path', function() {
return 'cache/blockstudio';
});
cache/namespace_grace
Šis filtras leidžia pakeisti, kiek laiko išlaikoma pašalinta talpyklos vardų sritis, kol ji išvaloma.
add_filter('blockstudio/settings/cache/namespace_grace', function() {
return 777600;
});
githooks/commit
Šis filtras nurodo, ar įjungtas Blockstudio valdomas PHPStan įvykdymo kablys.
add_filter('blockstudio/settings/githooks/commit', function() {
return true;
});
content/enabled
Šis filtras leidžia įjungti arba išjungti turinio sinchronizavimą.
add_filter('blockstudio/settings/content/enabled', function() {
return true;
});
content/id
Šis filtras leidžia nustatyti turinio sinchronizavimo nuosavybės vardų sritį.
add_filter('blockstudio/settings/content/id', function() {
return 'docs';
});
content/path
Šis filtras leidžia nustatyti turinio sinchronizavimo failų katalogą.
add_filter('blockstudio/settings/content/path', function() {
return 'content';
});
content/include_page_sync_managed
Šis filtras leidžia įtraukti arba neįtraukti puslapių sinchronizavimo valdomų įrašų.
add_filter('blockstudio/settings/content/include_page_sync_managed', function() {
return false;
});
content/authors
Šis filtras leidžia konfigūruoti turinio sinchronizavimo autorių tvarkymą.
add_filter('blockstudio/settings/content/authors', function() {
return 'ignore';
});
content/post_types
Šis filtras leidžia konfigūruoti turinio sinchronizavimo leidžiamų įrašų tipų sąrašus.
add_filter('blockstudio/settings/content/post_types', function() {
return ['team_member'];
});
content/taxonomies
Šis filtras leidžia konfigūruoti turinio sinchronizavimo leidžiamų taksonomijų sąrašus.
add_filter('blockstudio/settings/content/taxonomies', function() {
return ['category', 'post_tag'];
});
content/media
Šis filtras leidžia konfigūruoti turinio sinchronizavimo medijos tvarkymą.
add_filter('blockstudio/settings/content/media', function() {
return 'manifest';
});
tailwind/enabled
Šis filtras leidžia įjungti arba išjungti Tailwind.
add_filter('blockstudio/settings/tailwind/enabled', function() {
return true;
});
tailwind/config
Šis filtras leidžia pridėti pasirinktinę Tailwind CSS konfigūraciją.
add_filter('blockstudio/settings/tailwind/config', function() {
return '@theme { --color-primary: pink; }';
});
tailwind/output
Šis filtras leidžia pasirinkti įterptinę arba susietą Tailwind CSS išvestį.
add_filter('blockstudio/settings/tailwind/output', function() {
return 'link';
});
ui/enabled
Šis filtras leidžia įjungti arba išjungti rinkinyje pateiktus UI komponentus.
add_filter('blockstudio/settings/ui/enabled', function() {
return true;
});
editor/format_on_save
Šis filtras leidžia įjungti arba išjungti kodo formatavimą išsaugant.
add_filter('blockstudio/settings/editor/format_on_save', function() {
return true;
});
editor/assets
Šis filtras leidžia įtraukti papildomų išteklių į redaktorių.
add_filter('blockstudio/settings/editor/assets', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
editor/markup
Šis filtras leidžia pridėti papildomą žymėjimą redaktoriaus pabaigoje.
add_filter('blockstudio/settings/editor/markup', function() {
return '<style>body { background: black; }</style>';
});
block_editor/disable_loading
Šis filtras leidžia išjungti blokų įkėlimą į blokų redaktorių.
add_filter('blockstudio/settings/block_editor/disable_loading', function() {
return true;
});
block_editor/enhance
Šis filtras leidžia įjungti Blockstudio redaktoriaus patogumo funkcijas, pavyzdžiui, aiškesnius fokusavimo stilius ir užvedimo arba pažymėjimo kontūrus.
add_filter('blockstudio/settings/block_editor/enhance', function() {
return true;
});
block_editor/css_classes
Šis filtras leidžia pridėti stilių lenteles, kurių klases galima pasirinkti klasės lauke.
add_filter('blockstudio/settings/block_editor/css_classes', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/css_variables
Šis filtras leidžia pridėti stilių lenteles, kurių CSS kintamuosius galima automatiškai užbaigti kodo lauke.
add_filter('blockstudio/settings/block_editor/css_variables', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/blocks/allow
Šis filtras leidžia nustatyti, kuriuos blokų pavadinimus galima naudoti įterpimo lange.
add_filter('blockstudio/settings/block_editor/blocks/allow', function() {
return ['core/*', 'acf/*', 'my-theme/*'];
});
block_editor/blocks/deny
Šis filtras leidžia pašalinti blokų pavadinimus iš įterpimo lango.
add_filter('blockstudio/settings/block_editor/blocks/deny', function() {
return ['core/embed', 'core/freeform'];
});
block_editor/blocks/directory
Šis filtras leidžia įjungti arba išjungti WordPress blokų katalogo išteklius redaktoriuje.
add_filter('blockstudio/settings/block_editor/blocks/directory', function() {
return false;
});
block_editor/blocks/categories/allow
Šis filtras leidžia nustatyti, kurie blokų kategorijų tekstai lieka pasiekiami.
add_filter('blockstudio/settings/block_editor/blocks/categories/allow', function() {
return ['text', 'media', 'design'];
});
block_editor/blocks/categories/deny
Šis filtras leidžia pašalinti blokų kategorijų tekstus iš įterpimo lango.
add_filter('blockstudio/settings/block_editor/blocks/categories/deny', function() {
return ['embed'];
});
block_editor/blocks/categories/rename
Šis filtras leidžia pervadinti blokų kategorijų etiketes pagal tekstą.
add_filter('blockstudio/settings/block_editor/blocks/categories/rename', function() {
return [
'text' => 'Writing',
'design' => 'Layout'
];
});
block_editor/blocks/categories/order
Šis filtras leidžia nustatyti blokų kategorijų tekstų tvarką įterpimo lange.
add_filter('blockstudio/settings/block_editor/blocks/categories/order', function() {
return ['my-theme', 'text', 'media'];
});
block_editor/blocks/styles/deny
Šis filtras leidžia išregistruoti PHP registruotus blokų stilius pagal bloko pavadinimą.
add_filter('blockstudio/settings/block_editor/blocks/styles/deny', function() {
return [
'my-theme/card' => ['outline'],
'my-theme/media' => ['framed']
];
});
block_editor/blocks/legacy_widgets/hide
Šis filtras leidžia paslėpti papildomus senus valdiklius senųjų valdiklių bloke.
add_filter('blockstudio/settings/block_editor/blocks/legacy_widgets/hide', function() {
return ['archives', 'calendar'];
});
block_editor/patterns/core
Šis filtras leidžia įjungti arba išjungti WordPress pagrindinius blokų šablonus.
add_filter('blockstudio/settings/block_editor/patterns/core', function() {
return false;
});
block_editor/patterns/remote
Šis filtras leidžia įjungti arba išjungti nuotolinius šablonus iš WordPress šablonų katalogo.
add_filter('blockstudio/settings/block_editor/patterns/remote', function() {
return false;
});
block_editor/patterns/theme
Šis filtras leidžia įjungti arba išjungti temos pateiktus blokų šablonus.
add_filter('blockstudio/settings/block_editor/patterns/theme', function() {
return false;
});
block_editor/patterns/blockstudio
Šis filtras leidžia įjungti arba išjungti Blockstudio failais pagrįstus šablonus.
add_filter('blockstudio/settings/block_editor/patterns/blockstudio', function() {
return false;
});
block_editor/patterns/categories/allow
Šis filtras leidžia nustatyti, kurie šablonų kategorijų tekstai lieka pasiekiami.
add_filter('blockstudio/settings/block_editor/patterns/categories/allow', function() {
return ['featured', 'buttons', 'columns'];
});
block_editor/patterns/categories/deny
Šis filtras leidžia pašalinti šablonų kategorijų tekstus iš šablonų įterpimo lango.
add_filter('blockstudio/settings/block_editor/patterns/categories/deny', function() {
return ['gallery'];
});
block_editor/patterns/categories/rename
Šis filtras leidžia pervadinti šablonų kategorijų etiketes pagal tekstą.
add_filter('blockstudio/settings/block_editor/patterns/categories/rename', function() {
return [
'featured' => 'Featured Layouts'
];
});
block_editor/patterns/categories/order
Šis filtras leidžia nustatyti šablonų kategorijų tekstų tvarką įterpimo lange.
add_filter('blockstudio/settings/block_editor/patterns/categories/order', function() {
return ['featured', 'buttons'];
});
block_editor/media/openverse
Šis filtras leidžia įjungti arba išjungti Openverse medijos kategoriją blokų redaktoriaus medijos įterpimo lange.
add_filter('blockstudio/settings/block_editor/media/openverse', function() {
return false;
});
block_editor/media/image_sizes/allow
Šis filtras leidžia nustatyti, kurie vaizdų dydžių pavadinimai lieka pasiekiami redaktoriaus medijos valdikliuose.
add_filter('blockstudio/settings/block_editor/media/image_sizes/allow', function() {
return ['thumbnail', 'large'];
});
block_editor/media/image_sizes/deny
Šis filtras leidžia pašalinti vaizdų dydžių pavadinimus iš redaktoriaus medijos valdiklių.
add_filter('blockstudio/settings/block_editor/media/image_sizes/deny', function() {
return ['medium_large'];
});
ai/enable_context_generation
Šis filtras leidžia įjungti arba išjungti konteksto failo generavimą, skirtą LLM įrankių integracijai. Įjungus konteksto failas surenka naujausius blokų duomenis, dabartinio diegimo Blockstudio nustatymus, visas susijusias schemas ir Blockstudio dokumentaciją į vieną šaltinį, skirtą naudoti su dirbtinio intelekto kūrimo įrankiais.
add_filter('blockstudio/settings/ai/enable_context_generation', function() {
return true;
});
block_tags/enabled
Šis filtras leidžia įjungti arba išjungti blokų žymų atvaizdavimą puslapio lygmeniu.
add_filter('blockstudio/settings/block_tags/enabled', function() {
return true;
});
block_tags/prefixes
Šis filtras leidžia registruoti prefiksų ir vardų sričių trumpinius blokų žymoms.
add_filter('blockstudio/settings/block_tags/prefixes', function() {
return [
'theme' => ['theme-components', 'bsui']
];
});
dev/grab/enabled
Šis filtras leidžia įjungti arba išjungti elementų parinkiklį.
add_filter('blockstudio/settings/dev/grab/enabled', function() {
return false;
});
dev/perf
Šis filtras leidžia įjungti arba išjungti našumo profiliavimo įrankį.
add_filter('blockstudio/settings/dev/perf', function() {
return false;
});
dev/canvas/enabled
Šis filtras leidžia įjungti arba išjungti drobę.
add_filter('blockstudio/settings/dev/canvas/enabled', function() {
return false;
});
dev/canvas/admin_bar
Šis filtras leidžia rodyti arba slėpti WordPress administratoriaus juostą drobėje.
add_filter('blockstudio/settings/dev/canvas/admin_bar', function() {
return true;
});
WPML
blockstudio/wpml/config/label
Filtruoja kiekvieno rakto, kurį įrašo wp bs wpml config, žymą. Konteksto masyvo aprašą rasite skiltyje Keiskite žymas.
add_filter('blockstudio/wpml/config/label', function($label, $context) {
return str_replace(' (optional)', '', $label);
}, 10, 2);
Drobė
blockstudio/canvas/inventory
Šis filtras koreguoja pasirinkimo drobės pateikiamą inventorių. Atgalinio iškvietimo funkcija gauna inventoriaus DTO, pradinį pasirinkimą ir jai perduotas parinktis.
add_filter('blockstudio/canvas/inventory', function(array $result, array $selection, array $options) {
return $result;
}, 10, 3);
blockstudio/canvas/documents
Šis filtras koreguoja drobės grąžinamus atvaizduotus dokumentus; jam perduodami tie patys trys argumentai kaip ir inventoriaus filtrui.
blockstudio/canvas/item_loaded
Šis veiksmas suveikia įkeliant kiekvieną inventoriaus įrašą ir gauna inventoriaus tipą, kanoninį įrašo ID bei normalizuotą įrašą.
blockstudio/canvas/source_compiled
Šis veiksmas suveikia drobei sukompiliavus šaltinio failą; jam perduodamas pasirinktas šaltinio kelias ir kanoninis šaltinio įrašas.
Rinkinyje pateikti UI
blockstudio/ui/directories
Šis filtras koreguoja katalogus, kuriuose ieškoma rinkinyje pateiktų UI komponentų.
blockstudio/ui/inventory
Šis filtras koreguoja viešą UI šeimų inventorių.
blockstudio/ui/examples
Šis filtras koreguoja UI pavyzdžių įrašus; jam perduodami pavyzdžiai ir viešas UI inventorius, iš kurio jie gauti.
Topologija
blockstudio/blocks/topology_refreshed
Šis veiksmas suveikia atkūrus blokų topologiją.
blockstudio/pages/topology_refreshed
Šis veiksmas suveikia atkūrus puslapių topologiją.
blockstudio/pages/layout_error
Šis veiksmas suveikia, kai nepavyksta atvaizduoti puslapio maketo, užuot tyliai nutraukus darbą.
Vykdymo aplinka
blockstudio/runtime/initialized
Šis veiksmas suveikia, kai vykdymo aplinka nustato savo konfigūraciją.
blockstudio/runtime/changed
Šis veiksmas suveikia pasikeitus nustatytai vykdymo aplinkos tapatybei, dėl kurios perkeliamos talpyklos vardų sritys ir statinio išankstinio atvaizdavimo būsena.
blockstudio/performance/default_config
Šis filtras koreguoja numatytąsias našumo reikšmes prieš jas papildant projekto blockstudio.json reikšmėmis.
Turinys
blockstudio/content/orphan_action
Šis filtras nustato, ką turinio sinchronizavimas daro su įrašu, kuris nebeturi šaltinio.
Bootstrap
blockstudio/url
Šis filtras pakeičia viešą URL, naudojamą Blockstudio redaktoriaus ir administravimo ištekliams. Composer integracijos turi jį užregistruoti prieš įkeliant Blockstudio automatinio įkėlimo failą. Antrasis argumentas yra fizinis paketo katalogas.
add_filter(
'blockstudio/url',
function(string $url, string $directory) {
return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
},
10,
2
);
Vykdymo aplinkos talpykla
blockstudio/cache/dir
Šis filtras gauna nustatytą pagrindinį talpyklos katalogą prieš pridedant vykdymo aplinkos, redaktoriaus išteklių ar kitos talpyklos aprėpties katalogą.
add_filter('blockstudio/cache/dir', function(string $directory) {
return WP_CONTENT_DIR . '/cache/blockstudio';
});
blockstudio/cache/context
Šis filtras įtraukia į talpyklos identifikatorius serijiniu būdu išsaugomą vykdymo aplinkos variantą. Naudokite jį, kai tas pats aptikimo šaltinis gali pasirinkti skirtingus loginius inventorius.
add_filter('blockstudio/cache/context', function($context, string $scope) {
return [
'preview' => get_query_var('preview_id'),
'site' => get_current_blog_id(),
];
}, 10, 2);
blockstudio/cache/site_key
Šis filtras pakeičia tinklo arba tinklaraščio katalogo tapatybę pagrindiniams kompiuteriams, turintiems savo nuomininko ribą. Grąžinama reikšmė prieš naudojimą išvaloma.
add_filter(
'blockstudio/cache/site_key',
function(string $key, int $networkId, int $blogId) {
return sprintf('tenant-%d-%d', $networkId, $blogId);
},
10,
3
);
blockstudio/runtime/identity
Šis filtras prideda pagrindinio kompiuterio faktus, darančius įtaką kiekvienam objektui vykdymo aplinkos aprėptyje. Konkretaus elemento šaltinio kontrolines žymas vietoj to turėtų kaip aiškias priklausomybes perduoti už tai atsakinga 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
Filtruoja sekundžių skaičių, kurį galima pakartotinai naudoti patvirtintą failų stebėjimo momentinę kopiją neatliekant naujos failų sistemos būsenos patikros. Numatytoji reikšmė yra 0 vietinėje ir kūrimo aplinkoje ir 20 kitur.
add_filter('blockstudio/cache/watch_debounce', function() {
return 30;
});
blockstudio/cache/build_wait_budget
Filtruoja, kiek milisekundžių užklausa laukia, kol lygiagrečiai veikiantis kūrimo procesas paskelbs vykdymo aplinkos talpyklą arba užpildytų pasirinkimų atnaujinimą, ir tik tada pereina prie prastesnio varianto. Numatytoji reikšmė yra 5000 struktūriniams atkūrimams ir 4000 pasirinkimų atnaujinimams.
add_filter('blockstudio/cache/build_wait_budget', function() {
return 2000;
});
blockstudio/cache/populate_debounce
Filtruoja, kiek sekundžių turinio, terminų, naudotojų arba meta duomenų įrašų pliūpsnis sujungiamas į vieną užpildytų pasirinkimų atnaujinimą. Po ramaus laikotarpio pirmasis įrašas atnaujina iškart; paskutinio pliūpsnio įrašo pakeitimai atsispindi pasibaigus šiam laikotarpiui. Numatytoji reikšmė yra 30. Grąžinkite 0, kad būtų atnaujinama po kiekvieno įrašo.
add_filter('blockstudio/cache/populate_debounce', function() {
return 120;
});
blockstudio/cache/populate_ignored_meta_keys
Filtruoja meta raktus, kurių įrašymas niekada neatnaujina užpildytų pasirinkimų. Pagal numatytuosius nustatymus tai yra raktai, kuriuos WordPress įrašo kaip redagavimo ir prisijungimo apskaitos duomenis: _edit_lock, kuriuos atnaujina redaktorius ir Heartbeat, kol įrašas atidarytas, _edit_last, kurie įrašomi kartu su įrašo išsaugojimu, kuris ir taip atnaujina duomenis, ir session_tokens, kurie įrašomi prisijungiant ir atsijungiant. Pridėkite raktus, kurie dažnai keičiasi, bet niekada nedaro įtakos užpildymo užklausai.
add_filter('blockstudio/cache/populate_ignored_meta_keys', function(array $keys) {
$keys[] = '_my_view_counter';
return $keys;
});
blockstudio/cache/max_files_per_scope
Filtruoja, kiek paskelbtų duomenų rinkinių saugoma kiekvienoje vykdymo aplinkos talpyklos aprėptyje.
add_filter('blockstudio/cache/max_files_per_scope', function($maximum, $scope) {
return $scope === 'runtime' ? 50 : $maximum;
}, 10, 2);
blockstudio/cache/compress
Filtruoja, ar talpyklos duomenų rinkinyje naudojami suspausti serializuoti duomenys, o ne paprastas PHP masyvas. Pagal numatytuosius nustatymus paprastas formatas naudojamas tik iki 1 MiB dydžio duomenų rinkiniams ir tik tada, kai paskirties vietą gali talpinti aktyvioji OPcache bendroji atmintis. Kiti procesai, neįtraukti failai ir didesni duomenų rinkiniai suspaudžiami.
add_filter('blockstudio/cache/compress', function($compress, $scope) {
return $scope === 'runtime' ? false : $compress;
}, 10, 2);
Grąžinus false, taip pat nepaisoma dydžio apribojimo. Tai gali padėti, kai WP-CLI be opcache.enable_cli įkelia failus OPcache naudojantiems žiniatinklio procesams, tačiau kiekvienas skaitytojas be OPcache išnagrinės sugeneruotą masyvą. Dideliems bendro naudojimo duomenų rinkiniams palikite suspaudimą, nebent papildomos atminties sąnaudos yra priimtinos. Numatytąsias apsaugos priemones rasite skiltyje talpyklos duomenų rinkinių formatai.
blockstudio/cache/protected_paths
Talpyklos kelių išsaugojimo valymas niekada neturi jų pašalinti. Blockstudio įtraukia visus failus, į kuriuos nurodo įdiegtas ankstyvojo aptarnavimo žemėlapis.
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
Šis veiksmas pateikia bendrą talpyklos aprėptį ir rezultatą, pavyzdžiui, hit, build, miss-stale, stale-last-good arba 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
Šis filtras gauna galutinį anoniminio saugumo sprendimą ir serverio bei slapukų įvestis. Grąžinus true, visada praleidžiamas statinis aptarnavimas ir generavimas.
add_filter(
'blockstudio/static_prerender/request_bypass',
function(bool $bypass, array $server, array $cookies) {
return $bypass || isset($cookies['commerce_session']);
},
10,
3
);
blockstudio/static_prerender/public_urls
Šis filtras pateikia arba koreguoja visą viešą URL inventorių, kurį naudoja suplanuotas talpyklos užpildymo procesas ir aiškūs grafų įrankiai.
add_filter('blockstudio/static_prerender/public_urls', function(array $urls) {
$urls[] = home_url('/custom-route/');
return array_values(array_unique($urls));
});
Filtro grąžinama reikšmė nėra galutinis inventorius. Rezultatas tikrinamas, ar jį galima išsaugoti talpykloje: pašalinama viskas, kas atitinka sukonfigūruotą dinaminį kelią, ir viskas, kas pagal numatytuosius nustatymus praleidžiama: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, bet kuris kelias, kuriame yra /feed/, ir paieškos rezultatai, esantys po paieškos pagrindu pagrindiniame svetainės kelyje (pagal numatytuosius nustatymus /search/). Todėl jūsų pridėtas URL gali būti atmestas be įspėjimo. Jei inventoriuje nėra tikėtino maršruto, prieš manydami, kad filtras nesuveikė, patikrinkite, ar jis atitinka šias taisykles.
blockstudio/static_prerender/render_internal
Šis filtras įgyvendina pasirenkamą paketinį perdavimą tame pačiame procese. Grąžinkite normalizuotą rezultatų masyvą arba palikite reikšmę nepakeistą, kad atvaizduoklis naudotų sukonfigūruotą HTTP atsarginį variantą. Rezultate yra html ir pasirinktinai status, dependencies, virtualHashes bei headers; performance.staticPrerender.replayHeaders nurodytos antraštės išsaugomos kartu su dokumentu.
add_filter(
'blockstudio/static_prerender/render_internal',
function($result, string $url, array $options) {
return my_static_renderer()->render($url, $options);
},
10,
3
);
blockstudio/static_prerender/cacheable_html
Šis filtras priima galutinį sprendimą po to, kai Blockstudio patikrina, ar išvestis yra visas HTML dokumentas be talpyklos draudimo žymos ir ar stebėta atsakymo būsena rodo sėkmę. Trečiasis argumentas yra stebėta būsena arba null, jei būsena nebuvo nurodyta.
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
Šis veiksmas pateikia statinio išankstinio atvaizdavimo rezultatus, įskaitant atitikmenis, neatitikimus, įrašymus, grafų įrašymus, pasenusius įrašus ir klaidas.
add_action('blockstudio/static_prerender/outcome', function(string $reason) {
my_metrics()->increment("blockstudio.prerender.{$reason}");
});
blockstudio/tailwind/cache_max_files
Filtruoja maksimalų sukompiliuotų Tailwind CSS įrašų skaičių. Numatytoji reikšmė yra 1000.
add_filter('blockstudio/tailwind/cache_max_files', function() {
return 1500;
});
blockstudio/tailwind/cache_max_age
Filtruoja maksimalų sukompiliuotų Tailwind CSS įrašų amžių sekundėmis. Numatytoji reikšmė yra 30 dienų, o minimali – viena valanda.
add_filter('blockstudio/tailwind/cache_max_age', function() {
return 14 * DAY_IN_SECONDS;
});
Administravimas
įjungta
Šis filtras leidžia įjungti arba išjungti Blockstudio administravimo puslapį, esantį skiltyje Įrankiai > Blockstudio.
add_filter('blockstudio/admin/enabled', function() {
return false;
});
Ištekliai
editor/canvas/body_class
Kai išteklių nustatymas iš naujo įjungtas, šis filtras koreguoja išvalytas frontend turinio elementų klases, nukopijuojamas į blokų redaktoriaus drobę.
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
return array_values(array_diff($classes, ['logged-in']));
});
įjungti
Šis filtras leidžia išjungti konkretaus tipo išteklių apdorojimą ir įtraukimą.
add_filter('blockstudio/assets/enable', function($enable, $type, $block) {
if ($type === 'css' && $block['name'] === 'my/block') {
return false;
}
return $enable;
}, 10, 3);
išjungti
Šis filtras leidžia išjungti konkrečius išteklius pagal jų ID. Ištekliai, kurių ID yra grąžintame masyve, frontend puslapyje nebus atvaizduojami.
add_filter('blockstudio/assets/disable', function($disabled) {
$disabled[] = 'my-block-style';
return $disabled;
});
process/scss/import_paths
Šis filtras leidžia pridėti papildomų kelių prie @import sakinio, naudojamo SCSS kompiliatoriuje.
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
$paths[] = get_stylesheet_directory() . '/scss';
return $paths;
});
process/scss/prelude
Šis filtras leidžia prieš kiekvieno SCSS failo kompiliavimą įterpti bendrą Sass kodą.
add_filter('blockstudio/assets/process/scss/prelude', function($prelude, $path, $scss) {
return '@import "functions";' . "\n"
. '@import "variables";' . "\n"
. '@import "mixins";';
}, 10, 3);
process/css/content
Šis filtras leidžia koreguoti failo CSS turinį prieš jį kompiliuojant.
add_filter('blockstudio/assets/process/css/content', function($content, $block) {
return str_replace('old-class', 'new-class', $content);
}, 10, 2);
process/js/content
Šis filtras leidžia koreguoti failo JS turinį prieš jį kompiliuojant.
add_filter('blockstudio/assets/process/js/content', function($content, $block) {
return $content;
}, 10, 2);
Buferis
įjungta
Blockstudio buferizuoja frontend atsakymą, kad turinyje atvaizduotos blokų stiliaus ir scenarijų žymos galėtų būti perkeltos į antraštę ir poraštę, o Tailwind galėtų nuskaityti visą dokumentą. Buferizavimas reiškia viso dokumento laikymą ir nuskaitymą kiekvienos frontend užklausos metu; svetainė, kuri neatvaizduoja jokių Blockstudio bloko išteklių ir nenaudoja Tailwind, gali grąžinti false, kad praleistų abu veiksmus.
add_filter('blockstudio/buffer/enabled', '__return_false');
Administravimo sąsajoje ir Customizer peržiūroje buferizavimas taip pat išjungtas. Iškvieskite bs_is_buffering() iš wp_enqueue_scripts arba vėliau, kad sužinotumėte, ar dabartinis atsakas buferizuojamas. Prieš priimant sprendimą ties template_redirect, grąžinama false.
išvestis
Šis filtras gauna visą buferizuotą HTML dokumentą prieš jį išsiunčiant. Blockstudio išteklių perkėlimas vykdomas pagal prioritetą 1000000, o Tailwind kompiliavimas – pagal 999999, todėl vykdykite filtrą anksčiau, kad matytumėte dokumentą prieš šiuos veiksmus, arba vėliau, kad matytumėte galutinę išvestį.
add_filter('blockstudio/buffer/output', function(string $html) {
return $html;
}, 2000000);
Atvaizdavimas
priklausomybės
Šis filtras pateikia pasirinktą šabloną ir išteklių priklausomybes kaskart, kai Blockstudio atvaizduoja bloką. Jis naudingas statinio turinio eksportavimo ir kitiems priklausomybių rinkimo tame pačiame procese įrankiams.
add_filter(
'blockstudio/render/dependencies',
function($paths, $name, $block, $isEditor, $isPreview) {
my_dependency_graph()->add($name, $paths);
return $paths;
},
10,
5
);
Globalus
Šis filtras leidžia koreguoti puslapio išvestį prieš ją atvaizduojant.
add_filter('blockstudio/render', function($content) {
return $content;
});
antraštė
Šis filtras leidžia koreguoti žymos <head> išvestį prieš ją atvaizduojant. Jis vykdomas tik tada, kai Blockstudio buferizuoja atsaką. Daugiau informacijos rasite bs_is_buffering().
add_filter('blockstudio/render/head', function($content) {
return $content . '<meta name="custom" content="value">';
});
poraštė
Šis filtras leidžia koreguoti </body> išvestį prieš ją atvaizduojant.
add_filter('blockstudio/render/footer', function($content) {
return $content . '<script>console.log("loaded")</script>';
});
Klaidų tvarkymas
error/logged
Veiksmas suveikia užregistravus klaidą. Naudokite jį klaidoms siųsti į išorines registravimo tarnybas.
add_action('blockstudio/error/logged', function($message, $level, $context) {
if ($level === 'error') {
my_external_logger($message, $context);
}
}, 10, 3);
error/exception
Veiksmas suveikia apdorojus išimtį.
add_action('blockstudio/error/exception', function($exception, $context) {
my_error_tracker($exception);
}, 10, 2);
Duomenų bazė
Visi duomenų bazės kabliai gauna vieną $params masyvą.
db/before_create
Veiksmas suveikia prieš sukuriant įrašą.
add_action('blockstudio/db/before_create', function($params) {
// $params: block, schema, data, storage
});
db/after_create
Veiksmas suveikia sukūrus įrašą.
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
Veiksmas suveikia prieš atnaujinant įrašą.
add_action('blockstudio/db/before_update', function($params) {
// $params: block, schema, id, data, storage
});
db/after_update
Veiksmas suveikia atnaujinus įrašą.
add_action('blockstudio/db/after_update', function($params) {
// $params: block, schema, id, record, storage
});
db/before_delete
Veiksmas suveikia prieš ištrinant įrašą.
add_action('blockstudio/db/before_delete', function($params) {
// $params: block, schema, id, storage
});
db/after_delete
Veiksmas suveikia ištrynus įrašą.
add_action('blockstudio/db/after_delete', function($params) {
// $params: block, schema, id, storage
});
RPC
Visi RPC kabliai gauna vieną $params masyvą.
rpc/before_call
Veiksmas suveikia prieš iškviečiant funkciją RPC.
add_action('blockstudio/rpc/before_call', function($params) {
// $params: block, function, params
});
rpc/after_call
Veiksmas suveikia iškvietus funkciją RPC.
add_action('blockstudio/rpc/after_call', function($params) {
// $params: block, function, params, result
});