CIBlockElement::GetList в Битрикс: полное руководство

Что такое CIBlockElement::GetList

• получения списка товаров;
• вывода новостей;
• фильтрации элементов инфоблоков;
• построения каталогов;
• выборки данных для компонентов.

Синтаксис CIBlockElement::GetList

CIBlockElement::GetList(
    array $arOrder,
    array $arFilter,
    bool|array $arGroupBy = false,
    bool|array $arNavStartParams = false,
    array $arSelectFields = []
);

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

1. $arOrder — сортировка

$arOrder = [
    "SORT" => "ASC",
    "ID" => "DESC"
];

• ID
• NAME
• SORT
• TIMESTAMP_X
• ACTIVE_FROM

2. $arFilter — фильтрация

$arFilter = [
    "IBLOCK_ID" => 5,
    "ACTIVE" => "Y"
];

• IBLOCK_ID — ID инфоблока
• ACTIVE — активность
• ID — конкретный элемент
• SECTION_ID — раздел
• NAME — название
• PROPERTY_* — свойства

3. $arGroupBy — группировка

$arGroupBy = false;

["ID"]

4. $arNavStartParams — постраничная навигация

$arNavStartParams = [
    "nPageSize" => 10
];

• iNumPage
• bShowAll
• NavShowAlways

5. $arSelectFields — выбираемые поля

$arSelectFields = [
    "ID",
    "NAME",
    "IBLOCK_ID",
    "DETAIL_PAGE_URL"
];

• PROPERTY_* (свойства)
• PREVIEW_TEXT
• DETAIL_TEXT

Простой пример CIBlockElement::GetList

CModule::IncludeModule("iblock");

$res = CIBlockElement::GetList(
    ["ID" => "DESC"],
    ["IBLOCK_ID" => 5, "ACTIVE" => "Y"],
    false,
    ["nPageSize" => 10],
    ["ID", "NAME", "DETAIL_PAGE_URL"]
);

while ($item = $res->GetNext())
{
    echo $item["NAME"] . "<br>";
}

Получение элемента по ID

$arFilter = [
    "ID" => 123,
    "IBLOCK_ID" => 5
];

$res = CIBlockElement::GetList([], $arFilter);

if ($item = $res->GetNext())
{
    print_r($item);
}

Работа со свойствами

["ID", "NAME", "PROPERTY_PRICE", "PROPERTY_COLOR"]

$res = CIBlockElement::GetList(
    [],
    ["IBLOCK_ID" => 5],
    false,
    false,
    ["ID", "NAME", "PROPERTY_PRICE"]
);

Использование пагинации

$res = CIBlockElement::GetList(
    ["ID" => "DESC"],
    ["IBLOCK_ID" => 5],
    false,
    ["nPageSize" => 20],
    ["ID", "NAME"]
);

Частые ошибки CIBlockElement::GetList

1. Не подключен модуль iblock

Class 'CIBlockElement' not found

CModule::IncludeModule("iblock");

2. Пустой результат

• неверный IBLOCK_ID;
• фильтр ACTIVE = "Y";
• отсутствие элементов.

3. Неправильный выбор полей

["ID", "NAME"] // и нет PROPERTY_PRICE

4. Перегрузка запроса

• запрос внутри цикла;
• отсутствие кеширования;
• выборка всех полей (*).

5. Медленная работа

• нет индексов;
• фильтр по PROPERTY_* без оптимизации;
• слишком большие инфоблоки.

Оптимизация CIBlockElement::GetList

• всегда указывать IBLOCK_ID;
• выбирать только нужные поля;
• использовать кеширование;
• избегать "*" в SELECT;
• не делать запросы в цикле;
• использовать D7 ORM для больших проектов.

CIBlockElement::GetList vs D7 ORM

Пример с фильтром по свойству

$arFilter = [
    "IBLOCK_ID" => 5,
    "ACTIVE" => "Y",
    "PROPERTY_COLOR" => "red"
];

$res = CIBlockElement::GetList(
    ["ID" => "DESC"],
    $arFilter,
    false,
    false,
    ["ID", "NAME"]
);

Заключение

Похожие статьи

CIBlockElement::SetPropertyValues в Битрикс — установка значений свойств элементаCIBlockElement::GetProperty в Битрикс — получение свойств элемента инфоблокаCIBlockElement::Delete в Битрикс — удаление элемента инфоблокаCIBlockElement::Update в Битрикс — обновление элемента инфоблока