Ugrás a tartalomhoz

Attribútumok szűrése

A(z) Blockstudio két módszert biztosít a blokkattribútumok szűrésére.

Attribútumdefiníciók

A(z) blockstudio/blocks/attributes minden meződefiníciót szűr, míg a(z) Blockstudio felépíti és regisztrálja a blokkot. Ezzel módosíthatja a szerkesztő vezérlőit, az alapértékeket, a feltételeket, a beállításokat és az értékek renderelés közbeni ellenőrzéséhez használt definíciót.

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

A fenti kód a(z) lineNumbers alapértelmezett értékét true értékre állítja, és elrejti a mezőt, hacsak a(z) language értéke nem css.

A visszahívás minden híváskor egy meződefiníciót kap, beleértve a beágyazott csoport- és ismétlőmezőket is. A blokk regisztrálásakor fut le, nem minden egyes frontend-rendereléskor.

A szűrt beállításdefiníciókat a renderelési attribútumtérkép is használja. Például egy select, radio vagy checkbox mezőhöz hozzáadott beállítás elérhető a szerkesztőben, és érvényes marad, amikor a(z) Blockstudio egy sablonhoz feloldja a mentett értéket:

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

Renderelt értékek

A blockstudio/blocks/attributes/render közvetlenül azelőtt szűri egy mező feloldott értékét, hogy az átadásra kerülne a blokk sablonjának. Minden mezőnél egyszer fut le, ezért a visszahívás megkapja az értéket, a mező kulcsát és a blokk adatait.

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

A fenti példa felülírja a szerkesztőben a lineNumbers mezőhöz mentett értéket. A visszahívást három elfogadott argumentummal regisztrálja (ez a add_filter utolsó argumentuma), különben a WordPress csak az értéket adja át.

  • $value: a mező feloldott értéke abban a formában, ahogyan a sablon $a[$key] értékként megkapja. A sablonnak szánt értéket adja vissza.
  • $key: a mező kulcsa, ahogyan a $a használja. Ismétlősoron belül ez a sorban lévő mező azonosítója.
  • $block: a blokk adattömbje, amelyet a sablonok $block vagy $b értékként kapnak meg, továbbá tartalmazza a id, name, postId, postType, index, indexTotal, context értéket és az island jelzőket. A nem Blockstudio blokkra alkalmazott bővítmények esetén a $block csak a blockstudio bejegyzést tartalmazza (attributes és disabled), és nincs benne name.

A szűrő olyan attribútumoknál is lefut, amelyek nem Blockstudio mezők, például a className és a anchor esetén, valamint egy fájlmező <id>__size kiegészítőjénél is, ezért érték módosítása előtt hasonlítsa össze a $key értékét. A visszatérési érték csak a $key értékét helyettesíti; a szűrő nem adhat hozzá új kulcsokat a $a értékhez.

A definíciós szűrőt a mező konfigurációjának módosításához, a megjelenítési szűrőt pedig a sablonértékek kérésenkénti kiszámításához vagy felülírásához használja.

Ha az értékeket megjelenítés helyett a bs_block_values() segítségével olvassa be, ez a szűrő csak a blokk nevét kapja meg a $block értékben. Ez a segédfüggvény nem hoz létre megjelenítésszámlálókat és más, csak megjelenítéskor létrejövő metaadatokat.