Přejít k obsahu

Filtrování atributů

Blockstudio poskytuje dvě metody pro filtrování atributů bloků.

Definice atributů

blockstudio/blocks/attributes filtruje definici každého pole, zatímco Blockstudio sestavuje a registruje blok. Použijte jej k úpravě ovládacích prvků editoru, výchozích hodnot, podmínek, možností a definice používané při ověřování hodnot během vykreslování.

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

Výše uvedený kód nastaví výchozí hodnotu lineNumbers na true a skryje pole, pokud language není nastaveno na css.

Zpětné volání při každém spuštění obdrží jednu definici pole, včetně vnořených skupinových polí a polí opakovače. Spouští se při registraci bloku, nikoli při každém vykreslení na webu.

Filtrované definice možností se používají také v mapě vykreslovacích atributů. Možnost přidaná například do pole select, radio nebo checkbox je dostupná v editoru a zůstává platná, když Blockstudio načítá uloženou hodnotu pro šablonu:

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 vyřešenou hodnotu jednoho pole bezprostředně před jejím předáním šabloně bloku. Spouští se jednou pro každé pole, takže zpětné volání obdrží hodnotu, klíč pole a data 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);

Výše uvedený příklad přepíše jakoukoli hodnotu uloženou v editoru pro lineNumbers. Zpětné volání zaregistrujte se třemi přijímanými argumenty (posledním argumentem add_filter), jinak WordPress předá pouze hodnotu.

  • $value: vyřešená hodnota pole ve formátu, v jakém ji šablona obdrží jako $a[$key]. Vraťte hodnotu, kterou má šablona dostat.
  • $key: klíč pole používaný v $a. Uvnitř řádku opakovače jde o ID pole v daném řádku.
  • $block: pole dat bloku, které šablony obdrží jako $block nebo $b, spolu s id, name, postId, postType, index, indexTotal, context a příznaky ostrova. U rozšíření extenze použitých na blok, který není blokem Blockstudio, obsahuje $block pouze položku blockstudio (attributes a disabled) a nemá name.

Filtr se spouští také u atributů, které nejsou poli Blockstudio, například className a anchor, i u doprovodného <id>__size pole souborů. Před změnou hodnoty proto porovnejte $key. Návratová hodnota nahrazuje pouze hodnotu $key; filtr nemůže přidat nové klíče do $a.

Filtr definice použijte při změně konfigurace pole a filtr vykreslení při výpočtu nebo přepsání hodnot šablony pro požadavek.

Když se hodnoty čtou přes bs_block_values() místo vykreslení, obdrží tento filtr v $block pouze název bloku. Tato pomocná funkce nevytváří počítadla vykreslení ani další metadata dostupná pouze při vykreslení.