Ga naar de inhoud

Attributen filteren

Blockstudio biedt twee methoden om blokattributen te filteren.

Attribuutdefinities

blockstudio/blocks/attributes filtert elke velddefinitie, terwijl Blockstudio een blok bouwt en registreert. Gebruik dit om editorbedieningselementen, standaardwaarden, voorwaarden en opties aan te passen, evenals de definitie die wordt gebruikt om waarden tijdens het renderen te valideren.

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

De bovenstaande code stelt de standaardwaarde van lineNumbers in op true en verbergt het veld tenzij language is ingesteld op css.

De callback ontvangt per aanroep één velddefinitie, inclusief geneste groeps- en repeater-velden. Deze wordt uitgevoerd tijdens de blokregistratie, niet één keer per frontend-render.

Gefilterde optiedefinities worden ook gebruikt door de render-attribuutmap. Een optie die bijvoorbeeld is toegevoegd aan een veld van het type select, radio of checkbox is beschikbaar in de editor en blijft geldig wanneer Blockstudio de opgeslagen waarde voor een template ophaalt:

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

Gerenderde waarden

blockstudio/blocks/attributes/render filtert de opgeloste waarde van één veld direct voordat deze aan de blocktemplate wordt doorgegeven. Het wordt voor elk veld eenmaal uitgevoerd, zodat een callback de waarde, de veldsleutel en de blockgegevens ontvangt.

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

Het bovenstaande voorbeeld overschrijft elke waarde die in de editor voor lineNumbers is opgeslagen. Registreer de callback met drie geaccepteerde argumenten (het laatste argument van add_filter); anders geeft WordPress alleen de waarde door.

  • $value: de opgeloste waarde van het veld, in de vorm waarin de template die ontvangt als $a[$key]. Geef de waarde terug die de template moet ontvangen.
  • $key: de sleutel van het veld, zoals gebruikt in $a. Binnen een repeaterrij is dit de ID van het veld in de rij.
  • $block: de array met blockgegevens die templates ontvangen als $block of $b, met id, name, postId, postType, index, indexTotal, context en de eilandvlaggen. Voor uitbreidingen die zijn toegepast op een block dat geen Blockstudio-block is, bevat $block alleen de vermelding blockstudio (attributes en disabled) en heeft het geen name.

Het filter wordt ook uitgevoerd voor attributen die geen Blockstudio-velden zijn, zoals className en anchor, en voor de bijbehorende <id>__size van een bestandsveld. Controleer daarom $key voordat u een waarde wijzigt. De retourwaarde vervangt alleen de waarde van $key; het filter kan geen nieuwe sleutels toevoegen aan $a.

Gebruik het definitiefilter om de veldconfiguratie te wijzigen en het weergavefilter om templatewaarden voor een verzoek te berekenen of te overschrijven.

Wanneer waarden worden gelezen via bs_block_values() in plaats van weergegeven, ontvangt dit filter alleen de blocknaam in $block. Deze helper maakt geen weergavetellers of andere metadata die alleen voor weergave worden gebruikt aan.