GetList

• id - ID элемента. Может принимать значения:
  • asc - по возрастанию;
  • desc - по убыванию;
  • массив ID - в этом случае элементы будут выводиться в том порядке, в котором они перечислены в массиве. (С версии 18.6.700)
    Важно! Этот же массив должен быть передан в фильтр (параметр arFilter).

• sort - индекс сортировки;
• timestamp_x - дата изменения;
• name - название;
• date_active_from - начало периода действия элемента;
• date_active_to - окончание периода действия элемента;
• status - код статуса элемента в документообороте;
• code - символьный код элемента;
• iblock_id - числовой код информационного блока;
• modified_by - код последнего изменившего пользователя;
• active - признак активности элемента;
• show_counter - количество показов элемента (учитывается методом CIBlockElement::CounterInc);
• show_counter_start - время первого показа элемента (учитывается методом CIBlockElement::CounterInc);
• shows - усредненное количество показов (количество показов / продолжительность показа);
• rand - случайный порядок;
• xml_id или external_id - внешний код;
• tags - теги;
• created - время создания;
• created_date - дата создания без учета времени;
• cnt - количество элементов (только при заданной группировке);
  
• property_<PROPERTY_CODE> - по значению свойства с числовым или символьным кодом PROPERTY_CODE (например, PROPERTY_123 или PROPERTY_NEWS_SOURCE);
• propertysort_<PROPERTY_CODE> - по индексу сортировки варианта значения свойства. Только для свойств типа "Список" ;
• catalog_<CATALOG_FIELD>_<PRICE_TYPE> - по полю CATALOG_FIELD (может быть PRICE - цена, CURRENCY - валюта или PRICE_SCALE - цена с учетом валюты) из цены с типом PRICE_TYPE (например, catalog_PRICE_1 или CATALOG_CURRENCY_3). С версии 16.0.3 модуля Торговый каталог сортировка по цене также идет с учетом валюты.
• IBLOCK_SECTION_ID - ID раздела;
• *CATALOG_QUANTITY - общее количество товара;
• *CATALOG_WEIGHT - вес товара;
• *CATALOG_AVAILABLE - признак доступности товара (Y|N). Товар считается недоступным, если его количество меньше либо равно нулю, включен количественный учет и запрещена покупка при нулевом количестве.
• *CATALOG_STORE_AMOUNT_<идентификатор_склада> - сортировка по количеству товара на конкретном складе (доступно с версии 15.5.5 модуля Торговый каталог).
• *CATALOG_BUNDLE - сортировка по наличию набора у товара (доступно с версии 16.0.3 модуля Торговый каталог).
• PROPERTY_<PROPERTY_CODE>.<FIELD> - по значению поля элемента указанного в качестве привязки. PROPERTY_CODE - символьный код свойства типа привязка к элементам. FIELD может принимать значения:
  • ID
  • TIMESTAMP_X
  • MODIFIED_BY
  • CREATED
  • CREATED_DATE
  • CREATED_BY
  • IBLOCK_ID
  • ACTIVE
  • SORT
  • NAME
  • SHOW_COUNTER
  • SHOW_COUNTER_START
  • CODE
  • TAGS
  • XML_ID
  • STATUS
• PROPERTY_<PROPERTY_CODE>.PROPERTY_<PROPERTY_CODE2> - по значению свойства элемента указанного в качестве привязки. PROPERTY_CODE - символьный код свойства типа привязки к элементам. PROPERTY_CODE2- код свойства связанных элементов.
• HAS_PREVIEW_PICTURE и HAS_DETAIL_PICTURE - сортировка по наличию и отсутствию картинок.
• order - порядок сортировки, пишется без пробелов, может принимать значения:
  • asc - по возрастанию;
  • nulls,asc - по возрастанию с пустыми значениями в начале выборки;
  • asc,nulls - по возрастанию с пустыми значениями в конце выборки;
  • desc - по убыванию;
  • nulls,desc - по убыванию с пустыми значениями в начале выборки;
  • desc,nulls - по убыванию с пустыми значениями в конце выборки;
    
  Необязательный. По умолчанию равен Array("sort"=>"asc")

• ID - по числовому коду (фильтр Число);
• ACTIVE - фильтр по активности (Y|N); передача пустого значения ("ACTIVE"=>"") выводит все элементы без учета их состояния (фильтр Строка);
• NAME - по названию (фильтр Маска);
• CODE - по символьному идентификатору (фильтр Маска);
• IBLOCK_SECTION_ID - используйте этот ключ только в режиме выбора основного раздела для элемента либо когда все товары привязаны только к одному разделу. Во всех остальных случаях используйте фильтр по SECTION_ID.
• TAGS - по тегам (фильтр Маска);
• XML_ID или EXTERNAL_ID - по внешнему коду (фильтр Маска);
• PREVIEW_TEXT - по анонсу (фильтр Маска);
• PREVIEW_TEXT_TYPE - по типу анонса (html|text, фильтр Строка);
• PREVIEW_PICTURE - коду картинки для анонса (фильтр Число);
• DETAIL_TEXT - по детальному описанию (фильтр Маска);
• DETAIL_TEXT_TYPE - по типу детальному описания (html|text, фильтр Строка);
• DETAIL_PICTURE - по коду детальной картинки (фильтр Число);
• CHECK_PERMISSIONS - если установлен в "Y", то в выборке будет осуществляться проверка прав доступа к информационным блокам. По умолчанию права доступа не проверяются.
• PERMISSIONS_BY - фильтрация по правам произвольного пользователя. Значение - ID пользователя или 0 (неавторизованный).
• *CATALOG_TYPE - фильтрация по типу товара;
• MIN_PERMISSION - минимальный уровень доступа, будет обработан только если CHECK_PERMISSIONS установлен в "Y". По умолчанию "R". Список прав доступа см. в CIBlock::SetPermission().
• SEARCHABLE_CONTENT - по содержимому для поиска. Включает в себя название, описание для анонса и детальное описание (фильтр Маска);
• SORT - по сортировке (фильтр Число);
• TIMESTAMP_X - по времени изменения (фильтр Дата);
• DATE_MODIFY_FROM - по времени изменения. Будут выбраны элементы измененные после времени указанного в фильтре. Время указывается в формате сайта. Возможно использовать операцию отрицания "!DATE_MODIFY_FROM";
• DATE_MODIFY_TO - по времени изменения. Будут выбраны элементы измененные ранее времени указанного в фильтре. Время указывается в формате сайта. Возможно использовать операцию отрицания "!DATE_MODIFY_TO";
• MODIFIED_USER_ID или MODIFIED_BY - по коду пользователя, изменившего элемент (фильтр Число);
• DATE_CREATE - по времени создания (фильтр Дата);
• CREATED_USER_ID или CREATED_BY - по коду пользователя, добавившего элемент (фильтр Число);
• DATE_ACTIVE_FROM - по дате начала активности (фильтр Дата) Формат даты должен соответствовать формату даты, установленному на сайте. Чтобы выбрать элементы с пустым полем начала активности, следует передать значение false;
• DATE_ACTIVE_TO - по дате окончания активности (фильтр Дата)Формат даты должен соответствовать формату даты, установленному на сайте. Чтобы выбрать элементы с пустым полем окончания активности, следует передать значение false;
• ACTIVE_DATE - непустое значение задействует фильтр по датам активности. Будут выбраны активные по датам элементы.Если значение не установлено (""), фильтрация по датам активности не производится;
  Чтобы выбрать все не активные по датам элементы, используется такой синтаксис:

  $el_Filter[ "!ACTIVE_DATE" ]= "Y";

• IBLOCK_ID - по коду информационного блока (фильтр Число);
  
  При использовании инфоблоков 1.0 можно в IBLOCK_ID передать массив идентификаторов, чтобы сделать выборку из элементов нескольких инфоблоков:
  

  $arFilter = array("IBLOCK_ID" => array(1, 2, 3), ...);

  Для инфоблоков 2.0 такая выборка будет работать только в том случае, если в ней не запрашиваются свойства элементов.

  В некоторых случаях точное указание IBLOCK_ID в фильтре может ускорить выборку элементов. Так как зависимости сложные, каждый конкретный случай надо рассматривать отдельно.

• IBLOCK_CODE - по символьному коду информационного блока (фильтр Маска);
• IBLOCK_SITE_ID или IBLOCK_LID или SITE_ID или LID - по сайту (фильтр Строка);
• IBLOCK_TYPE - по типу информационного блока (фильтр Маска);
• IBLOCK_ACTIVE - по активности информационного блока (Y|N, фильтр Строка);
• SECTION_ID - по родительской группе. Если значение фильтра false, "" или 0, то будут выбраны элементы не привязанные ни к каким разделам. Иначе будут выбраны элементы привязанные к заданному разделу. Значением фильтра может быть и массив. В этом случае будут выбраны элементы привязанные хотя бы к одному из разделов указанных в фильтре. Возможно указание отрицания "!". В этом случае условие будет инвертировано;
• SECTION_CODE - по символьному коду родительской группы. Аналогично SECTION_ID;
• INCLUDE_SUBSECTIONS - если задан фильтр по родительским группам SECTION_ID, то будут также выбраны элементы находящиеся в подгруппах этих групп (имеет смысле только в том случае, если SECTION_ID > 0);
• SUBSECTION  - по принадлежности к подразделам раздела. Значением фильтра может быть массив из двух элементов задающих левую и правую границу дерева разделов. Операция отрицания поддерживается.
• SECTION_ACTIVE - если ключ есть в фильтре, то проверяется активность групп к которым привязан элемент.
• SECTION_GLOBAL_ACTIVE - аналогично предыдущему, но учитывается также активность родительских групп.
• SECTION_SCOPE - задает уточнение для фильтров SECTION_ACTIVE и SECTION_GLOBAL_ACTIVE. Если значение "IBLOCK", то учитываются только привязки к разделам инфоблока. Если значение "PROPERTY", то учитываются только привязки к разделам свойств. "PROPERTY_" - привязки к разделам конкретного свойства.
• *CATALOG_AVAILABLE - признак доступности товара (Y|N). Товар считается недоступным, если его количество меньше либо равно нулю, включен количественный учет и запрещена покупка при нулевом количестве;
• *CATALOG_CATALOG_GROUP_ID_N - по типу цен;
• *CATALOG_SHOP_QUANTITY_N - фильтрация по диапазону количества в цене;
• *CATALOG_QUANTITY - по общему количеству товара;
• *CATALOG_WEIGHT - по весу товара;
• *CATALOG_STORE_AMOUNT_<идентификатор_склада> - фильтрация по наличию товара на конкретном складе (доступно с версии 15.0.2 модуля Торговый каталог). В качестве значения фильтр принимает количество товара на складе либо false.
• *CATALOG_PRICE_SCALE_<тип_цены> - фильтрация по цене с учетом валюты (доступно с версии 16.0.3 модуля Торговый каталог).
• *CATALOG_BUNDLE - фильтрация по наличию набора у товара (доступно с версии 16.0.3 модуля Торговый каталог).
• SUBQUERY - массив

  $filter = array("SUBQUERY" => array(
  	"FIELD" => "имя поля",
  	"FILTER" => array(фильтр для отбора предложений)
  ))

  из двух параметров:
  • FIELD - строка, имя поля
  • FILTER - массив, фильтр для отбора предложений.
  Внутри GetList преобразовывается в:

  ID => CIBlockElement::SubQuery($filter['SUBQUERY']['FIELD'], $filter['SUBQUERY']['FILTER'])

  Доступен с версии 21.300.0 модуля iblock.
• SHOW_COUNTER - по количеству показов (фильтр Число);
• SHOW_COUNTER_START - по времени первого показа (фильтр Дата);
• WF_COMMENTS - по комментарию документооборота (фильтр Маска);
• WF_STATUS_ID или WF_STATUS - по коду статуса документооборота (фильтр Число);
• SHOW_HISTORY - если установлен в значение "Y", то вместе с элементами будут выводится и их архив (история), по умолчанию выводятся только опубликованные элементы. Для фильтрации по WF_STATUS_ID SHOW_HISTORY должен стоять в "Y".
• SHOW_NEW - если SHOW_HISTORY не установлен или не равен Y и SHOW_NEW=Y, то будут показываться ещё неопубликованные элементы вместе с опубликованными;
• WF_PARENT_ELEMENT_ID - по коду элемента-родителя в документообороте для выборки истории изменений (фильтр Число);
• WF_NEW - флаг что элемент ещё ни разу не был опубликован (Y|N);
• WF_LOCK_STATUS - статус заблокированности элемента в документооборте (red|green|yellow);
• PROPERTY_<PROPERTY_CODE> - фильтр по значениям свойств, где PROPERTY_CODE - код свойства или символьный код. Для свойств типа "Список", "Число", "Привязка к элементам" и "Привязка к разделам"  - фильтр Число. Для прочих - фильтр Маска;
• PROPERTY_<PROPERTY_CODE>_VALUE - фильтр по значениям списка для свойств типа "список" (фильтр Маска), поиск будет осуществляться по строковому значению списка, а не по идентификатору;
• *CATALOG_<CATALOG_FIELD>_<PRICE_TYPE> - по полю CATALOG_FIELD из цены типа PRICE_TYPE (ID типа цены), где CATALOG_FIELD может быть: PRICE - цена, CURRENCY - валюта.
• PROPERTY_<PROPERTY_CODE>.<FIELD> - фильтр по значениям полей связанных элементов. , где PROPERTY_CODE - ID или символьный код свойства привязки, а FIELD - поле указанного в привязке элемента. FIELD может принимать следующие значения: ACTIVE, DETAIL_TEXT_TYPE, PREVIEW_TEXT_TYPE, EXTERNAL_ID, NAME, XML_ID, TMP_ID, DETAIL_TEXT, SEARCHABLE_CONTENT, PREVIEW_TEXT, CODE, TAGS, WF_COMMENTS, ID, SHOW_COUNTER, WF_PARENT_ELEMENT_ID, WF_STATUS_ID, SORT, CREATED_BY, PREVIEW_PICTURE, DETAIL_PICTURE, IBLOCK_ID, TIMESTAMP_X, DATE_CREATE, SHOW_COUNTER_START, DATE_ACTIVE_FROM, DATE_ACTIVE_TO, ACTIVE_DATE, DATE_MODIFY_FROM, DATE_MODIFY_TO, MODIFIED_USER_ID, MODIFIED_BY, CREATED_USER_ID, CREATED_BY. Правила фильтров идентичны тем, которые описаны выше.
• PRODUCT_BARCODE - по штрихкоду.
• PRODUCT_BARCODE_STORE - по привязке к складу штрихкода.
• PRODUCT_BARCODE_ORDER - по привязке к заказу штрихкода.

• "!" - не равно
• "<" - меньше
• "<=" - меньше либо равно
• ">" - больше
• ">=" - больше либо равно
• "><" - между
• и т.д.

Необязательное. По умолчанию записи не фильтруются.

• nTopCount - ограничить количество сверху. Если задать nTopCount и хранить свойства в общей таблице, то этот параметр ограничивает именно количество запросов. Если есть множественные свойства, то это будет отдельный запрос. То есть чтобы сделать запрос к 2 элементам со множественным свойством из 2 и 3 значений, то nTopCount должен быть равен 5. Решение проблемы: переместить свойства в отдельную таблицу. ;
• nOffset - смещение. Ключ работает только при передаче непустого значения в ключе nTopCount. Доступен с версии iblock 21.700.100;
• bShowAll; - разрешить вывести все элементы при постраничной навигации;
• iNumPage; - номер страницы при постраничной навигации;
• nPageSize; - количество элементов на странице при постраничной навигации;
• nElementID; - ID элемента, который будет выбран вместе со своими соседями. Количество соседей определяется параметром nPageSize. Например: если nPageSize равно 2-м, то будут выбраны максимум 5-ть элементов.  Соседи определяются порядком сортировки, заданным в параметре arOrder (см. выше).
  При этом действуют следующие ограничения:
  • Если элемент с таким ID отсутствует в выборке, то результат будет не определен.
  • nElementID не работает, если задана группировка (см. параметр arGroupBy выше).
  • в параметре arSelect обязательно должно присутствовать поле "ID".
  • обязательно должна быть задана сортировка arOrder.
  • поля в сортировке catalog_* не учитываются, и результат выборки становится не определенным.
  • в выборку добавляется поле RANK - порядковый номер элемента в "полной" выборке.

В списке полей элемента можно сразу выводить значения его свойств. Обязательно должно быть использованы поля IBLOCK_ID и ID, иначе не будет работать корректно. Кроме того, также  в качестве одного из полей необходимо указать PROPERTY_<PROPERTY_CODE>, где PROPERTY_CODE - ID или символьный код (задается в верхнем регистре, даже если в определении свойств инфоблока он указан в нижнем регистре).

В результате будет выведены значения свойств элемента в виде полей PROPERTY_<PROPERTY_CODE>_VALUE - значение; PROPERTY_<PROPERTY_CODE>_ID - код значения у элемента; PROPERTY_<PROPERTY_CODE>_ENUM_ID - код значения (для свойств типа список).

При установленном модуле торгового каталога можно выводить и цены элемента. Для этого в качестве одного из полей необходимо указать *CATALOG_GROUP_<PRICE_CODE>, где PRICE_CODE - ID типа цены.

Также есть возможность выбрать поля элементов по значениям свойства типа "Привязка к элементам". Для этого необходимо указать  PROPERTY_<PROPERTY_CODE>.<FIELD>, где PROPERTY_CODE - ID или символьный код свойства привязки, а FIELD - поле указанного в привязке элемента. См. ниже "Поля связанных элементов для сортировки".

Можно выбрать и значения свойств элементов по значениям свойства типа "Привязка к элементам". Для этого необходимо указать  PROPERTY_<PROPERTY_CODE>.PROPERTY_<PROPERTY_CODE2>, где PROPERTY_CODE - ID или символьный код свойства привязки, а PROPERTY_CODE2 - свойство указанного в привязке элемента.

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