Editing Section of LANDING_BLOCK

We are still updating this page

Some data may be missing here — we will fill it in shortly.

Currently, developers have the ability to integrate into the editing sections of any block. In such cases, a button to call your application will appear next to the "Edit" and "Design" buttons of the block.

The code for embedding the application depends on the block code and generally looks like this: LANDING_BLOCK_<CODE>. If it’s a system block, it’s clear that you need to insert the block code instead of <CODE> (examples below). However, when embedding into a block registered by you, you need to substitute its identifier.

For example:

  1. Register a block. The method will return the block ID. Let’s say it equals 1132 for this example.
  2. When registering the embedding location, specify the code: LANDING_BLOCK_repo_1132 (or LANDING_BLOCK_REPO_1132, case does not matter).

Parameters

The following parameters are available for this embedding location:

Parameter

Description

Available from

ID
unknown

– identifier of the block.

CODE
unknown

– symbolic code of the block.

LID
unknown

– identifier of the page.

You can obtain parameters from PLACEMENT_OPTIONS:

$placement = isset($_REQUEST['PLACEMENT_OPTIONS'])
            ? json_decode($_REQUEST['PLACEMENT_OPTIONS'], true)
            : [];

Examples

try
        {
        	const response = await $b24.callMethod(
        		'landing.repo.bind',
        		{
        			fields: {
        				PLACEMENT: 'LANDING_BLOCK_04.1.one_col_fix_with_title',
        				PLACEMENT_HANDLER: 'https://cpe/rt/placement.php',
        				TITLE: 'My block'
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        		console.error(result.error());
        	else
        		console.info(result);
        }
        catch(error)
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.repo.bind',
                    [
                        'fields' => [
                            'PLACEMENT'        => 'LANDING_BLOCK_04.1.one_col_fix_with_title',
                            'PLACEMENT_HANDLER' => 'https://cpe/rt/placement.php',
                            'TITLE'            => 'My block',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error binding landing block: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.repo.bind',
            {
                fields: {
                    PLACEMENT: 'LANDING_BLOCK_04.1.one_col_fix_with_title',
                    PLACEMENT_HANDLER: 'https://cpe/rt/placement.php',
                    TITLE: 'My block'
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.info(result.data());
            }
        );

If you want to embed a universal application for every block, you should specify the code with *:

try
        {
        	const response = await $b24.callMethod(
        		'landing.repo.bind',
        		{
        			fields: {
        				PLACEMENT: 'LANDING_BLOCK_*',
        				PLACEMENT_HANDLER: 'https://cpe/rt/placement.php',
        				TITLE: 'My block'
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	if(result.error())
        		console.error(result.error());
        	else
        		console.info(result);
        }
        catch(error)
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'landing.repo.bind',
                    [
                        'fields' => [
                            'PLACEMENT'        => 'LANDING_BLOCK_*',
                            'PLACEMENT_HANDLER' => 'https://cpe/rt/placement.php',
                            'TITLE'            => 'My block',
                        ],
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                error_log($result->error());
            } else {
                echo 'Success: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error binding landing repository: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'landing.repo.bind',
            {
                fields: {
                    PLACEMENT: 'LANDING_BLOCK_*',
                    PLACEMENT_HANDLER: 'https://cpe/rt/placement.php',
                    TITLE: 'My block'
                }
            },
            function(result)
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.info(result.data());
            }
        )

Updating a Block from the Application

In the opened application, there is a command to update a specific block. It is assumed that after working with the block from which the application was called, you may need to update it. This is done through the refreshBlock command.

Example

try
        {
        	const response = await $b24.callMethod(
        		'placement.call',
        		{
        			type: 'refreshBlock',
        			params: {
        				id: 123 // block with identifier 123
        			}
        		}
        	);
        	
        	const result = response.getData().result;
        	console.log('Block successfully updated');
        	// close the slider
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->placement
                ->call(
                    'refreshBlock',
                    [
                        'id' => 123, // block with identifier 123
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Block successfully updated';
            // close the slider
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error updating block: ' . $e->getMessage();
        }
        
BX24.placement.call(
            'refreshBlock',
            {
                id: 123 // block with identifier 123
            },
            function()
            {
                console.log('Block successfully updated');
                // close the slider
            }
        );

How to Use Examples in Documentation

Previous
Settings Menu
Next
Remove Embedding Locations