Получить группы пользователя UserTable::getUserGroupIds

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

Метод UserTable::getUserGroupIds возвращает идентификаторы групп, в которые входит пользователь. В список попадают и группы, которые действуют для всех посетителей сайта, в том числе неавторизованных.

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

public static function getUserGroupIds($userId): array

Параметры

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

Параметр Тип Описание
userId* int Задает идентификатор пользователя. Для 0 метод возвращает только группы для всех посетителей

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

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

Метод возвращает массив целых чисел без повторов, отсортированный по возрастанию. В массив входят:

  • активные анонимные группы — группы, у которых поле ANONYMOUS равно Y,
  • группа с идентификатором 2 — «Все пользователи (в том числе неавторизованные)», метод всегда добавляет ее,
  • активные группы пользователя, если userId больше нуля.

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

Особенности

Метод кеширует список анонимных групп на 86 400 секунд. Метод читает группы пользователя из базы данных при каждом вызове.

Примеры

Пример. Код выводит группы пользователя с идентификатором 1:

<?php
use Bitrix\Main\UserTable;

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

$groupIds = UserTable::getUserGroupIds(1);

echo implode(', ', $groupIds);

Метод CUser::GetUserGroup возвращает активные группы пользователя и группу 2, но не добавляет анонимные группы. Метод запоминает результат до конца запроса.

Пример. Код выводит группы пользователя с идентификатором 1 через CUser:

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

$groupIds = CUser::GetUserGroup(1);

echo implode(', ', $groupIds);

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