IsContentUsedOnPageLayoutEvent

New in version 12.0: This event TYPO3\CMS\Backend\View\Event\IsContentUsedOnPageLayoutEvent serves as a drop-in replacement for the removed $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['cms/layout/class.tx_cms_layout.php']['record_is_used'] hook.

Use the PSR-14 event \TYPO3\CMS\Backend\View\Event\IsContentUsedOnPageLayoutEvent to identify if content has been used in a column that is not in a backend layout.

Example

Registration of the event in your extension's Services.yaml:

EXT:my_extension/Configuration/Services.yaml
services:
  # Place here the default dependency injection configuration

  MyVendor\MyExtension\Listener\ContentUsedOnPage:
    tags:
      - name: event.listener
        identifier: 'my-extension/view/content-used-on-page'

Read how to configure dependency injection in extensions.

The corresponding event listener class:

EXT:my_extension/Classes/Listener/ContentUsedOnPage.php
<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Listener;

use TYPO3\CMS\Backend\View\Event\IsContentUsedOnPageLayoutEvent;

final class ContentUsedOnPage
{
    public function __invoke(IsContentUsedOnPageLayoutEvent $event): void
    {
        // Get the current record from the event.
        $record = $event->getRecord();

        // This code will be your domain logic to indicate if content
        // should be hidden in the page module.
        if ((int)($record['colPos'] ?? 0) === 999
            && !empty($record['tx_myext_content_parent'])
        ) {
            // Flag the current element as not used. Set it to true, if you
            // want to flag it as used and hide it from the page module.
            $event->setUsed(false);
        }
    }
}

API

class TYPO3\CMS\Backend\View\Event\IsContentUsedOnPageLayoutEvent

Use this Event to identify whether a content element is used.

getRecord()
Return type

array

isRecordUsed()
Return type

bool

setUsed(bool $isUsed)
Parameters
  • $isUsed (bool) -- the isUsed

getKnownColumnPositionNumbers()
Return type

array

getPageLayoutContext()
Return type

TYPO3\CMS\Backend\View\PageLayoutContext