Preskoči na vsebino

Filtriranje atributov

Blockstudio ponuja dve metodi za filtriranje atributov blokov.

Definicije atributov

blockstudio/blocks/attributes filtrira definicijo vsakega polja, medtem ko Blockstudio sestavi in registrira blok. Uporabite ga za prilagajanje kontrolnikov urejevalnika, privzetih vrednosti, pogojev, možnosti in definicije, ki se uporablja za preverjanje vrednosti med izrisom.

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

Zgornja koda nastavi privzeto vrednost za lineNumbers na true in skrije polje, razen če je language nastavljeno na css.

Povratni klic ob vsakem klicu prejme definicijo enega polja, vključno z ugnezdenimi skupinami in ponavljalnimi polji. Izvede se med registracijo bloka, ne pa pri vsakem izrisu na sprednji strani.

Filtrirane definicije možnosti se uporabljajo tudi v zemljevidu atributov za izris. Možnost, dodana polju select, radio ali checkbox, je na primer na voljo v urejevalniku in ostane veljavna, ko Blockstudio razreši shranjeno vrednost za predlogo:

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

Izrisane vrednosti

blockstudio/blocks/attributes/render filtrira razrešeno vrednost posameznega polja tik preden se ta posreduje predlogi bloka. Izvede se enkrat za vsako polje, zato povratna funkcija prejme vrednost, ključ polja in podatke bloka.

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

Zgornji primer prepiše vsako vrednost, shranjeno v urejevalniku za lineNumbers. Povratno funkcijo registrirajte s tremi sprejetimi argumenti (zadnji argument funkcije add_filter); sicer WordPress posreduje samo vrednost.

  • $value: razrešena vrednost polja v obliki, v kateri predloga prejme $a[$key]. Vrni vrednost, ki naj jo prejme predloga.
  • $key: ključ polja, kot je uporabljen v $a. V vrstici ponavljalnika je to ID polja znotraj vrstice.
  • $block: podatkovno polje bloka, ki ga predloge prejmejo kot $block ali $b, z id, name, postId, postType, index, indexTotal, context in zastavicami otoka. Pri razširitvah, uporabljenih za blok, ki ni blok Blockstudio, $block vsebuje samo vnos blockstudio (attributes in disabled) in nima name.

Filter se izvede tudi za atribute, ki niso polja Blockstudio, kot sta className in anchor, ter za spremljevalni atribut <id>__size polja z datotekami, zato pred spreminjanjem vrednosti preverite $key. Povratna vrednost nadomesti samo vrednost $key; filter ne more dodati novih ključev v $a.

Filter definicije uporabite za spreminjanje konfiguracije polja, filter izrisa pa za izračun ali prepis vrednosti predloge za posamezno zahtevo.

Če vrednosti berete z bs_block_values() namesto da bi jih izrisali, ta filter prejme samo ime bloka v $block. Ta pomočnik ne ustvari števcev izrisa in drugih metapodatkov, ki so na voljo samo pri izrisu.