Custom Templates: Overview of Methods

Custom templates allow you to add your own templates to the site and page creation wizard.

The group of methods landing.demos.* helps manage custom templates. This section includes methods for registering, retrieving lists, and deleting templates. Separate methods are used for registered and file templates.

Quick navigation: all methods

User documentation: How to prepare a custom template

Getting StartedGetting Started

1. Prepare a site or page using the methods from the Sites section Sites section
2. Export the site using the landing.site.fullExport method
3. Save the exported array on the Bitrix24 application side
4. Pass the exported array to landing.demos.register
5. Check the result using the landing.demos.getList method

Key ParametersKey Parameters

XML_ID. The external code of the registered template. It is used when deleting a template via landing.demos.unregister. You can obtain it using the landing.demos.getList method. Deletion by code may affect related records of the template if they are registered in the application with the same code.

type. The type of template. It is specified during registration and when calling the landing.demos.getSiteList and landing.demos.getPageList methods. For example: page, store, knowledge.

tpl_type. The type of template usage in the wizard. This parameter is used when registering the template. There are two possible values: S — site template, P — page template.

Relationship with Other ObjectsRelationship with Other Objects

Site. A custom template is created based on an existing site or page using the methods from the Sites section. To do this, the site is first exported using the landing.site.fullExport method. Then, the exported array is passed to landing.demos.register.

Localization. The title, description, and string values in the supported fields of the template can be localized during registration. This is done using the lang and lang_original parameters. More details can be found in the article Template Localization.

Overview of MethodsOverview of Methods

Scope: landing

Who can execute the method: a user with View permission in the Sites section

Method	Description
landing.demos.register	Registers a template in the site and page creation wizard
landing.demos.getList	Retrieves a list of registered templates
landing.demos.getSiteList	Retrieves a list of templates for site creation
landing.demos.getPageList	Retrieves a list of templates for page creation
landing.demos.unregister	Deletes a registered custom template