Attribuuttien suodatus
Blockstudio tarjoaa kaksi tapaa suodattaa lohkon attribuutteja.
Attribuuttien määritykset
blockstudio/blocks/attributes suodattaa kunkin kentän määrityksen, kun taas Blockstudio kokoaa ja rekisteröi lohkon. Sen avulla voit muokata editorin säätimiä, oletusarvoja, ehtoja ja vaihtoehtoja sekä määritystä, jota käytetään arvojen kelpoisuuden tarkistamiseen renderöinnin aikana.
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
if (
($block['name'] ?? '') === 'my-theme/code-block' &&
($attribute['id'] ?? '') === 'lineNumbers'
) {
$attribute['default'] = true;
$attribute['conditions'] = [
[
[
'id' => 'language',
'operator' => '==',
'value' => 'css'
]
]
];
}
return $attribute;
}, 10, 2);
Yllä oleva koodi asettaa lineNumbers-kentän oletusarvoksi true ja piilottaa kentän, ellei language-arvoksi ole asetettu css.
Takaisinkutsulle annetaan kullakin kutsukerralla yksi kentän määritys, myös sisäkkäisten ryhmä- ja toistinkenttien määritykset. Se suoritetaan lohkoa rekisteröitäessä, ei jokaisen käyttöliittymän renderöinnin yhteydessä.
Suodatettuja vaihtoehtojen määrityksiä käytetään myös renderöinnin attribuuttikartassa. Esimerkiksi select-, radio– tai checkbox-kenttään lisätty vaihtoehto on käytettävissä editorissa ja kelvollinen myös silloin, kun Blockstudio ratkaisee malliin tallennetun arvon:
add_filter('blockstudio/blocks/attributes', function($attribute, $block) {
if (
($block['name'] ?? '') === 'bsui/button' &&
($attribute['id'] ?? '') === 'variant'
) {
$attribute['options'][] = [
'label' => 'Brand',
'value' => 'brand',
];
}
return $attribute;
}, 10, 2);
Renderöidyt arvot
blockstudio/blocks/attributes/render suodattaa yhden kentän ratkaistun arvon juuri ennen kuin se välitetään lohkomallineelle. Suodatin suoritetaan kerran kutakin kenttää kohden, joten takaisinkutsu saa arvon, kentän avaimen ja lohkotiedot.
add_filter('blockstudio/blocks/attributes/render', function($value, $key, $block) {
if (($block['name'] ?? '') === 'my-theme/code-block' && 'lineNumbers' === $key) {
return true;
}
return $value;
}, 10, 3);
Yllä oleva esimerkki ohittaa editorissa kohteelle lineNumbers tallennetun arvon. Rekisteröi takaisinkutsu kolmella hyväksytyllä argumentilla (add_filter-funktion viimeinen argumentti); muuten WordPress välittää vain arvon.
$value: kentän ratkaistu arvo siinä muodossa, jossa malline saa sen muodossa$a[$key]. Palauta arvo, jonka mallineen tulee saada.$key: kentän avain muodossa, jota käytetään kohteessa$a. Toistimen rivillä tämä on rivin sisäisen kentän tunnus.$block: lohkotietojen taulukko, jonka mallineet saavat muodossa$blocktai$bja johon kuuluvatid,name,postId,postType,index,indexTotal,contextsekä saarekeilmaisimet. Jos laajennus kohdistuu lohkoon, joka ei ole Blockstudio-lohko,$blocksisältää vainblockstudio-merkinnän (attributesjadisabled), eikä siinä olename-arvoa.
Suodatin suoritetaan myös attribuuteille, jotka eivät ole Blockstudio-kenttiä, kuten className ja anchor, sekä tiedostokentän <id>__size-kumppanille. Tarkista siis $key ennen arvon muuttamista. Palautusarvo korvaa vain $key-arvon; suodatin ei voi lisätä uusia avaimia kohteeseen $a.
Käytä määrittelysuodatinta kentän määritysten muuttamiseen ja renderöintisuodatinta mallinearvojen laskemiseen tai korvaamiseen pyynnön aikana.
Kun arvot luetaan renderöinnin sijaan kohteen bs_block_values() kautta, tämä suodatin saa kohteessa $block vain lohkon nimen. Apufunktio ei luo renderöintilaskureita tai muita vain renderöintiin liittyviä metatietoja.