Documentation

getFolders

Attention! We strongly recommend first to learn more about Sites module REST documentation to understand how the module functions (with REST available in Bitrix24 Self-hosted editions). View this documentation as useful source when working with Bitrix24 Self-hosted editions and when you want to learn more about API.

Site::getFolders(
   $siteId,
   $filter
);

Method gets site folders.

Parameters

Parameters Description Available from version
$siteId Site ID.

Attention: Requires write access permissions for a specific site.

$filter Optional filter. Can have the following fields:
  • ACTIVE – folder active status (Y/N). Created inactive by default;
  • DELETED – folder deleted (Y/N). Existing folders returned by default;
  • PARENT_ID – parent folder ID;
  • TITLE – folder title;
  • INDEX_ID – folder page index ID;
  • CODE – folder character code;
  • CREATED_BY_ID – user ID who created the folder;
  • MODIFIED_BY_ID – user ID who edited the folder;
  • DATE_CREATE – folder created date;
  • DATE_MODIFY – folder updated date.

Example

if (\Bitrix\Main\Loader::includeModule('landing'))
{
   $folders = \Bitrix\Landing\Site::getFolders(2076, ['PARENT_ID' => 139]);
   print_r($folders);
}


© «Bitrix24», 2001-2024
Up