xandeadx.ru Блог музицирующего веб-девелопера

Drupal → Как добавить настройки к блоку, созданному в стороннем модуле (8)

Пример добавления чекбокса в форму настройки всех блоков меню:

// MODULENAME.module
 
/**
 * Implements hook_form_FORM_ID_alter(): block_form.
 */
function MODULENAME_form_block_form_alter(array &$form, FormStateInterface $form_state): void {
  $block_config = $form_state->getFormObject()->getEntity(); /** @var BlockInterface $block_config */
  $block_plugin = $block_config->getPlugin(); /** @var BlockPluginInterface $block_plugin */
 
  if ($block_plugin instanceof SystemMenuBlock) {
    $form['third_party_settings']['MODULENAME']['nofollow'] = [
      '#type' => 'checkbox',
      '#title' => t('Use rel="nofollow"'),
      '#default_value' => $block_config->getThirdPartySetting('MODULENAME', 'nofollow'),
    ];
  }
}
# config/schema/MODULENAME.schema.yml
 
block.block.*.third_party.MODULENAME:
  type: mapping
  label: 'Third party settings'
  mapping:
    nofollow:
      type: boolean
      title: 'Use rel="nofollow"'

Всё, что находится в $form['third_party_settings'], при сохранении автоматически попадёт в third party settings конфига блока.

Можно вручную прописывать значения конфигу:

// MODULENAME.module
 
/**
 * Implements hook_form_FORM_ID_alter(): block_form.
 */
function MODULENAME_form_block_form_alter(array &$form, FormStateInterface $form_state): void {
  $block_config = $form_state->getFormObject()->getEntity(); /** @var BlockInterface $block_config */
  $block_plugin = $block_config->getPlugin(); /** @var BlockPluginInterface $block_plugin */
 
  if ($block_plugin instanceof SystemMenuBlock) {
    $form['nofollow'] = [
      '#type' => 'checkbox',
      '#title' => t('Use rel="nofollow"'),
      '#default_value' => $block_config->getThirdPartySetting('MODULENAME', 'nofollow'),
    ];
 
    $form['#entity_builders'][] = 'MODULENAME_block_form_entity_builder';
  }
}
 
/**
 * Block form entity builder.
 */
function MODULENAME_block_form_entity_builder(string $entity_type, BlockInterface $block_config, array &$form, FormStateInterface $form_state): void {
  $block_config->setThirdPartySetting('MODULENAME', 'nofollow', (bool)$form_state->getValue('nofollow'));
}

Версия для Drupal 7.
Статья об анатомии блоков (чем отличается $block_config от $block_plugin).

Написанное актуально для Drupal 8+
Похожие записи

Комментарии RSS

Amazing post. Thank you for your contribution.

Оставить комментарий

Содержимое этого поля является приватным и не будет отображаться публично. Если у вас есть аккаунт в Gravatar, привязанный к этому e-mail адресу, то он будет использован для отображения аватара.
  • Адреса страниц и электронной почты автоматически преобразуются в ссылки.
  • Доступные HTML теги: <a> <i> <b> <strong> <code> <ul> <ol> <li> <blockquote> <em> <s>
  • Строки и параграфы переносятся автоматически.
  • Подсветка кода осуществляется с помощью тегов: <code>, <css>, <html>, <ini>, <javascript>, <sql>, <php>. Поддерживаемые стили выделения кода: <foo>, [foo].

Подробнее о форматировании