InitComponentTemplate

bool
InitComponentTemplate([
 string templatePage,
 siteTemplate = false,
 customTemplatePath = ""]
);

The method initializes component template. After this method is called, a template object can be retrieved via the method CBitrixComponent::GetTemplate. In this case, template component is connected by the method CBitrixComponent::ShowComponentTemplate. Non-static method.

If the template object is not required for the component code, use one method CBitrixComponent::IncludeComponentTemplate which both initialises and connects a template.

Parameters

Returned value

Returns True on successful initialization, returns False otherwise.

Example

if ($this->InitComponentTemplate($templatePage))
{
	$template = & $this->GetTemplate();
	$folderPath = $template->GetFolder();
	if (strlen($folderPath) > 0)
	{
		* * *
	}
	$this->ShowComponentTemplate();
}

See Also