Към съдържанието

Филтриране на атрибути

Blockstudio предоставя два метода за филтриране на атрибутите на блокове.

Дефиниции на атрибути

blockstudio/blocks/attributes филтрира дефиницията на всяко поле, а Blockstudio създава и регистрира блок. Използвайте го, за да коригирате контролите в редактора, стойностите по подразбиране, условията, опциите и дефиницията, използвана за валидиране на стойностите при извеждане.

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

Горният код задава стойността по подразбиране на lineNumbers като true и скрива полето, освен ако language не е зададено на css.

При всяко извикване обратното извикване получава дефиницията на едно поле, включително вложените полета от групи и повторители. То се изпълнява при регистрацията на блока, а не при всяко извеждане във фронтенда.

Филтрираните дефиниции на опциите се използват и от картата на атрибутите при извеждане. Например опция, добавена към поле select, radio или checkbox, е налична в редактора и остава валидна, когато Blockstudio разрешава записаната стойност за шаблон:

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

Изведени стойности

blockstudio/blocks/attributes/render филтрира разрешената стойност на едно поле непосредствено преди подаването ѝ към шаблона на блока. Изпълнява се веднъж за всяко поле, така че обратното извикване получава стойността, ключа на полето и данните на блока.

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

Примерът по-горе заменя всяка стойност, запазена в редактора за lineNumbers. Регистрирайте обратното извикване с три приети аргумента (последния аргумент на add_filter), в противен случай WordPress подава само стойността.

  • $value: разрешената стойност на полето във вида, в който шаблонът я получава като $a[$key]. Върнете стойността, която шаблонът трябва да получи.
  • $key: ключът на полето, както се използва в $a. В ред на повтарящо се поле това е ID на полето в реда.
  • $block: масивът с данни на блока, който шаблоните получават като $block или $b, с id, name, postId, postType, index, indexTotal, context и флаговете на острова. За разширения, приложени към блок, който не е блок Blockstudio, $block съдържа само записа blockstudio (attributes и disabled) и няма name.

Филтърът се изпълнява и за атрибути, които не са полета Blockstudio, като className и anchor, както и за съпътстващия елемент <id>__size на поле за файлове, затова проверете $key, преди да промените стойност. Върнатата стойност заменя само стойността на $key; филтърът не може да добавя нови ключове към $a.

Използвайте филтъра за дефиниции, когато променяте конфигурацията на полетата, а филтъра за визуализиране, когато изчислявате или заменяте стойностите на шаблона за дадена заявка.

Когато стойностите се четат чрез bs_block_values(), вместо да се визуализират, този филтър получава само името на блока в $block. Помощникът не създава броячи за визуализиране и други метаданни, налични само при визуализиране.