Виджеты в Yii — это как конструктор Lego: собрал один раз, а используешь в разных местах. Но что, если готовых деталей не хватает? Тогда на помощь приходят кастомные виджеты. В этой статье разберём, как создать свой виджет с нуля, настроить его параметры и встроить в представления. Будет практично и без лишней теории.
Что такое виджет в Yii и зачем он нужен
Виджет — это переиспользуемый блок кода, который инкапсулирует логику отображения. В Yii виджеты обычно наследуются от yii\base\Widget и могут принимать параметры. Они помогают не дублировать HTML и PHP-код, делая шаблоны чище. Например, вы можете сделать виджет для вывода последних новостей, меню или формы подписки.
Стандартные виджеты Yii (например, ActiveForm, GridView) — это мощные инструменты, но иногда нужен свой. Создание кастомного виджета — процесс простой, если следовать шагам.
Создаём простой виджет: шаг за шагом
Начнём с классики — виджета, который выводит приветствие с именем пользователя. Создадим файл HelloWidget.php в папке widgets (можно в любом месте, но принято хранить в components или widgets).
render('hello', ['name' => $this->name]);
}
}
Теперь создадим шаблон hello.php в папке views нашего виджета (по умолчанию Yii ищет представления в widgets/views).
Использовать виджет можно в любом представлении:
= \app\widgets\HelloWidget::widget(['name' => 'Иван']) ?>
Всё просто: класс наследует Widget, переопределяет run() и рендерит шаблон. Параметры передаются через публичные свойства.
Продвинутые возможности: параметры, шаблоны, кэширование
Виджет можно сделать гибче, добавив настройки. Например, пусть виджет выводит список элементов с заголовком. Добавим свойства $title и $items.
class ListWidget extends Widget
{
public $title = 'Список';
public $items = [];
public $encode = true;
public function run()
{
return $this->render('list', [
'title' => $this->title,
'items' => $this->items,
'encode' => $this->encode,
]);
}
}
Шаблон list.php:
= Html::encode($title) ?>
- = $encode ? Html::encode($item) : $item ?>
Вызов:
= \app\widgets\ListWidget::widget([
'title' => 'Фрукты',
'items' => ['Яблоко', 'Груша', 'Апельсин'],
]) ?>
Если виджет тяжёлый, можно закэшировать его вывод. Для этого используйте beginCache() и endCache() или настройте кэширование внутри run().
Html::encode(), если не уверены в их безопасности. Это защитит от XSS-атак.
Использование виджетов в разных контекстах
Виджеты можно вызывать не только в представлениях, но и внутри других виджетов, а также в контроллерах (хотя последнее не рекомендуется). Также можно использовать Widget::begin() и Widget::end() для обёртки контента.
Пример с begin():
'Заголовок панели']); ?>
Содержимое панели
Внутри виджета нужно реализовать методы init() и run() так, чтобы begin() открывал контейнер, а end() его закрывал. Для этого в init() можно вывести открывающий тег, а в run() — закрывающий.
Сравнение подходов: когда что использовать
Виджеты — не единственный способ переиспользования кода. Иногда лучше подходят хелперы или компоненты. Вот таблица для сравнения.
| Инструмент | Когда использовать | Пример |
|---|---|---|
| Виджет | Нужен переиспользуемый блок с HTML и логикой | Меню, форма, список |
| Хелпер | Только генерация HTML или утилиты без состояния | Html::a(), Url::to() |
| Компонент | Бизнес-логика, сервисы, работа с данными | Отправка email, обработка платежей |
Что в итоге
Создание кастомных виджетов в Yii — задача, с которой справится даже новичок. Главное — понять структуру: класс-наследник Widget, метод run() и шаблон. Виджеты помогают избежать дублирования кода и сделать проект чище. Экспериментируйте, добавляйте параметры, кэшируйте — и ваши представления станут лёгкими и удобными.
Не бойтесь заглядывать в исходники стандартных виджетов Yii — это лучший способ научиться новым приёмам.

