What does it do? 

This extension displays a bar at the bottom of the screen on the frontend, from which you can access information per page.

You can use it to simulate scenarios to test page content, for example, user groups, time-restricted content or showing hidden content. You can also use it for general debugging.

The bar shows a summary of information about the page, an option to adjust the settings and a link to the according page in the backend.

Some important metrics are displayed right in the admin panel bar:

• TypoScript: number of messages
• Info: page load time / peak memory usage
• Debug: number of errors and warnings / amount of SQL queries / time spent executing SQL queries

From the bar you can open a larger panel to access detailed information about the page.

There is a switcher at the bottom right of the admin panel bar to turn it on and off for the page.

Installation with Composer 

Check whether you are already using the extension with:

composer show | grep adminpanel

This should either give you no result or something similar to:

typo3/cms-adminpanel       v12.4.11

If it is not installed yet, use the composer require command to install the extension:

composer require typo3/cms-adminpanel

The given version depends on the version of the TYPO3 Core you are using.

Installation without Composer 

In an installation without Composer, the extension is already shipped but might not be activated yet. Activate it as follows:

1. In the backend, navigate to the Admin Tools > Extensions module.
2. Click the Activate icon for the Admin Panel extension.

Next steps 

Configure the Admin Panel to be displayed to logged-in backend admins the TypoScript configuration config.admPanel = 1.

By default, the admin panel is displayed to logged-in admins only. This behaviour can be changed by setting admPanel.enable for certain backend users or groups.

TypoScript settings 

The following settings can be made in the project's TypoScript setup. See also Using and setting TypoScript.

User TSconfig settings 

The options below can be set in the user TSconfig of a backend user or backend user group. See also Using and setting user TSconfig.

General 

The General tab displays general TYPO3 related information about the current page.

Document Size

The size of the loaded HTML document

Page

The current page ID and type.

Frontend User Group

The current frontend user group restriction. Default is 0,-1 (no login required).

Cache

Whether the current page is cached or not.

UserIntObjects

Whether there are any USER_INT objects (uncached plugins) on the page. This is useful for performance analysis. See the USER_INT tab for more details.

Total Parsetime

The total parsetime TYPO3 needed to render the page.

PHP 

Information about the PHP installation on the server. This helps developers to quickly analyze available PHP Extensions, global constants or version constraints.

REQUEST 

This tab contains global PHP request information, for example the current content of the $_COOKIE variable and the $_SERVER variable.

This information helps developers to analyze the server environment further and find ini file paths or the IP address with which a user accesses the site.

USER_INT 

This is the detail view of the UserIntObjects section of the General tab. If there are USER_INT objects, an integrator or developer can see details here and use it to figure out which plugins are impacting the caching behavior.

Events 

The Events list shows all events that were dispatched while the current page was rendered. A developer can use this list while extending TYPO3 to find out which event to use on any given page.

Click the arrow to expand the details for an event to see basic information about the event's parameters.

Log 

The log tab shows all log entries that were generated during the current request. You can adjust the log levels and grouping in the settings.

Click the cog icon at the top right of the Admin Panel bar to configure the settings.

Page title 

TYPO3 has a concept of “Page Title Providers”. The section “Page title” displays all registered providers that were checked for the current page. This helps to debug where the currently used page title is coming from.

Query Information 

Displays a list of SQL queries that were generated on the current page and their performance.

Click on a query to open a detail view with the values used for the placeholders.

Show hidden content 

Use Show hidden pages and Show hidden records to reload the page and see any content that is set to 'disabled' in the backend.

The Ignore start and end time to view all records on a page regardless of the start and end time.

The Show fluid debug output reloads the page with an overlay indicating the Fluid sections and partials in use.

Simulate users and times 

Use the Simulate time control to specify a time for the page. This is particularly useful for editors who want to verify the display of scheduled or seasonal content.

Use the Simulate user group control to impersonate a particular user group when viewing the page. This is useful for editors who want to verify the display of restricted or permissions-based content.

Work with the cache 

Use the controls in this section to clear the current page from the cache, to clear the entire frontend cache or to turn off caching altogether.

Creating additional modules 

An admin panel module commonly has:

• An icon, an identifier, a short info and a label
• initializeModule and onSubmit methods for initialization (done early in the TYPO3 Request) and for reacting to changes (onSubmit is executed when the settings are updated)
• Settings that influence page rendering or page display
• Methods to provide custom CSS and JavaScript files
• Submodules

To create your own Admin Panel module 

1. Create a new PHP class extending \TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule and implementing TYPO3\CMS\Adminpanel\ModuleApi\ShortInfoProviderInterface. If you don't implement the ShortInfoProviderInterface, your module will not be shown in the module menu.

2. Implement at least the following methods:

   • getIdentifier - A unique identifier for your module. For example mynamespace_modulename
   • getIconIdentifier - An icon identifier which is resolved via the icon API. Make sure to use a registered icon here.
   • getLabel - Speaking label for the module. You can access language files via $this->getLanguageService()
   • getShortInfo - Displayed next to the module label, may contain aggregated infos (such as Total Parse Time: 200ms)
3. Register your module by adding the following in your ext_localconf.php. Using before or after you can influence where your module will be

displayed in the module menu by referencing the identifier / array key of other modules.

$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['adminpanel']['modules']['mynamespace_modulename'] = [
    'module' =>  \Your\Namespace\Adminpanel\Modules\YourModule::class,
    'before' => ['cache'],
];

Copied!

1. Ensure that your module class is defined as 'public' in the Services.yaml file.

Modules themselves do provide settings for the page rendering and global actions (like preview settings, clearing caches or adding action buttons for editing the page) but do not provide further content.

If you want to display additional content in the Admin Panel (like rendering times or backtraces), you have to add a submodule to your main module.

Adding settings 

Adding a sub-module 

An Admin Panel submodule has:

• An identifier and a label.
• initializeModule and onSubmit methods for initialization (done early in the TYPO3 Request) and reacting to changes (onSubmit is executed when the settings are updated).
• Module content (for example the Info submodules display information about the current page or server configuration).
• Settings influencing their module content (for example the TypoScript Time / Rendering sub module has settings that influence whether to display messages or not).

As soon as a module has a submodule it will be displayed in the main Admin Panel. Modules without submodules may only provide settings, and are only displayed in the Settings overview.

Adding a submodule is similar to adding a module.

1. First, create a new class that extends AbstractSubModule. Implement at least the following methods:

   • getIdentifier - A unique identifier for your sub module (for example submodulename)
   • getLabel - Speaking label for the module - you can access language files via $this->getLanguageService()
   • getContent - The rendered HTML content for your module

2. Register your sub module by adding the following in your ext_localconf.php

   $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['adminpanel']['modules']['mynamespace_modulename']['submodules']['submodulename'] = [
       'module' => \Your\Namespace\Adminpanel\Modules\YourModule\Submodule::class
   ];

   Copied!

Where mynamespace_modulename references the main module where you want to add your submodule, and submodulename is the identifier of your sub module. This way, you can also register new custom sub modules to existing main modules.

Examples 

You can find examples for main and sub modules and their registration in the Admin Panel extension. Short ones for a quick look are:

• adminpanel/Classes/Modules/Info/PhpInformation.php (Submodule)
• adminpanel/Classes/Modules/InfoModule.php (Main module, serves as submodule wrapper only)
• adminpanel/Classes/Modules/CacheModule.php (Main module, custom rendering settings)