Frontend Request 

Extension key

frontend_request

Package name

maxserv/frontend-request

Version

2.0

Language

en

Author

MaxServ

License

This document is published under the Open Publication License.

Rendered

Tue, 05 May 2026 15:06:31 +0000

This extension helps you to handle frontend requests in TYPO3 from within the backend. It provides a javascript module that you can import in your own extension's javascript and based on parameters like the page id, language, and more, it returns a JSON object with the page information, such as the page title, description, and more.

This extension is not useful on its own, but it is meant to be used in combination with other extensions that need to handle frontend requests in the backend, such as Yoast SEO for TYPO3, which uses this extension to analyze the page content and provide analysis and suggestions for improving the page's SEO and readability.

Table of Contents:

Introduction 

Read about "frontend_request" in this chapter.

What does it do? 

This extension provides a simple way to handle frontend requests in TYPO3 from within the backend. It allows you to retrieve page information such as title, description, and more based on parameters like page id and language. This is particularly useful for extensions that need to analyze frontend content,such as SEO tools.

This extension does not do anything on its own but is designed to be used in conjunction with other extensions that require frontend request handling.

It provides a JavaScript module that can be imported into your own extension's JavaScript files.

Contribution 

Anyone is welcome to contribute to Frontend Request.

There are various ways you can contribute:

• Raise an issue on GitHub.
• Create a pull request with your bug fixes or new features.
• Improve this documentation via the "Edit on GitHub" workflow.

Please read the guidelines on how to contribute to this repository and how to report bugs.

Installation guide 

Install the extension using your preferred method.

Head over to your CLI and run the following command

composer require maxserv/frontend-request

Not using composer? Download the zip file from the TER and upload it through the Extension Manager.

Usage Guide 

The usage guide provides detailed information on how to use the features of the extension.

Javascript 

import FrontendRequest from "@maxserv/frontend-request/frontend-request.js"

class YourJavascriptClass {
    async fetchPage(pageId, languageId) {
        FrontendRequest.request({
            pageId: pageId,
            languageId: languageId,
        }).then((response) => {
            // Handle the response here
            console.log(response);
        }).catch((error) => {
            // Handle any errors here
            console.error(error);
        })
    }
}

$pageRenderer->getJavaScriptRenderer()->addJavaScriptModuleInstruction(
    JavaScriptModuleInstruction::create('@maxserv/frontend-request/frontend-request.js')->invoke(
        'requestWithEvent',
        [
            'pageId' => $pageId,
            'languageId' => $languageId,
            'additionalGetVars' => $additionalGetVars ?? '',
        ],
        'your-event-name'
    )
);

document.addEventListener('your-event-name', (event) => {
    // Handle the event here
    console.log(event.detail);
});

PageParser 

The PageParser is responsible for parsing the frontend response and transforming it into a JSON object.

The default parsers are:

• body: Has the complete body of the page.
• title: Contains the title of the page.
• metadata: Contains all the metatags of the page, structured by name and content.
• locale: Contains the locale of the page.
• url: Contains the URL of the page.
• favicon: Contains the URL of the favicon of the page.

<?php

namespace Vendor\Extension\Parser;

use MaxServ\FrontendRequest\Dto\RequestContext;
use MaxServ\FrontendRequest\PageParser\ParserInterface;

class MyCustomParser implements ParserInterface
{
    public function getIdentifier():  string
    {
        return 'custom_key'; // This will be the key used in the response
    }

    public function parse(string $html, RequestContext $context): string
    {
        // Your custom parsing logic goes here.
        return 'Parsed content';
    }
}

services:
    Vendor\Extension\Parser\MyCustomParser:
        tags: [ 'frontend_request.page_parser' ]

Events 

<?php

namespace Vendor\Package\EventListener;

use MaxServ\FrontendRequest\Event\ModifyUrlEvent;

final class ModifyUrlEventEventListener
{
    public function __invoke(ModifyUrlEvent $event)
    {
        $url = $event->getUrl();
        $site = $event->getSite();
        $parameters = $event->getParameters();

        // Create a new url based on your needs

        $event->setUrl($newUrl);
    }
}

<?php

namespace Vendor\Package\EventListener;

use MaxServ\FrontendRequest\Event\ModifyRequestEvent;

final class ModifyRequestEventListener
{
    public function __invoke(ModifyRequestEvent $event)
    {
        $request = $event->getRequest();
        $context = $event->getContext();

        $event->setRequest(
            $request->withHeader('X-Your-Own-Header', GeneralUtility::hmac(
                $context->getUrl()
            ))
        );
    }
}

Sitemap