GetList

Description

CIBlockResult
CIBlockElement::GetList(
 array arOrder = Array("SORT"=>"ASC"),
 array arFilter = Array(),
 mixed arGroupBy = false,
 mixed arNavStartParams = false,
 array arSelectFields = Array()
);

Returns a list of elements filtered by arFilter. Static method.

Important! Starting from Information blocks module version 18.6.200 the method has new options to handle products, with updated method keys. Correspondingly, all CATALOG_*** parameters have deprecated.

Attention: Starting from Information blocks module version 20.5.0, the method no longer processes the keys CHECK_BP_TASKS_PERMISSIONS and TASKSTATUS.

See Also

Parameters

	   $res = CIBlockElement::GetList(Array(), Array("><NAME"=>Array(Array("A", "B"), Array("D", "H"))));
	   

Useful filters

• $arFilter = array("PROPERTY_CML2_SCAN_CODE") =>"" : returns all elements;
• $arFilter = array("PROPERTY_CML2_SCAN_CODE") =>false : returns all elements with empty values;
• $arFilter = array("PROPERTY_CML2_SCAN_CODE") =>"abc" : returns all elements whose scan code maches "abc" exactly;
• $arFilter = array("?PROPERTY_CML2_SCAN_CODE") =>"def" : returns all elements whose scan code contains the substring "def".

• $arFilter = array("!PROPERTY_CML2_SCAN_CODE") =>"" : returns all elements whose CML2_SCAN_CODE property is not empty;
• $arFilter = array("!PROPERTY_CML2_SCAN_CODE") =>false : returns only the elements with non-empty property values;
• $arFilter = array("!PROPERTY_CML2_SCAN_CODE") =>"abc" : returns all elements whose CML2_SCAN_CODE property value is not "abc";
• $arFilter = array("!?PROPERTY_CML2_SCAN_CODE") =>"def" : returns all elements whose CML2_SCAN_CODE property value does not include a "def" substring.

Using complex logic in filters

$arFilter = array(
  "IBLOCK_ID" => $IBLOCK_ID,
  "SECTION_CODE" => "orange",
  "INCLUDE_SUBSECTIONS" => "Y",
  //the nested filter with explicitly specified logic 
  array(
        "LOGIC" => "OR",
        0 => array("<PROPERTY_RADIUS" => 50, "=PROPERTY_CONDITION" => "Y"),
        1 => array(">=PROPERTY_RADIUS" => 50, "!=PROPERTY_CONDITION" => "Y"),
       ),
);

Fields of bound elements

• ID - the element ID;
• TIMESTAMP_X – the date and time an element was last modified, in the current website format;
• MODIFIED_BY – the ID of a user who was the last to modify an element;
• DATE_CREATE – the date and time an element was created;
• CREATED_BY - the ID of a user who created an element;
• IBLOCK_ID - the information block ID;
• ACTIVE - the element active status (Y|N);
• ACTIVE_FROM - the date and time since when an element is active, in the current website format;
• ACTIVE_TO - the latest date and time when an element is active, in the current website format;
• SORT - the sort order;
• NAME - the element name;
• PREVIEW_PICTURE - the thumbnail image ID;
• PREVIEW_TEXT - the short text;
• PREVIEW_TEXT_TYPE - type of the short text (html|text);
• DETAIL_PICTURE - the large image ID;
• DETAIL_TEXT – the detailed text;
• DETAIL_TEXT_TYPE - type of the detailed text (html|text);
• SHOW_COUNTER – the value of the impression counter;
• SHOW_COUNTER_START – the date and time of the very first impression, in the website format;
• CODE – the element symbolic code;
• TAGS – the element tags;
• XML_ID – the external ID;
• IBLOCK_SECTION_ID – the ID of the element’s parent section (if present).

• IBLOCK_TYPE_ID – the information block type ID;
• IBLOCK_CODE – the information block symbolic code;
• IBLOCK_NAME – the information block name;
• IBLOCK_EXTERNAL_ID – the information block external ID;
• DETAIL_PAGE_URL – the element page URL template as specified in the information block parameters;
• LIST_PAGE_URL – the elements list page URL template as specified in the information block parameters.

Examples

Example 1:

<?
$arSelect = Array("ID", "NAME", "DATE_ACTIVE_FROM");
$arFilter = Array("IBLOCK_ID"=>IntVal($yvalue), "ACTIVE_DATE"=>"Y", "ACTIVE"=>"Y");
$res = CIBlockElement::GetList(Array(), $arFilter, false, Array("nPageSize"=>50), $arSelect);
while($ob = $res->GetNextElement())
{
 $arFields = $ob->GetFields();
 print_r($arFields);
}
?> 

Example can be updated by adding property display for each item. It's convenient for use, without the need to implement GetProperty. In case of Iblocks 2.0, you need to add IBLOCK_ID to $arSelect.

<?
$arSelect = Array("ID", "IBLOCK_ID", "NAME", "DATE_ACTIVE_FROM","PROPERTY_*");//IBLOCK_ID and ID must be specified, see description of arSelectFields above
$arFilter = Array("IBLOCK_ID"=>IntVal($yvalue), "ACTIVE_DATE"=>"Y", "ACTIVE"=>"Y");
$res = CIBlockElement::GetList(Array(), $arFilter, false, Array("nPageSize"=>50), $arSelect);
while($ob = $res->GetNextElement()){ 
 $arFields = $ob->GetFields();  
print_r($arFields);
 $arProps = $ob->GetProperties();
print_r($arProps);
}
?>

Example 2:

<?
// selection of active items from $yvalue iblock, 
// with property value set with SRC character code
// and activity start date older than 1 January 2003
// selected items can be grouped by activity date
$arFilter = Array(
 "IBLOCK_ID"=>IntVal($yvalue), 
 ">DATE_ACTIVE_FROM"=>date($DB->DateFormatToPHP(CLang::GetDateFormat("SHORT")), mktime(0,0,0,1,1,2003)), 
 "ACTIVE"=>"Y", 
 "!PROPERTY_SRC"=>false
 );
$res = CIBlockElement::GetList(Array("SORT"=>"ASC", "PROPERTY_PRIORITY"=>"ASC"), $arFilter, Array("DATE_ACTIVE_FROM"));
while($ar_fields = $res->GetNext())
{
 echo $ar_fields["DATE_ACTIVE_FROM"].": ".$ar_fields["CNT"]."<br>";
}
?> 

Example 3:

//displaying archive from expired items (news.list) 
$arFilter = array(
   "IBLOCK_ID" => $arResult["ID"],
   "IBLOCK_LID" => SITE_ID,
   "ACTIVE" => "Y",
   "CHECK_PERMISSIONS" => "Y", //singificantly overloads the system, but verifies access permissions
   " DateFormatToPHP(CLang::GetDateFormat("SHORT")), ); 

Example 4:

//selection of iblock items, to have 5 random items in the returned result
$rs = CIBlockElement::GetList (
   Array("RAND" => "ASC"),
   Array("IBLOCK_ID" => $IBLOCK_ID),
   false,
   Array ("nTopCount" => 5)
);

Example 5:

//use subqueries for filtering by several values of multiple property 
CModule::IncludeModule('iblock');

$rs = CIBlockElement::GetList(
   array(), 
   array(
   "IBLOCK_ID" => 21, 
   array("ID" => CIBlockElement::SubQuery("ID", array("IBLOCK_ID" => 21, "PROPERTY_PKE" => 7405))),
   array("ID" => CIBlockElement::SubQuery("ID", array("IBLOCK_ID" => 21, "PROPERTY_PKE" => 7410))),
   array("ID" => CIBlockElement::SubQuery("ID", array("IBLOCK_ID" => 21, "PROPERTY_PKE" => 7417)))
   ),
   false, 
   false,
   array("ID")
);

while($ar = $rs->GetNext()) {
    echo '<pre>';
    print_r($ar);
    echo '</pre>';
}

Example 6:

//next and previous product with account of sorting and in detail view
 $arrSortAlown = array('price'=> 'catalog_PRICE_1' , 'name'=> 'NAME', 'rating' => 'PROPERTY_RATING' , 'artnumber'=> 'PROPERTY_ARTNUMBER');

   $_sort = isset($arrSortAlown[$_GET['sort']]) ? $arrSortAlown[$_GET['sort']] : 'NAME';
   $_order = isset($_GET['order']) && $_GET['order']=='desc' ? 'DESC' : 'ASC';

   $sort_url = 'sort=' .( isset($_GET['sort'])? $_GET['sort'] : 'name')
                        .'&order='. (isset($_GET['order'])? $_GET['order'] : 'asc');
   
   
   $res = CIBlockElement::GetList(
      array("$_sort" => $_order),
      Array(
         "IBLOCK_ID"=>$arResult["IBLOCK_ID"], 
         "ACTIVE_DATE"=>"Y", "ACTIVE"=>"Y" , 
         "IBLOCK_SECTION_ID" => 
         $arResult["IBLOCK_SECTION_ID"]
      ),
      false, 
      array("nPageSize" => "1","nElementID" => $arResult["ID"]), 
      array_merge(Array("ID", "NAME","DETAIL_PAGE_URL"), array_values($arrSortAlown)) 
   );
   $navElement = array();
   while($ob = $res->GetNext()){
     $navElement[] = $ob;
   }

//printed:
<noindex>
<div class="navElement" style="float:right; clear:both;">
   <span class="l">
      <small><a href="<?=$navElement[0]['DETAIL_PAGE_URL']?>?<?=$sort_url?>">Previous product</a></small>
   </span>  
   <span class="r">
      <small><a href="<?=$navElement[2]['DETAIL_PAGE_URL']?>?<?=$sort_url?>">Next product</a></small>
   </span>
</div>
</noindex>

Example 7:

//prints undue and thus inactive event notices without component updates
// indicate filter name in the component and add filter itself in front of component:
<?
    $arrFilter=Array(array(
        "LOGIC" => "OR",
        array("DATE_ACTIVE_TO"=>false),
        array(">DATE_ACTIVE_TO"=>ConvertTimeStamp(time(),"FULL"))
        
    ));
  ?>  

Example 8:

//Iblock v18.6.700 now has option to sort the selected ID order, specified in the array

// sort IDs as follows
$ids = [115, 120, 117, 109, 128];
$rs = CIBlockElement::GetList(
   ['ID' => $ids],
   ['IBLOCK_ID' => '5', 'ID' => $ids],
   false, false,
   ['ID', 'IBLOCK_ID', 'NAME']
);
while ($ar = $rs->Fetch()) {
   echo $ar['ID'] . ' ';
}

// printed result:
// 115 120 117 109 128

Example 9:

//Iblock v21.700.100 now has an added nOffset key in arNavStartParams

\Bitrix\Main\Loader::includeModule('iblock');

$res = CIBlockElement::GetList(
    ['ID' => 'ASC'],
    ['IBLOCK_ID' => 2],
    false,
    ['nTopCount' => 5, 'nOffset' => 1000],
    ['ID', 'IBLOCK_ID', 'NAME']
);

while ($row = $res->Fetch())
{
    echo '<pre>', mydump($row), '</pre>';
}

// nTopCount - amount
// nOffset - indicated offset

Example 10. Print elements with non-empty value of list multiple property

${$FILTER_NAME}[]=array(
                        "ID" => CIBlockElement::SubQuery("ID", array(
                                "IBLOCK_ID" => $arParams['IBLOCK_ID'],
                                "!=PROPERTY_".$arProp["CODE"] => false
                            ))
                    );

Example 11. Creating search by catalog using the field SEARCHEBLE_CONTENT.

<?
CModule::IncludeModule('iblock'); 
$IBLOCK_ID = intval($_REQUEST['IBLOCK_ID']); 
$QUERY = trim($_REQUEST['q']); 
if($QUERY) { 
   $arSelect = Array("ID", "NAME", "DATE_ACTIVE_FROM", "DETAIL_PAGE_URL", "PREVIEW_PICTURE";  
   $arFilter = Array("IBLOCK_ID"=>$IBLOCK_ID, "ACTIVE_DATE"=>"Y", "ACTIVE"=>"Y", "SEARCHABLE_CONTENT"=>'%'.$_REQUEST['q'].'%');  
   $res = CIBlockElement::GetList(Array(), $arFilter, false, Array("nPageSize"=>50), $arSelect);  
   while($ob = $res->GetNextElement())  
   {  
          $arFields = $ob->GetFields();  
      print_r($arFields);    
   }     
}
?>

Example 12. For filtering by Date, i. e. from 12.09.2014 to 18.09.2014 inclusively, the filter will look as follows:

$date_from = '12.09.2014';
$date_to = '18.09.2014';

$db_el = CIBlockElement::GetList(
   array('ID' => 'DESC'),
   array(
      '>=DATE_CREATE' => $date_from,
      '<=DATE_CREATE' => $date_to . ' 23:59:59'      
   )
);