Attention

TYPO3 v11 has reached end-of-life as of October 31th 2024 and is no longer being maintained. Use the version switcher on the top left of this page to select documentation for a supported version of TYPO3.

Need more time before upgrading? You can purchase Extended Long Term Support (ELTS) for TYPO3 v11 here: TYPO3 ELTS.

URI arguments and reserved keywords

Extbase uses special URI arguments to pass variables to Controller arguments and the framework itself.

Extbase uses a prefixed URI argument scheme that relies on plugin configuration.

For example, the example extension EXT:blog_example would use:

// Linebreaks just for readability.
https://example.org/blog/?tx_blogexample_bloglist[action]=show
&tx_blogexample_bloglist[controller]=Post
&tx_blogexample_bloglist[post]=4711
&cHash=...

// Actually, the [] parameters are often URI encoded, so this is emitted:
https://example.org/blog/?tx_blogexample_bloglist%5Baction%5D=show
&tx_blogexample_bloglist%5Bcontroller%5D=Post
&tx_blogexample_bloglist%5Bpost%5D=4711
&cHash=...

as the created URI to execute the showAction of the Controller PostController within the plugin BlogList.

The following arguments are evaluated:

tx_(extensionName)_(pluginName)[action]:

Controller action to execute

tx_(extensionName)_(pluginName)[controller]: Controller containing the action
tx_(extensionName)_(pluginName)[format]: Output format (usually html, can also be json or custom types)
cHash: the cHash always gets calculated to validate that the URI is allowed to be called. (see Caching variants - or: What is a "cache hash"?)

Any other argument will be passed along to the controller action and can be retrieved via $this->request->getArgument(). Usually this is auto-wired by the automatic parameter mapping of Extbase.

These URI arguments can also be used for the routing configuration, see Extbase plugin enhancer.

Warning

The listed keys action, controller and format are reserved keywords. Never use these as custom argument names to your controller actions, so instead of <f:uri.action action="new" arguments="{format: someVariable}"> you should use <f:uri.action action="new" arguments="{customFormat: someVariable}">. Else, using an argument like this would lead to TYPO3 exceptions of unresolvable Fluid template files!

When submitting a HTML <form>, the same URI arguments will be part of a HTTP POST request, with some more special ones:

tx_(extensionName)_(pluginName)[__referrer]

An array with information of the referring call (subkeys: @extension, @controller, @action,

arguments (hashed), @request (json)

tx_(extensionName)_(pluginName)[__trustedProperties]: List of properties to be submitted to an action (hashed and secured)

These two keys are also regarded as reserved keywords. Generally, you should avoid custom arguments interfering with either the @... or __... prefix notation.