Preskočiť na obsah

Filtrovanie atribútov

Blockstudio poskytuje dve metódy na filtrovanie atribútov blokov.

Definície atribútov

blockstudio/blocks/attributes filtruje definíciu každého poľa, zatiaľ čo Blockstudio zostavuje a registruje blok. Použite ho na úpravu ovládacích prvkov editora, predvolených hodnôt, podmienok, možností a definície používanej na overenie hodnôt počas vykresľovania.

PHP
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);

Vyššie uvedený kód nastaví predvolenú hodnotu lineNumbers na true a skryje pole, pokiaľ language nie je nastavené na css.

Pri každom volaní dostane spätné volanie jednu definíciu poľa vrátane vnorených skupinových polí a polí opakovača. Spustí sa pri registrácii bloku, nie pri každom vykreslení na frontende.

Filtrované definície možností sa používajú aj v mape atribútov vykreslenia. Napríklad možnosť pridaná do poľa select, radio alebo checkbox je dostupná v editore a zostáva platná, keď Blockstudio načíta uloženú hodnotu pre šablónu:

PHP
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);

Vykreslené hodnoty

blockstudio/blocks/attributes/render filtruje vyriešenú hodnotu jedného poľa bezprostredne pred jej odovzdaním šablóne bloku. Spustí sa raz pre každé pole, takže spätné volanie dostane hodnotu, kľúč poľa a údaje bloku.

PHP
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);

Vyššie uvedený príklad prepíše každú hodnotu uloženú v editore pre lineNumbers. Spätné volanie zaregistrujte s tromi akceptovanými argumentmi (posledný argument add_filter), inak WordPress odovzdá iba hodnotu.

  • $value: vyriešená hodnota poľa v tvare, v akom ju šablóna dostane ako $a[$key]. Vráťte hodnotu, ktorú má šablóna dostať.
  • $key: kľúč poľa používaný v $a. Vo vnútri riadka opakovača ide o ID poľa v danom riadku.
  • $block: pole údajov bloku, ktoré šablóny dostávajú ako $block alebo $b, spolu s id, name, postId, postType, index, indexTotal, context a príznakmi ostrova. Pri použití rozšírenia extensions v bloku, ktorý nie je blokom Blockstudio, obsahuje $block iba položku blockstudio (attributes a disabled) a neobsahuje name.

Filter sa spúšťa aj pre atribúty, ktoré nie sú poliami Blockstudio, napríklad className a anchor, a pre sprievodný atribút <id>__size poľa súborov, preto pred zmenou hodnoty skontrolujte $key. Návratová hodnota nahradí iba hodnotu $key; filter nemôže pridať nové kľúče do $a.

Filter definície použite pri zmene konfigurácie polí a filter vykreslenia pri výpočte alebo prepísaní hodnôt šablóny pre danú požiadavku.

Keď sa hodnoty čítajú cez bs_block_values() namiesto vykreslenia, tento filter dostane v $block iba názov bloku. Pomocník nevytvára počítadlá vykreslení ani ďalšie metadáta, ktoré sú k dispozícii iba pri vykreslení.