usam_register_htmlblock в интернет-магазине

Регистрирует HTML блок

Возвращает

Массив если блок зарегистрирован.

Использование

usam_register_htmlblock( $name, $args )

$name(строка) (обязательно)
Код блока.
По умолчанию: нет

$args (массив) (обязательно)
Массив данных блока.
По умолчанию: нет

Структура массива $args

$render (строка) (обязательно)
Файл, который будет выводить блок
По умолчанию: нет

$icon (строка) (обязательно)
Иконка для блока из каталога Universam из файла sprite.svg
По умолчанию: нет

$html_name(строка) (обязательно)
Название блока
По умолчанию: нет

$options (массив) (не обязательно)
Массив настроек блока, которые может выбрать менеджер в разделе Настройки.
По умолчанию: нет

$content_style (строка) (не обязательно)
Массив настроек блока, которые может выбрать менеджер в разделе Стили элементов
По умолчанию: нет

$group (строка) (обязательно)
Код группы
По умолчанию: нет

Возможные типы опций

В массиве $options или $content_style можно указывать разные типы опций, т. е их отображения. Тип опций для указываются в field_type. Например, тип текстовое поле

['field_type' => 'text', 'name' => __('Текст заголовка', 'usam'), 'code' => 'text', 'value' => '']

$field_type (строка) (обязательно)
Тип опции. Доступно text, textarea, select, buttons, route, one_checkbox, color, size-css. Подробнее смотри на странице «Типы опций«

$name (строка) (обязательно)
Название опции

$code (строка) (обязательно)
Код опции, по этому коду будут получаться данные при рендеринге.

$value (строка, массив) (не обязательно)
Значение по умолчанию

Описание опции route

Опция route позволяет получать данные из базы и выбирать их потом как в обычном списке select. Например, получим баннеры

['field_type' => 'route', 'name' => __('Выберите баннеры и слайдеры', 'usam'), 'route' => 'banners', 'code' => 'ids', 'value' => [], 'multiple' => 1],

$route (строка) (обязательно)
Маршрут к API для получения данных

$multiple (число) (не обязательно)
Нужно выбирать несколько, то укажите multiple = 1

Пример

Получить фактический адрес компании.

usam_register_htmlblock('header', [
   'render' => USAM_FILE_PATH . "/includes/block/htmlblocks/header/index.php",	
   'icon' => 'header',	
   'html_name' => __('Заголовок', 'usam'), // Имя блока для администратора
   'options' => [ // список опций блока
      ['field_type' => 'text', 'name' => 'Текст заголовка', 'code' => 'text', 'value' => ''],
      ['field_type' => 'select', 'name' => 'Тег названия', 'code' => 'tag_name', 'options' => ['h1' => 'h1', 'h2' => 'h2', 'h3' => 'h3', 'h4' => 'h4', 'div' => 'div'], 'value' => 'h3'],		
	],
   'content_style' => [ // стили для блока		
      ['field_type' => 'select', 'name' => 'Выравнивание заголовка', 'code' => 'align', 'value' => 'left', 'options' => 
         [
            ['id' => 'left', 'name' => __('Влево', 'usam')],
            ['id' => 'center', 'name' => __('Центр', 'usam')],
            ['id' => 'right', 'name' => __('Вправо', 'usam')]
         ]
       ],
    ],
   'group' => 'theme'	
]);