Документация для разработчиков
Темная тема

IncludeComponent

Описание и параметры

mixed
	IncludeComponent(
	string componentName,
	string componentTemplate,
	array arParams=array(),
	object parentComponent=null,
	array arFunctionParams=array(),
	$returnResult = false
);

Метод подключает компонент 2.0. Нестатический метод.

Параметры

ПараметрОписание
componentNameИмя компонента. Например: "bitrix:news.detail".
componentTemplateИмя шаблона компонента. Если имя пустое, то подразумевается имя ".default".
arParamsМассив входных параметров компонента.
parentComponentОбъект родительского комплексного компонента, если компонент подключается из шаблона комплексного компонента. В шаблоне комплексного компонента определена переменная $component, которая содержит объект этого комплексного компонента.
arFunctionParamsМассив, содержащий дополнительные параметры отображения компонента:
"HIDE_ICONS"=>"Y" - не показывать панель настройки компонента в режиме редактировани/разработки;
"ACTIVE_COMPONENT"=>"N" - отключить компонент (код компонента не подключается).
returnResultПо умолчанию - false позволяет получить на выходе arResult компонента.

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

Возвращает код компонента.

Пример

// Подключим компонент каталога с шаблоном "по-умолчанию" на публичной странице сайта
$APPLICATION->IncludeComponent(
	"bitrix:catalog",
	"",
	Array(
		"SEF_MODE" => "N",
		"IBLOCK_TYPE_ID" => "catalog",
		"ACTION_VARIABLE" => "action",
		"CACHE_TIME" => 1*24*60*60,
		"BASKET_PAGE_TEMPLATE" => "/personal/basket.php",
	)
);

// Подключим компонент карточки фотографии с шаблоном "по-умолчанию" в шаблоне 
// комплексного компонента "фотогалерея"
$APPLICATION->IncludeComponent(
	"bitrix:photo.detail",
	"",
	Array(
		"IBLOCK_TYPE" => $arParams["IBLOCK_TYPE"],
		"IBLOCK_ID" => $arParams["IBLOCK_ID"],
		"ELEMENT_ID" => $arResult["VARIABLES"]["ELEMENT_ID"],
		"ELEMENT_CODE" => $arResult["VARIABLES"]["ELEMENT_CODE"],
	),
	$component
);


© «Битрикс», 2001-2024, «1С-Битрикс», 2024