Hoppa till innehåll

Filtrera attribut

Blockstudio tillhandahåller två metoder för att filtrera blockattribut.

Attributdefinitioner

blockstudio/blocks/attributes filtrerar varje fältdefinition, medan Blockstudio bygger och registrerar ett block. Använd den för att justera redigerarkontroller, standardvärden, villkor, alternativ och definitionen som används för att validera värden vid rendering.

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

Koden ovan anger lineNumbers som standardvärde för true och döljer fältet om inte language anges till css.

Återanropet får en fältdefinition per anrop, inklusive nästlade grupp- och repeaterfält. Det körs när blocket registreras, inte vid varje rendering i frontend.

Filtrerade alternativdefinitioner används också av renderingsattributkartan. Till exempel blir ett alternativ som läggs till i ett select-, radio– eller checkbox-fält tillgängligt i redigeraren och förblir giltigt när Blockstudio hämtar det sparade värdet för en mall:

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

Renderade värden

blockstudio/blocks/attributes/render filtrerar det lösta värdet för ett fält omedelbart innan det skickas till blockmallen. Det körs en gång för varje fält, så en callback får värdet, fältets nyckel och blockdata.

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

Exemplet ovan åsidosätter alla värden som sparats i redigeraren för lineNumbers. Registrera callbacken med tre accepterade argument (det sista argumentet i add_filter); annars skickar WordPress bara värdet.

  • $value: fältets lösta värde, i den form som mallen tar emot som $a[$key]. Returnera värdet som mallen ska få.
  • $key: fältets nyckel, som den används i $a. I en repeaterrad är detta ID:t för fältet i raden.
  • $block: blockdataarrayen som mallar tar emot som $block eller $b, med id, name, postId, postType, index, indexTotal, context och ö-flaggorna. För tillägg applicerade på ett block som inte är ett Blockstudio-block innehåller $block endast posten blockstudio (attributes och disabled) och saknar name.

Filtret körs även för attribut som inte är fält av typen Blockstudio, till exempel className och anchor, samt för <id>__size-motsvarigheten till ett filfält. Jämför därför $key innan du ändrar ett värde. Returvärdet ersätter endast värdet för $key; filtret kan inte lägga till nya nycklar i $a.

Använd definitionsfiltret när du ändrar fältkonfigurationen och återgivningsfiltret när du beräknar eller åsidosätter mallvärden för en begäran.

När värden läses via bs_block_values() i stället för att återges, får filtret endast blocknamnet i $block. Återgivningsräknare och annan metadata som endast används vid återgivning skapas inte av den hjälpfunktionen.