Filtrarea atributelor
Blockstudio oferă două metode pentru filtrarea atributelor blocurilor.
Definițiile atributelor
blockstudio/blocks/attributes filtrează definiția fiecărui câmp, în timp ce Blockstudio construiește și înregistrează un bloc. Folosiți-l pentru a ajusta controalele editorului, valorile implicite, condițiile, opțiunile și definiția folosită la validarea valorilor în timpul redării.
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);
Codul de mai sus setează valoarea implicită a lui lineNumbers la true și ascunde câmpul, cu excepția cazului în care language este setat la css.
La fiecare apel, funcția callback primește definiția unui singur câmp, inclusiv pentru câmpurile imbricate de grup și repetabile. Rulează în timpul înregistrării blocului, nu o dată pentru fiecare redare pe interfața publică.
Definițiile opțiunilor filtrate sunt folosite și de harta atributelor pentru redare. De exemplu, o opțiune adăugată la un câmp select, radio sau checkbox este disponibilă în editor și rămâne validă când Blockstudio rezolvă valoarea salvată pentru un șablon:
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);
Valori redate
blockstudio/blocks/attributes/render filtrează valoarea rezolvată a unui câmp
imediat înainte de a fi transmisă șablonului blocului. Rulează o dată pentru fiecare
câmp, astfel încât funcția callback primește valoarea, cheia câmpului și datele blocului.
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);
Exemplul de mai sus suprascrie orice valoare salvată în editor pentru lineNumbers.
Înregistrați funcția callback cu trei argumente acceptate (ultimul argument al
add_filter), altfel WordPress transmite numai valoarea.
$value: valoarea rezolvată a câmpului, în forma în care șablonul o primește ca$a[$key]. Returnați valoarea pe care ar trebui să o primească șablonul.$key: cheia câmpului, așa cum este folosită în$a. Într-un rând al unui repetor, aceasta este ID-ul câmpului din rând.$block: matricea de date a blocului pe care șabloanele o primesc ca$blocksau$b, cuid,name,postId,postType,index,indexTotal,contextși indicatorii insulei. Pentru extensii aplicate unui bloc care nu este un bloc Blockstudio,$blockconține doar intrareablockstudio(attributesșidisabled) și nu arename.
Filtrul rulează și pentru atribute care nu sunt câmpuri Blockstudio, precum
className și anchor, și pentru elementul asociat <id>__size al unui câmp de fișiere,
așa că verificați $key înainte de a schimba o valoare. Valoarea returnată înlocuiește doar valoarea
lui $key; filtrul nu poate adăuga chei noi la $a.
Folosiți filtrul de definiție pentru a schimba configurația câmpurilor și filtrul de randare pentru a calcula sau a suprascrie valorile șablonului pentru o solicitare.
Când valorile sunt citite prin bs_block_values()
în loc să fie randate, acest filtru primește doar numele blocului în $block.
Contoarele de randare și alte metadate disponibile doar la randare nu sunt create de acel helper.