PHP-hookit
Alla on luettelo kaikista käytettävissä olevista PHP-hookeista, joilla voi laajentaa tai muokata lisäosan toimintoja.
Polku
Tällä suodattimella voit muuttaa lohkokansion polkua. Oletusarvoisesti se on blockstudio aktiivisessa teemassa. Voit vaihtoehtoisesti luoda uuden ilmentymän useita lähdehakemistoja varten.
add_filter('blockstudio/path', function() {
$path = get_stylesheet_directory() . '/blocks';
return $path;
});
Alustus
globaali
Tämä toiminto suoritetaan, kun lisäosa on rekisteröinyt kaikki lohkot.
add_action('blockstudio/init', function($blocks) {
// All blocks have been registered
});
ilmentymä
Tämä toiminto suoritetaan, kun lisäosa on rekisteröinyt tietyn ilmentymän kaikki lohkot.
$instance-osa on ilmentymän polku suhteessa kohteeseen wp-content.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/$instance", function() {
// All blocks of this instance have been registered
});
global/before
Tämä toiminto suoritetaan ennen kuin lisäosa on rekisteröinyt kaikki lohkot.
add_action('blockstudio/init/before', function() {
// Before blocks are registered
});
global/before/$instance
Tämä toiminto suoritetaan ennen kuin lisäosa on rekisteröinyt tietyn ilmentymän kaikki lohkot.
$instance = 'themes/my-theme/client-blocks';
add_action("blockstudio/init/before/$instance", function() {
// Before blocks of this instance are registered
});
Lohkot
renderöinti
Tällä suodattimella voit muokata lohkon tulostetta ennen sen renderöintiä.
add_filter('blockstudio/blocks/render', function($content, $block, $attributes) {
// Modify the block content
return $content;
}, 10, 3);
metatiedot
Tällä suodattimella voit muokata block.json-tiedoston tietoja ennen sen rekisteröintiä.
add_filter('blockstudio/blocks/meta', function($meta, $block) {
if (str_starts_with($block['name'], 'marketing')) {
$meta['icon'] = 'megaphone';
}
return $meta;
}, 10, 2);
Yllä oleva koodi muuttaisi kaikkien marketing-alkuisten lohkojen kuvaketta.
ehdot
Tällä suodattimella voit lisätä mukautettuja ehtoja, joita voi käyttää lohkoissa. Kukin ehtotyyppi vastaa arvoa, jota editori vertaa ehdon arvoon value. Katso Mukautetut ehdot.
add_filter('blockstudio/blocks/conditions', function($conditions) {
$conditions['myCustomCondition'] = 'expected';
return $conditions;
});
attribuutit
Tällä suodattimella muokataan yhtä kenttämäärittelyä ennen lohkon rekisteröintiä. Suodatettu määrittely ohjaa editorin ohjauskomponenttia ja renderöintiajan arvon validointia. Lisätietoja on kohdassa Suodattaminen.
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
// Modify this field definition before registration.
return $attribute;
}, 10, 2);
attributes/render
Tämä suodatin muuttaa yhden kentän arvoa ennen kuin se välitetään lohkomallille. Se suoritetaan kerran kenttää kohden ja saa kolme argumenttia: $value (ratkaistu arvo), $key (kentän avain sellaisena kuin sitä käytetään kohteessa $a) ja $block (lohkon tietotaulukko, jonka mallit saavat arvona $block tai $b). Rekisteröi suodatin kolmella hyväksytyllä argumentilla. Lisätietoja on kohdassa Suodattaminen.
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-kenttä palauttaa jokaisen kuvan mukana sizes-taulukon, joka sisältää arvon URL sekä kohteen full mitat ja kaikkien rekisteröityjen kuvakokojen mitat, esimerkiksi $image['sizes']['thumbnail'] ja $image['sizes']['thumbnail-width']. Kukin koko on yksi wp_get_attachment_image_src()-kutsu kuvaa kohden, joten sen suodattimet ovat yhä käytössä. Mallit, jotka eivät koskaan lue arvoa sizes, voivat poistaa luettelon tai lyhentää sitä.
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 kokojen nimien luettelo, jossa full on ensimmäisenä (tyhjä, jos välikokoja ei ole rekisteröity). $id on liitteen tunnus ja $size arvolle url pyydetty koko. Suodatin muuttaa jokaisen tiedostoarvon sizes-taulukkoa pyynnössä. Ilman sitä taulukko säilyy ennallaan.
Palauta kokojen nimet merkkijonoina. Virheelliset merkinnät ohitetaan, ja kaksoiskappaleina esiintyvät nimet käsitellään vain kerran. Jos palautusarvo ei ole taulukko, koot ohitetaan. Pyydetty url ja muut liitteen ominaisuudet pysyvät ennallaan. Tätä koukkua ei suoriteta files-kentälle, jonka arvona on returnFormat: "url", sillä silloin kokokarttaa ei muodosteta.
attributes/validate
Säädä nimenomaisista bs_validate_block()-kutsuista saatuja tuloksia esimerkiksi silloin, kun mukautettu renderöintisuodatin ratkaisee tallennettuja viittauksia.
Tämä ei ota käyttöön automaattista validointia tallennusten tai renderöintien yhteydessä.
add_filter('blockstudio/blocks/attributes/validate', function($findings, $name, $attrs) {
return $findings;
}, 10, 3);
Palauta luettelo havainnoista. Suodatinta ei kutsuta, jos lohkossa ei ole Blockstudio-kenttiä tai vastaavia laajennuksia (null).
attributes/schema
Muokkaa JSON-skeemaa, jonka palauttaa bs_block_schema(), esimerkiksi silloin, kun mukautettu renderöintisuodatin ratkaisee tallennetut viittaukset.
add_filter('blockstudio/blocks/attributes/schema', function($schema, $name) {
return $schema;
}, 10, 2);
Palauta skeemataulukko. Suodatinta ei kutsuta, jos lohkossa ei ole Blockstudio-kenttiä tai vastaavia laajennuksia (null).
attributes/populate
Tällä suodattimella voit lisätä mukautettuja tietoja checkbox-, select– tai radio-kentän asetuksiin. Lisätietoja on kohdassa Asetusten täyttäminen.
Suodatin saa yhden argumentin: taulukon, joka sisältää kaikki mukautetut aineistot ja jonka avaimina ovat kohteessa "populate": {"type": "custom", "custom": "myCustomOptions"} käytetyt nimet.
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
Tällä suodattimella voit muokata useBlockProps-sisällön tulostetta.
Kaikki komponenttisuodattimet (use_block_props, inner_blocks ja rich_text) saavat lohkon viimeisenä argumenttinaan. $block on lohkolle, jota renderöidään, rekisteröity WP_Block_Type, joten $block->name on lohkon nimi, esimerkiksi acme/hero.
$props on HTML-attribuuttien merkkijono, ei taulukko. Käyttöliittymän ulkopuolella se on tulos
funktiosta
get_block_wrapper_attributes(),
esimerkiksi class="wp-block-acme-hero my-class". Muokkaimessa se on elementin
class-attribuutti. Palauta merkkijono. Muokkaimessa palautetusta merkkijonosta käytetään vain
class-attribuuttia.
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
Tällä suodattimella voit muokata <InnerBlocks />-sisällön tulostetta.
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
Tällä suodattimella voit poistaa <InnerBlocks />-kääreen käyttöliittymästä.
add_filter('blockstudio/blocks/components/inner_blocks/frontend/wrap', function($wrap, $block) {
return false; // Remove wrapper
}, 10, 2);
components/rich_text/render
Tämän suodattimen avulla voit muokata <RichText />-sisällön tulostetta. Se saa attribuutin arvon ja lohkon.
add_filter('blockstudio/blocks/components/rich_text/render', function($content, $block) {
return wp_kses_post($content);
}, 10, 2);
Lohkotunnisteet
blockstudio/block_tags/builders
Tämä suodatin rekisteröi lohkomääritysten muodostajat, joita lohkotunnisteet ja blockstudio/parser/element_mapping-toiminnolla valitut mukautetut lohkot käyttävät. Kukin muodostaja saa jäsennetyt attribuutit ja raakasisällön.
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);
Yhteensopivat suodattimet blockstudio/block_tags/renderers ja blockstudio/parser/renderers suoritetaan tämän koukun jälkeen, ja ne voivat korvata saman lohkon nimen.
blockstudio/block_tags/tag_aliases
Tällä suodattimella voit rekisteröidä mukautettuja yhdysmerkillisiä luontitunnisteita, jotka muunnetaan oikeiksi lohkonimiksi ennen raakaa HTML-varakäsittelyä. Siitä on hyötyä, kun teema haluaa käyttää projektikohtaisia lyhyitä tunnisteita ja näyttää silti tavallisia Blockstudio- tai ydinkirjaston lohkoja.
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
Tällä suodattimella voit yhdistää etuliitelyhenteitä yhteen tai useampaan lohkon nimiavaruuteen. Kukin avain on pienaakkosista koostuva etuliite ilman yhdysmerkkejä. Kukin arvo voi olla nimiavaruusmerkkijono tai järjestetty nimiavaruuksien luettelo.
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> muunnetaan muotoon theme-components/card. <theme-button> kokeilee ensin theme-components/button ja käyttää sitten varana arvoa bsui/button. Saman tunnisteen kohdalla eksplisiittiset blockstudio/block_tags/tag_aliases-määritykset ovat ensisijaisia, ja ratkaisemattomat etuliitetunnisteet jätetään ennalleen.
Etuliitteitä voi yhdistellä: jos etuliitetunnistetta ei voida ratkaista suoraan ja sen tunnisteosa on itse rekisteröity etuliitetunniste, ratkaisu etenee rekursiivisesti. Kun käytössä ovat theme => ['theme-components'] ja ui => ['bsui'], <theme-ui-input> siirtyy ui-etuliitteen käsittelyyn ja ratkaistaan muotoon bsui/input. Rekisteröidyt etuliite- ja aliastunnisteet näytetään myös lohkomallin tulosteessa, eivät vain sivun sisällössä.
Asetukset
polku
Tällä suodattimella voit muuttaa tiedoston blockstudio.json polkua. Oletusarvoisesti tiedosto sijaitsee muodossa blockstudio.json aktiivisessa teemassa.
add_filter('blockstudio/settings/path', function() {
return get_stylesheet_directory() . '/config/blockstudio.json';
});
users/ids
Tällä suodattimella voit ottaa editorin käyttöön tietyille käyttäjätunnuksille.
add_filter('blockstudio/settings/users/ids', function() {
return [1];
});
users/roles
Tällä suodattimella voit ottaa editorin käyttöön tietyille käyttäjärooleille.
add_filter('blockstudio/settings/users/roles', function() {
return ['administrator', 'editor'];
});
assets/enqueue
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä aineistojen lataamisen käyttöliittymään ja editoriin.
add_filter('blockstudio/settings/assets/enqueue', function() {
return false;
});
assets/reset/enabled
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä ydinkirjaston lohkotyylien WordPress ja editorin apuasettelun nollauksen.
add_filter('blockstudio/settings/assets/reset/enabled', function() {
return true;
});
assets/reset/full_width
Tällä suodattimella voit määrittää, mitkä sisältötyypit käyttävät koko leveyden muokkausta.
add_filter('blockstudio/settings/assets/reset/full_width', function() {
return ['page'];
});
assets/minify/css
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä kohteen CSS pienentämisen.
add_filter('blockstudio/settings/assets/minify/css', function() {
return true;
});
assets/minify/js
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä kohteen JS pienentämisen.
add_filter('blockstudio/settings/assets/minify/js', function() {
return true;
});
assets/process/scss
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä kohteen SCSS käsittelyn .css-tiedostoissa.
add_filter('blockstudio/settings/assets/process/scss', function() {
return true;
});
assets/process/scss_files
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä .scss-tiedostojen käsittelyn muotoon CSS.
add_filter('blockstudio/settings/assets/process/scss_files', function() {
return true;
});
assets/output
Tällä suodattimella voit määrittää, minne käännetyt lohkoaineistot kirjoitetaan.
add_filter('blockstudio/settings/assets/output', function() {
return 'cache';
});
assets/inline_limit
Suodattaa, kuinka monta tavua ulkoisen lohkon CSS-sisällöstä sisällytetään suoraan kullekin sivulle.
add_filter('blockstudio/settings/assets/inline_limit', function() {
return 40000;
});
cache/enabled
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä kaikki tiedostopohjaiset Blockstudio-ajonaikaiset ja editorin aineistovälimuistit.
add_filter('blockstudio/settings/cache/enabled', function() {
return false;
});
cache/path
Tällä suodattimella voit muuttaa tiedostopohjaisen välimuistin Blockstudio hakemistoa.
add_filter('blockstudio/settings/cache/path', function() {
return 'cache/blockstudio';
});
cache/namespace_grace
Tällä suodattimella voit muuttaa, kuinka kauan käytöstä poistettua välimuistin nimiavaruutta säilytetään ennen sen keräämistä.
add_filter('blockstudio/settings/cache/namespace_grace', function() {
return 777600;
});
githooks/commit
Tämä suodatin ilmoittaa, onko kohteen Blockstudio omistama PHPStan-toimitusvaiheen koukku käytössä.
add_filter('blockstudio/settings/githooks/commit', function() {
return true;
});
content/enabled
Tällä suodattimella voit ottaa sisällön synkronoinnin käyttöön tai poistaa sen käytöstä.
add_filter('blockstudio/settings/content/enabled', function() {
return true;
});
content/id
Tällä suodattimella voit asettaa sisällön synkronoinnin omistajuuden nimiavaruuden.
add_filter('blockstudio/settings/content/id', function() {
return 'docs';
});
content/path
Tällä suodattimella voit asettaa sisällön synkronoinnin tiedostohakemiston.
add_filter('blockstudio/settings/content/path', function() {
return 'content';
});
content/include_page_sync_managed
Tällä suodattimella voit sisällyttää tai jättää pois sivujen synkronoinnin hallinnoimat julkaisut.
add_filter('blockstudio/settings/content/include_page_sync_managed', function() {
return false;
});
content/authors
Tällä suodattimella voit määrittää, miten sisällön synkronointi käsittelee kirjoittajia.
add_filter('blockstudio/settings/content/authors', function() {
return 'ignore';
});
content/post_types
Tällä suodattimella voit määrittää sisällön synkronoinnin sallittujen sisältötyyppien luettelot.
add_filter('blockstudio/settings/content/post_types', function() {
return ['team_member'];
});
content/taxonomies
Tällä suodattimella voit määrittää sisällön synkronoinnin sallittujen luokittelujen luettelot.
add_filter('blockstudio/settings/content/taxonomies', function() {
return ['category', 'post_tag'];
});
content/media
Tällä suodattimella voit määrittää sisällön synkronoinnin median käsittelyn.
add_filter('blockstudio/settings/content/media', function() {
return 'manifest';
});
tailwind/enabled
Tällä suodattimella voit ottaa kohteen Tailwind käyttöön tai poistaa sen käytöstä.
add_filter('blockstudio/settings/tailwind/enabled', function() {
return true;
});
tailwind/config
Tällä suodattimella voit lisätä mukautetun Tailwind CSS-määrityksen.
add_filter('blockstudio/settings/tailwind/config', function() {
return '@theme { --color-primary: pink; }';
});
tailwind/output
Tällä suodattimella voit valita, tuotetaanko Tailwind CSS upotettuna vai linkitettynä.
add_filter('blockstudio/settings/tailwind/output', function() {
return 'link';
});
ui/enabled
Tällä suodattimella voit ottaa niputetut UI-komponentit käyttöön tai poistaa ne käytöstä.
add_filter('blockstudio/settings/ui/enabled', function() {
return true;
});
editor/format_on_save
Tällä suodattimella voit ottaa koodin muotoilun käyttöön tai poistaa sen käytöstä tallennuksen yhteydessä.
add_filter('blockstudio/settings/editor/format_on_save', function() {
return true;
});
editor/assets
Tällä suodattimella voit ladata editoriin lisää aineistoja.
add_filter('blockstudio/settings/editor/assets', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
editor/markup
Tällä suodattimella voit lisätä editorin loppuun lisää merkintää.
add_filter('blockstudio/settings/editor/markup', function() {
return '<style>body { background: black; }</style>';
});
block_editor/disable_loading
Tällä suodattimella voit estää lohkojen lataamisen lohkoeditorissa.
add_filter('blockstudio/settings/block_editor/disable_loading', function() {
return true;
});
block_editor/enhance
Tällä suodattimella voit ottaa käyttöön Blockstudio-editorin käyttömukavuusominaisuuksia, kuten selkeämmät kohdistustyylit sekä korostukset osoittamisen ja valinnan aikana.
add_filter('blockstudio/settings/block_editor/enhance', function() {
return true;
});
block_editor/css_classes
Tällä suodattimella voit lisätä tyylitiedostoja, joiden luokat ovat valittavissa luokkakentässä.
add_filter('blockstudio/settings/block_editor/css_classes', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/css_variables
Tällä suodattimella voit lisätä tyylitiedostoja, joiden CSS-muuttujia voi täydentää koodikentässä.
add_filter('blockstudio/settings/block_editor/css_variables', function() {
return ['my-stylesheet', 'another-stylesheet'];
});
block_editor/blocks/allow
Tällä suodattimella voit määrittää, mitkä lohkonimet sallitaan lisäysvalikossa.
add_filter('blockstudio/settings/block_editor/blocks/allow', function() {
return ['core/*', 'acf/*', 'my-theme/*'];
});
block_editor/blocks/deny
Tällä suodattimella voit poistaa lohkonimiä lisäysvalikosta.
add_filter('blockstudio/settings/block_editor/blocks/deny', function() {
return ['core/embed', 'core/freeform'];
});
block_editor/blocks/directory
Tällä suodattimella voit ottaa WordPress-lohkojen hakemiston aineistot käyttöön tai poistaa ne käytöstä editorissa.
add_filter('blockstudio/settings/block_editor/blocks/directory', function() {
return false;
});
block_editor/blocks/categories/allow
Tällä suodattimella voit määrittää, mitkä lohkoluokkien tunnisteosat pysyvät käytettävissä.
add_filter('blockstudio/settings/block_editor/blocks/categories/allow', function() {
return ['text', 'media', 'design'];
});
block_editor/blocks/categories/deny
Tällä suodattimella voit poistaa lohkoluokkien tunnisteosia lisäysvalikosta.
add_filter('blockstudio/settings/block_editor/blocks/categories/deny', function() {
return ['embed'];
});
block_editor/blocks/categories/rename
Tällä suodattimella voit nimetä lohkoluokkien tunnisteet uudelleen tunnisteosan perusteella.
add_filter('blockstudio/settings/block_editor/blocks/categories/rename', function() {
return [
'text' => 'Writing',
'design' => 'Layout'
];
});
block_editor/blocks/categories/order
Tällä suodattimella voit järjestää lohkoluokkien tunnisteosat lisäysvalikossa.
add_filter('blockstudio/settings/block_editor/blocks/categories/order', function() {
return ['my-theme', 'text', 'media'];
});
block_editor/blocks/styles/deny
Tällä suodattimella voit poistaa rekisteröinnin lohkotyyleiltä, jotka PHP on rekisteröinyt, lohkonimen perusteella.
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
Tällä suodattimella voit piilottaa lisää vanhoja vimpaimia vanhojen vimpainten lohkosta.
add_filter('blockstudio/settings/block_editor/blocks/legacy_widgets/hide', function() {
return ['archives', 'calendar'];
});
block_editor/patterns/core
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä WordPress-ydinkirjaston lohkomallit.
add_filter('blockstudio/settings/block_editor/patterns/core', function() {
return false;
});
block_editor/patterns/remote
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä lohkomallihakemiston WordPress etälohkomallit.
add_filter('blockstudio/settings/block_editor/patterns/remote', function() {
return false;
});
block_editor/patterns/theme
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä teeman tarjoamat lohkomallit.
add_filter('blockstudio/settings/block_editor/patterns/theme', function() {
return false;
});
block_editor/patterns/blockstudio
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä Blockstudio-tiedostopohjaiset lohkomallit.
add_filter('blockstudio/settings/block_editor/patterns/blockstudio', function() {
return false;
});
block_editor/patterns/categories/allow
Tällä suodattimella voit määrittää, mitkä lohkomalliluokkien tunnisteosat pysyvät käytettävissä.
add_filter('blockstudio/settings/block_editor/patterns/categories/allow', function() {
return ['featured', 'buttons', 'columns'];
});
block_editor/patterns/categories/deny
Tällä suodattimella voit poistaa lohkomalliluokkien tunnisteosia lohkomallien lisäysvalikosta.
add_filter('blockstudio/settings/block_editor/patterns/categories/deny', function() {
return ['gallery'];
});
block_editor/patterns/categories/rename
Tällä suodattimella voit nimetä lohkomalliluokkien tunnisteet uudelleen tunnisteosan perusteella.
add_filter('blockstudio/settings/block_editor/patterns/categories/rename', function() {
return [
'featured' => 'Featured Layouts'
];
});
block_editor/patterns/categories/order
Tällä suodattimella voit järjestää lohkomalliluokkien tunnisteosat lisäysvalikossa.
add_filter('blockstudio/settings/block_editor/patterns/categories/order', function() {
return ['featured', 'buttons'];
});
block_editor/media/openverse
Tällä suodattimella voit ottaa lohkoeditorin median lisäysvalikon Openverse-medialuokan käyttöön tai poistaa sen käytöstä.
add_filter('blockstudio/settings/block_editor/media/openverse', function() {
return false;
});
block_editor/media/image_sizes/allow
Tällä suodattimella voit määrittää, mitkä kuvakokojen nimet pysyvät käytettävissä editorin median hallintatoiminnoissa.
add_filter('blockstudio/settings/block_editor/media/image_sizes/allow', function() {
return ['thumbnail', 'large'];
});
block_editor/media/image_sizes/deny
Tällä suodattimella voit poistaa kuvakokojen nimiä editorin median hallintatoiminnoista.
add_filter('blockstudio/settings/block_editor/media/image_sizes/deny', function() {
return ['medium_large'];
});
ai/enable_context_generation
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä kontekstitiedoston luomisen LLM-työkalujen integrointia varten. Kun toiminto on käytössä, kontekstitiedostoon kootaan ajantasaiset lohkotiedot, nykyisen asennuksen Blockstudio-asetukset, kaikki asiaankuuluvat skeemat ja Blockstudio-dokumentaatio yhdeksi lähteeksi tekoälyavusteisille kehitystyökaluille.
add_filter('blockstudio/settings/ai/enable_context_generation', function() {
return true;
});
block_tags/enabled
Tällä suodattimella voit ottaa sivutason lohkotunnisteiden renderöinnin käyttöön tai poistaa sen käytöstä.
add_filter('blockstudio/settings/block_tags/enabled', function() {
return true;
});
block_tags/prefixes
Tällä suodattimella voit rekisteröidä etuliitteitä, jotka toimivat lohkotunnisteiden nimiavaruuksien lyhenteinä.
add_filter('blockstudio/settings/block_tags/prefixes', function() {
return [
'theme' => ['theme-components', 'bsui']
];
});
dev/grab/enabled
Tällä suodattimella voit ottaa elementin tarttujan käyttöön tai poistaa sen käytöstä.
add_filter('blockstudio/settings/dev/grab/enabled', function() {
return false;
});
dev/perf
Tällä suodattimella voit ottaa suorituskykyprofiloijan käyttöön tai poistaa sen käytöstä.
add_filter('blockstudio/settings/dev/perf', function() {
return false;
});
dev/canvas/enabled
Tällä suodattimella voit ottaa piirtoalueen käyttöön tai poistaa sen käytöstä.
add_filter('blockstudio/settings/dev/canvas/enabled', function() {
return false;
});
dev/canvas/admin_bar
Tällä suodattimella voit näyttää tai piilottaa piirtoalueen WordPress-ylläpitopalkin.
add_filter('blockstudio/settings/dev/canvas/admin_bar', function() {
return true;
});
WPML
blockstudio/wpml/config/label
Suodattaa kunkin avaimen selitteen, jonka wp bs wpml config kirjoittaa. Katso kontekstitaulukon ohjeet kohdasta Vaihda selitteet.
add_filter('blockstudio/wpml/config/label', function($label, $context) {
return str_replace(' (optional)', '', $label);
}, 10, 2);
Piirtoalue
blockstudio/canvas/inventory
Tämä suodatin muokkaa valintaa koskevia piirtoalueen inventaarioraportteja. Takaisinkutsufunktio saa inventaarion DTO:n, alkuperäisen valinnan ja sille annetut asetukset.
add_filter('blockstudio/canvas/inventory', function(array $result, array $selection, array $options) {
return $result;
}, 10, 3);
blockstudio/canvas/documents
Tämä suodatin muokkaa piirtoalueen palauttamia renderöityjä asiakirjoja. Sille annetaan samat kolme argumenttia kuin inventaariosuodattimelle.
blockstudio/canvas/item_loaded
Tämä toiminto suoritetaan kerran kullekin inventaariotietueelle sen latautuessa. Se saa inventaariotyypin, tietueen kanonisen tunnuksen ja normalisoidun tietueen.
blockstudio/canvas/source_compiled
Tämä toiminto suoritetaan, kun lähdetiedosto on käännetty piirtoaluetta varten. Se saa valitun lähdepolun ja kanonisen lähdetietueen.
Niputetut UI
blockstudio/ui/directories
Tämä suodatin muokkaa hakemistoja, joista niputettuja UI-komponentteja etsitään.
blockstudio/ui/inventory
Tämä suodatin muokkaa julkista UI-perheinventaariota.
blockstudio/ui/examples
Tämä suodatin muokkaa UI-esimerkkitietueita. Se saa esimerkit ja julkisen UI-inventaarioluettelon, josta ne on muodostettu.
Topologia
blockstudio/blocks/topology_refreshed
Tämä toiminto suoritetaan lohkotopologian uudelleenmuodostuksen jälkeen.
blockstudio/pages/topology_refreshed
Tämä toiminto suoritetaan sivutopologian uudelleenmuodostuksen jälkeen.
blockstudio/pages/layout_error
Tämä toiminto suoritetaan, kun sivun asettelun renderöinti epäonnistuu, jotta virhe ei jää hiljaiseksi.
Ajoympäristö
blockstudio/runtime/initialized
Tämä toiminto suoritetaan, kun ajoympäristö on ratkaissut määrityksensä.
blockstudio/runtime/changed
Tämä toiminto suoritetaan, kun ratkaistu ajoympäristön identiteetti muuttuu. Muutos siirtää välimuistin nimiavaruuksia ja staattisen esirenderöinnin tilaa.
blockstudio/performance/default_config
Tällä suodattimella voit muokata suorituskyvyn oletusarvoja ennen kuin projektin omat blockstudio.json-arvot lisätään niiden päälle.
Sisältö
blockstudio/content/orphan_action
Tämä suodatin määrittää, mitä sisällön synkronointi tekee tietueelle, jolla ei enää ole lähdettä.
Bootstrap
blockstudio/url
Tällä suodattimella muutetaan julkista URL-arvoa, jota käytetään kohteen Blockstudio editorin ja ylläpidon aineistoissa. Composer-integraatioiden on rekisteröitävä se ennen kohteen Blockstudio autoload-tiedoston lataamista. Toinen argumentti on paketin fyysinen hakemisto.
add_filter(
'blockstudio/url',
function(string $url, string $directory) {
return get_stylesheet_directory_uri() . '/vendor/blockstudio/blockstudio/';
},
10,
2
);
Ajoympäristön välimuisti
blockstudio/cache/dir
Tämä suodatin saa ratkaistun välimuistin kantahakemiston ennen kuin siihen lisätään ajoympäristön, editoriaineistojen tai muun välimuistin alueen hakemisto.
add_filter('blockstudio/cache/dir', function(string $directory) {
return WP_CONTENT_DIR . '/cache/blockstudio';
});
blockstudio/cache/context
Tällä suodattimella lisätään välimuistin tunnisteisiin sarjallistettava ajoympäristön muunnelma. Käytä sitä, kun sama etsinnän lähde voi valita eri loogisia inventaarioita.
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
Tällä suodattimella muutetaan verkon tai blogin hakemistotunnistetta ympäristöissä, joilla on oma vuokralaisten raja. Palautettu arvo puhdistetaan ennen käyttöä.
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
Tällä suodattimella lisätään palvelimen tietoja, jotka vaikuttavat kaikkiin ajoympäristön alueen objekteihin. Yksittäisen kohteen lähteen tunnisteet on sen sijaan välitettävä eksplisiittisinä riippuvuuksina omistavalle API-kohteelle.
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äärittää, kuinka monta sekuntia validoitua tiedostoseurannan tilannevedosta voi käyttää uudelleen ilman uutta tiedostojärjestelmän stat-tarkistusta. Oletusarvo on 0 paikallisissa ja kehitysympäristöissä ja 20 muualla.
add_filter('blockstudio/cache/watch_debounce', function() {
return 30;
});
blockstudio/cache/build_wait_budget
Määrittää, kuinka kauan pyyntö odottaa millisekunteina samanaikaista muodostajaa, joka julkaisee ajoympäristön välimuistin tai päivitetyn valinnan, ennen kuin sen toimintaa heikennetään. Rakenteellisten uudelleenmuodostusten oletusarvo on 5000 ja valintojen päivitysten 4000.
add_filter('blockstudio/cache/build_wait_budget', function() {
return 2000;
});
blockstudio/cache/populate_debounce
Määrittää, kuinka monta sekuntia sisällön, termien, käyttäjien tai metatietojen kirjoituksista koostuva ryöpsähdys yhdistetään yhdeksi valinnan päivitykseksi. Ensimmäinen kirjoitus hiljaisen jakson jälkeen päivittää heti; ryöpsähdyksen viimeinen kirjoitus näkyy, kun aikaikkuna on kulunut. Oletusarvo on 30. Palauta 0, jos haluat päivittää jokaisen kirjoituksen yhteydessä.
add_filter('blockstudio/cache/populate_debounce', function() {
return 120;
});
blockstudio/cache/populate_ignored_meta_keys
Suodattaa metatietoavaimet, joiden kirjoitukset eivät koskaan päivitä täytettyjä valintoja. Oletusarvoisesti näitä ovat avaimet, joita WordPress kirjoittaa muokkauksen ja kirjautumisen yhteydessä tehtävään seurantaan: _edit_lock, jonka muokkain ja Heartbeat päivittävät artikkelin ollessa auki; _edit_last, joka kirjoitetaan sellaisen artikkelin tallennuksen yhteydessä, joka jo päivittää tiedot; sekä session_tokens, joka kirjoitetaan sisään- ja uloskirjautumisen yhteydessä. Lisää tähän avaimet, jotka muuttuvat usein mutta eivät koskaan vaikuta täyttökyselyyn.
add_filter('blockstudio/cache/populate_ignored_meta_keys', function(array $keys) {
$keys[] = '_my_view_counter';
return $keys;
});
blockstudio/cache/max_files_per_scope
Määrittää, kuinka monta julkaistua hyötykuormaa kukin ajoympäristön välimuistialue säilyttää.
add_filter('blockstudio/cache/max_files_per_scope', function($maximum, $scope) {
return $scope === 'runtime' ? 50 : $maximum;
}, 10, 2);
blockstudio/cache/compress
Suodattaa, käyttääkö välimuistin hyötykuorma tavallisen PHP-taulukon sijaan pakattua sarjallistettua dataa. Oletusarvoisesti enintään 1 MiB:n hyötykuormissa käytetään tavallista muotoa vain, jos aktiivisen OPcache-välimuistin jaettu muisti voi tallentaa kohteen. Muissa prosesseissa, poissuljetuissa tiedostoissa ja suuremmissa hyötykuormissa käytetään pakkausta.
add_filter('blockstudio/cache/compress', function($compress, $scope) {
return $scope === 'runtime' ? false : $compress;
}, 10, 2);
Palauttamalla false ohitat myös kokorajoituksen. Tästä voi olla hyötyä, kun WP-CLI ilman opcache.enable_cli lämmittää tiedostoja OPcachea käyttävien verkkotyöntekijöiden välimuistiin, mutta jokainen lukija ilman OPcachea jäsentää luodun taulukon. Käytä pakkausta suurille jaetuille hyötykuormille, ellei ylimääräinen muistinkulutus ole hyväksyttävä. Oletussuojauksista kerrotaan kohdassa välimuistin hyötykuormamuodot.
blockstudio/cache/protected_paths
Välimuistipolkujen säilytyksen siivous ei saa koskaan poistaa. Blockstudio alustaa luettelon kaikilla tiedostoilla, joihin asennettu varhaisen tarjoilun kartta viittaa.
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
Tämä toiminto raportoi yhteisen välimuistialueen ja tuloksen, kuten hit, build, miss-stale, stale-last-good tai 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
Tämä suodatin saa lopullisen päätöksen anonyymikäyttöturvallisuudesta sekä palvelin- ja evästetiedot. Arvon true palauttaminen ohittaa aina staattisen tarjoilun ja generoinnin.
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
Tämä suodatin tarjoaa tai muokkaa koko julkista URL-inventaarioita, jota ajastettu lämmitys ja eksplisiittiset graafityökalut käyttävät.
add_filter('blockstudio/static_prerender/public_urls', function(array $urls) {
$urls[] = home_url('/custom-route/');
return array_values(array_unique($urls));
});
Suodattimen palauttama arvo ei ole lopullinen inventaario. Tulos käy läpi välimuistikelpoisuuden tarkistuksen, joka poistaa kaikki määritettyä dynaamista polkua vastaavat kohteet sekä oletusarvoisesti ohitettavat kohteet: /wp-admin, /wp-json, /wp-login.php, /xmlrpc.php, kaikki polut, jotka sisältävät kohteen /feed/, sekä sivuston kotipolun hakuperustan alapuolella olevat hakutulokset (oletusarvoisesti /search/). Lisäämäsi URL voidaan siis hylätä ilman varoitusta. Jos odottamasi reitti puuttuu koostetusta inventaariosta, tarkista ensin, rikkooko se näitä sääntöjä. Älä oleta, ettei suodatinta suoritettu.
blockstudio/static_prerender/render_internal
Tämä suodatin toteuttaa valinnaisen prosessinsisäisen eräsiirron. Palauta normalisoitu tulostaulukko tai jätä arvo ennalleen, jotta renderöijä käyttää määritettyä HTTP-varavaihtoehtoa. Tulos sisältää html sekä valinnaisesti status, dependencies, virtualHashes ja headers; kohteessa performance.staticPrerender.replayHeaders nimetyt otsakkeet tallennetaan dokumentin yhteyteen.
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
Tämä suodatin tekee lopullisen päätöksen sen jälkeen, kun Blockstudio on varmistanut, että tuloste on valmis HTML-asiakirja, jossa ei ole välimuistin estävää merkintää, ja että havaittu vastaustila ilmaisee onnistumista. Kolmas argumentti on havaittu tila tai null, jos tilaa ei ole ilmoitettu.
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
Tämä toiminto raportoi staattisen esirenderöinnin tulokset, kuten osumat, ohitukset, kirjoitukset, graafikirjoitukset, vanhentuneet kohteet ja epäonnistumiset.
add_action('blockstudio/static_prerender/outcome', function(string $reason) {
my_metrics()->increment("blockstudio.prerender.{$reason}");
});
blockstudio/tailwind/cache_max_files
Määrittää käännettyjen Tailwind CSS-merkintöjen enimmäismäärän. Oletusarvo on 1000.
add_filter('blockstudio/tailwind/cache_max_files', function() {
return 1500;
});
blockstudio/tailwind/cache_max_age
Määrittää käännettyjen Tailwind CSS-merkintöjen enimmäisiän sekunteina. Oletusarvo on 30 päivää ja vähimmäisarvo yksi tunti.
add_filter('blockstudio/tailwind/cache_max_age', function() {
return 14 * DAY_IN_SECONDS;
});
Hallinta-alue
käytössä
Tällä suodattimella voit ottaa käyttöön tai poistaa käytöstä Blockstudio-ylläpitosivun kohdassa Työkalut > Blockstudio.
add_filter('blockstudio/admin/enabled', function() {
return false;
});
Aineistot
editor/canvas/body_class
Kun aineistojen nollaus on käytössä, tämä suodatin muokkaa siistittyjä käyttöliittymän body-luokkia, jotka kopioidaan lohkoeditorin piirtoalueelle.
add_filter('blockstudio/editor/canvas/body_class', function(array $classes) {
return array_values(array_diff($classes, ['logged-in']));
});
käyttöön
Tällä suodattimella voit poistaa tietyn tyyppisen aineiston käsittelyn ja lataamisen käytöstä.
add_filter('blockstudio/assets/enable', function($enable, $type, $block) {
if ($type === 'css' && $block['name'] === 'my/block') {
return false;
}
return $enable;
}, 10, 3);
käytöstä
Tällä suodattimella voit poistaa käytöstä tiettyjä aineistoja niiden tunnisteen perusteella. Palautetun taulukon tunnistetta vastaavia aineistoja ei renderöidä käyttöliittymässä.
add_filter('blockstudio/assets/disable', function($disabled) {
$disabled[] = 'my-block-style';
return $disabled;
});
process/scss/import_paths
Tällä suodattimella voit lisätä polkuja kohteen SCSS kääntäjän @import-lausekkeeseen.
add_filter('blockstudio/assets/process/scss/import_paths', function($paths) {
$paths[] = get_stylesheet_directory() . '/scss';
return $paths;
});
process/scss/prelude
Tällä suodattimella voit lisätä jaetun Sass-koodin kunkin SCSS-tiedoston alkuun ennen sen kääntämistä.
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
Tällä suodattimella voit muokata tiedoston CSS sisältöä ennen sen kääntämistä.
add_filter('blockstudio/assets/process/css/content', function($content, $block) {
return str_replace('old-class', 'new-class', $content);
}, 10, 2);
process/js/content
Tällä suodattimella voit muokata tiedoston JS sisältöä ennen sen kääntämistä.
add_filter('blockstudio/assets/process/js/content', function($content, $block) {
return $content;
}, 10, 2);
Puskurointi
käytössä
Blockstudio puskuroi käyttöliittymän vastauksen, jotta rungon sisällä renderöidyt lohkotyyli- ja komentosarjatunnisteet voidaan siirtää head- ja footer-osioihin ja jotta Tailwind voi käydä läpi koko asiakirjan. Puskurointi tarkoittaa, että koko asiakirja tallennetaan ja käydään läpi jokaisella käyttöliittymän pyynnöllä. Sivusto, joka ei renderöi lohkoaineistoja Blockstudio eikä käytä toimintoa Tailwind, voi palauttaa arvon false ja ohittaa molemmat.
add_filter('blockstudio/buffer/enabled', '__return_false');
Puskurointi on pois käytöstä myös hallinnassa ja mukauttimen esikatselussa. Selvitä funktion bs_is_buffering() avulla kohdasta wp_enqueue_scripts tai myöhemmästä vaiheesta, puskuroidaanko nykyinen vastaus. Se palauttaa arvon false ennen kuin päätös tehdään kohdassa template_redirect.
tuloste
Tämä suodatin saa koko puskuroitu HTML-asiakirjan ennen sen lähettämistä. Kohteen Blockstudio oma aineistojen siirto suoritetaan prioriteetilla 1000000 ja Tailwind-kääntäminen prioriteetilla 999999, joten suorita tämä aiemmin nähdäksesi asiakirjan ennen niitä tai myöhemmin nähdäksesi lopullisen tulosteen.
add_filter('blockstudio/buffer/output', function(string $html) {
return $html;
}, 2000000);
Renderöinti
riippuvuudet
Tämä suodatin ilmoittaa valitun mallin ja aineistoriippuvuudet aina, kun Blockstudio renderöi lohkon. Siitä on hyötyä staattisille viejille ja muille prosessinsisäisille riippuvuuksien kerääjille.
add_filter(
'blockstudio/render/dependencies',
function($paths, $name, $block, $isEditor, $isPreview) {
my_dependency_graph()->add($name, $paths);
return $paths;
},
10,
5
);
globaali
Tällä suodattimella voit muokata sivun tulostetta ennen sen renderöintiä.
add_filter('blockstudio/render', function($content) {
return $content;
});
head
Tämän suodattimen avulla voit muokata <head>-tunnisteen tulostetta ennen sen
renderöintiä. Se suoritetaan vain, kun Blockstudio puskuroi vastauksen. Katso
bs_is_buffering().
add_filter('blockstudio/render/head', function($content) {
return $content . '<meta name="custom" content="value">';
});
footer
Tällä suodattimella voit muokata kohteen </body> tulostetta ennen renderöintiä.
add_filter('blockstudio/render/footer', function($content) {
return $content . '<script>console.log("loaded")</script>';
});
Virheiden käsittely
error/logged
Toiminto suoritetaan virheen kirjaamisen jälkeen. Käytä sitä virheiden lähettämiseen ulkoisiin lokituspalveluihin.
add_action('blockstudio/error/logged', function($message, $level, $context) {
if ($level === 'error') {
my_external_logger($message, $context);
}
}, 10, 3);
error/exception
Toiminto suoritetaan poikkeuksen käsittelyn jälkeen.
add_action('blockstudio/error/exception', function($exception, $context) {
my_error_tracker($exception);
}, 10, 2);
Tietokanta
Kaikki tietokantakoukut saavat yhden $params-taulukon.
db/before_create
Toiminto suoritetaan ennen tietueen luomista.
add_action('blockstudio/db/before_create', function($params) {
// $params: block, schema, data, storage
});
db/after_create
Toiminto suoritetaan tietueen luomisen jälkeen.
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
Toiminto suoritetaan ennen tietueen päivittämistä.
add_action('blockstudio/db/before_update', function($params) {
// $params: block, schema, id, data, storage
});
db/after_update
Toiminto suoritetaan tietueen päivittämisen jälkeen.
add_action('blockstudio/db/after_update', function($params) {
// $params: block, schema, id, record, storage
});
db/before_delete
Toiminto suoritetaan ennen tietueen poistamista.
add_action('blockstudio/db/before_delete', function($params) {
// $params: block, schema, id, storage
});
db/after_delete
Toiminto suoritetaan tietueen poistamisen jälkeen.
add_action('blockstudio/db/after_delete', function($params) {
// $params: block, schema, id, storage
});
RPC
Kaikki RPC-koukut saavat yhden $params-taulukon.
rpc/before_call
Toiminto suoritetaan ennen RPC-funktion kutsumista.
add_action('blockstudio/rpc/before_call', function($params) {
// $params: block, function, params
});
rpc/after_call
Toiminto suoritetaan RPC-funktion kutsumisen jälkeen.
add_action('blockstudio/rpc/after_call', function($params) {
// $params: block, function, params, result
});