Перейти к содержимому

Фильтрация атрибутов

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. В строке репитера это идентификатор поля внутри строки.
  • $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 только имя блока. Этот помощник не создает счетчики рендеринга и другие метаданные, доступные только при рендеринге.