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

DeleteFromUserGroup

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

bool
CBlogUser::DeleteFromUserGroup(
	int ID,
	int blogID,
	int selectType = BLOG_BY_BLOG_USER_ID,
);

Метод удаляет пользователя с идентификатором ID из всех групп пользователей блога blogID. Метод статический.

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

ПараметрОписание
ID Идентификатор пользователя.
blogID Идентификатор блога.
selectType По какому идентификатору искать пользователя. Возможные значения:
  • BLOG_BY_USER_ID - по идентификатору пользователя сайта;
  • BLOG_BY_BLOG_USER_ID - по идентификатору пользователя блога.
Необязательный. По умолчанию BLOG_BY_BLOG_USER_ID - по идентификатору пользователя блога.

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

Метод возвращает true в случае успешного удаления пользователя из групп, в противном случае возвращает false, а в исключениях будут содержаться ошибки.

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

<?
// удалим текущего пользователя из всех групп пользователей блога с ID = 1
$ID = $USER->GetID();
if(!CBlogUser::DeleteFromUserGroup($ID, 1, BLOG_BY_USER_ID))
{
	if ($ex = $APPLICATION->GetException())
		echo $ex->GetString();
}
else
{
	echo 'Пользователь ['.$ID.'] удален из групп пользователей блога';
}
?>


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

Мы будем рады, если разработчики добавят свои комментарии по практическому использованию методов системы.

Для этого нужно всего лишь авторизоваться на сайте

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх