1C-Битрикс: Управление сайтом

OnBeforeGroupAdd

bool
EventHandler(
 array &arFields
);

Событие вызывается в методе CGroup::Add до добавления группы, и может быть использовано для отмены добавления или переопределения некоторых полей.

Примечание: событие добавлено в ядре 9.5.8.

Параметры метода

Параметр Описание
arFields Список полей (класс CGroup) добавляемой группы пользователей.

Параметр arFields данного обработчика является ссылкой на исходные переменные. Поэтому если изменить значение параметра внутри обработчика, это приведет к смене значения исходной переменной, поступившей на вход функции-обработчика.

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

Для отмены добавления группы и прекращении выполнения метода CGroup::Add необходимо в функции-обработчике создать исключение методом $APPLICATION->ThrowException() и вернуть false.

См. также

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

<?
AddEventHandler("main", "OnBeforeGroupAdd", "MyOnBeforeGroupAdd");
function MyOnBeforeGroupAdd(&$arFields)
{
if($arFields["DESCRIPTION"] == '')
$arFields["DESCRIPTION"] = "Описание группы";
}
?>

Пользовательские комментарии

Пользовательские комментарии не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Добавлять комментарии могут только зарегистрированные пользователи. Сообщения для просмотра появляются после модерации.
© «Битрикс», 2001-2012, «1C-Битрикс», 2012