Документация для разработчиков
Темная тема

ExecuteModuleEvent

Описание и параметры

mixed
ExecuteModuleEvent(
 array event,
 mixed param1 = NULL,
 mixed param2 = NULL,
 mixed param3 = NULL,
 mixed param4 = NULL,
 mixed param5 = NULL,
 mixed param6 = NULL,
 mixed param7 = NULL,
 mixed param8 = NULL,
 mixed param9 = NULL,
 mixed param10 = NULL
);

Запускает обработчик события на выполнение. Возвращает то значение, которое возвращает конкретный обработчик события.

Параметры функции

ПараметрОписание С версии
event Массив описывающий одну регистрационную запись хранящую связь между событием и обработчиком этого события (подобные записи хранятсяв таблице b_module_to_module). Ключи данного массива:
  • ID - ID записи
  • TIMESTAMP_X - время изменения записи
  • SORT - сортировка
  • FROM_MODULE_ID - какой модуль инициализирует событие
  • MESSAGE_ID - идентификатор события
  • TO_MODULE_ID - какой модуль содержит обработчик события
  • TO_CLASS - какой класс содержит обработчик события
  • TO_METHOD - метод класса являющийся по сути обработчиком события
param1,
param2,
... ,
param10
Произвольный набор значений, которые передаются в качестве параметров в обработчик события.4.0.6

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

Примеры использования

<?
// проверка возможности удаления форума

// флаг запрещающий или разрешающий удалять форум
$bCanDelete = true;

// получим данные по всем обработчикам события "OnBeforeForumDelete"
// принадлежащего модулю с идентификатором "forum"
$rsEvents = GetModuleEvents("forum", "OnBeforeForumDelete");
while ($arEvent = $rsEvents->Fetch())
{
    // запустим на выполнение очередной обработчик события "OnBeforeForumDelete"
    // если функция-обработчик возвращает false, то
    if (ExecuteModuleEvent($arEvent, $del_id)===false)
    {
        // запрещаем удалять форум
        $bCanDelete = false;
        break;
    }
}
?>


© «Битрикс», 2001-2020, «1С-Битрикс», 2020
Наверх