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

AddToUserGroup

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

bool
CBlogUser::AddToUserGroup(
	int    ID,
	int    blogID,
	array  arGroups = array(),
	string joinStatus = "Y",
	int    selectType = BLOG_BY_BLOG_USER_ID,
	int    action = BLOG_CHANGE
);

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

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

ПараметрОписание
ID Идентификатор пользователя.
blogID Идентификатор блога.
arGroups Массив идентификаторов групп пользователей блога, к которым необходимо привязать пользователя. Необязательный параметр.
joinStatus Необязательный. Значение по умолчанию - "Y". Параметр временно не используется.
selectType По какому идентификатору искать пользователя. Возможные значения:
  • BLOG_BY_USER_ID - по идентификатору пользователя сайта;
  • BLOG_BY_BLOG_USER_ID - по идентификатору пользователя блога.
Необязательный. По умолчанию BLOG_BY_BLOG_USER_ID - по идентификатору пользователя блога.
action Совершаемое действие. Возможные значения:
  • BLOG_ADD - добавление пользователя в группы;
  • BLOG_CHANGE - изменение уже существующих привязок.
Необязательный. По умолчанию BLOG_CHANGE - изменение уже существующих привязок.

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

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

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

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


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

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

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

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

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