Liigu sisu juurde

Atribuutide filtreerimine

Blockstudio pakub ploki atribuutide filtreerimiseks kahte meetodit.

Atribuutide määratlused

blockstudio/blocks/attributes filtreerib iga välja määratluse, samal ajal kui Blockstudio koostab ja registreerib ploki. Selle abil saab kohandada redaktori juhtelemente, vaikeväärtusi, tingimusi ja valikuid ning määratlust, mida kasutatakse väärtuste renderdamisel valideerimiseks.

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

Ülaltoodud kood määrab lineNumbers vaikeväärtuseks true ja peidab välja, kui language väärtuseks pole määratud css.

Tagasikutse saab igal käivitamisel ühe välja määratluse, sealhulgas pesastatud rühma- ja korduvväljade määratlused. See käivitub ploki registreerimisel, mitte iga kasutajaliidese renderdamise ajal.

Filtreeritud valikute määratlusi kasutatakse ka renderdamise atribuutide kaardis. Näiteks väljale select, radio või checkbox lisatud valik on redaktoris saadaval ja jääb kehtivaks, kui Blockstudio hangib malli jaoks salvestatud väärtuse:

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

Renderdatud väärtused

blockstudio/blocks/attributes/render filtreerib ühe välja lahendatud väärtuse vahetult enne selle plokimallile edastamist. Seda käivitatakse iga välja jaoks üks kord, seega saab tagasihelistusfunktsioon väärtuse, välja võtme ja ploki andmed.

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

Ülaltoodud näide kirjutab üle redaktoris väljale lineNumbers salvestatud väärtuse. Registreerige tagasihelistusfunktsioon kolme aktsepteeritud argumendiga (add_filter viimane argument), vastasel juhul edastab WordPress ainult väärtuse.

  • $value: välja lahendatud väärtus kujul, mille mall saab kui $a[$key]. Tagastage väärtus, mille mall peaks saama.
  • $key: välja võti, nagu seda kasutatakse $a. Kordaja reas on see rea sees oleva välja ID.
  • $block: ploki andmemassiiv, mille mallid saavad kujul $block või $b, koos id, name, postId, postType, index, indexTotal, context ja saare lippudega. Laienduste puhul, mida rakendatakse plokile, mis ei ole Blockstudio-plokk, sisaldab $block ainult blockstudio kirjet (attributes ja disabled) ning sellel puudub name.

Filter käivitub ka atribuutide puhul, mis pole Blockstudio väljad, näiteks className ja anchor, ning failivälja kaasvälja <id>__size puhul. Seetõttu kontrollige enne väärtuse muutmist $key. Tagastusväärtus asendab ainult $key väärtuse; filter ei saa lisada uusi võtmeid hulka $a.

Kasutage definitsioonifiltrit välja konfiguratsiooni muutmiseks ning renderdusfiltrit malliväärtuste arvutamiseks või päringu jaoks ülekirjutamiseks.

Kui väärtusi loetakse renderdamise asemel funktsiooniga bs_block_values(), saab see filter argumendis $block ainult ploki nime. Renderduskordajaid ega muud ainult renderdamise ajal loodavat metaandmestikku see abifunktsioon ei loo.