Добавить обработчик на время запроса EventManager::addEventHandler

Модуль: main — подключать отдельно не нужно

Метод EventManager::addEventHandler добавляет обработчик события до конца текущего запроса. Обработчик получает объект события Bitrix\Main\Event. Метод не сохраняет обработчик в базе данных, поэтому вызывайте его в каждом запросе, например в init.php.

Функция AddEventHandler классического API вызывает не этот метод, а addEventHandlerCompatible.

Сигнатура метода в классе Bitrix\Main\EventManager:

public function addEventHandler($fromModuleId, $eventType, $callback, $includeFile = false, $sort = 100)

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
fromModuleId* string Задает код модуля, который отправляет событие, например main
eventType* string Задает имя события, например OnAfterUserAdd. Регистр не важен
callback* callable Задает обработчик — функцию, замыкание или массив [класс, метод]
includeFile string, false Задает полный путь к файлу, который метод send подключит перед вызовом обработчика, если файл существует. По умолчанию — false
sort int Задает порядок вызова. Метод send вызывает обработчик с меньшим значением раньше. По умолчанию — 100

Типы в таблице описывают назначение аргументов. Сигнатура PHP не объявляет их.

Возвращаемое значение

Метод возвращает целочисленный ключ обработчика. Передайте ключ в removeEventHandler, чтобы удалить обработчик.

Примеры

Пример. Код добавляет обработчик своего события, отправляет событие и выводит параметр:

<?php
use Bitrix\Main\Event;
use Bitrix\Main\EventManager;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

EventManager::getInstance()->addEventHandler(
    'main',
    'OnDemoUnitCreate',
    function (Event $event)
    {
        echo 'Created unit ' . $event->getParameter('code');
    }
);

(new Event('main', 'OnDemoUnitCreate', ['code' => 'kg']))->send();

Код выведет Created unit kg.

Смотрите также