Configuration
Site Set Settings (TYPO3 v13+)
When using Site Sets, the extension provides configurable settings in your site configuration. Add the contexts Site Set to your site:
imports:
- { resource: "EXT:contexts/Configuration/Sets/Contexts/config.yaml" }
settings:
contexts:
debug: false
The following setting is available:
contexts.debug
-
- type
-
boolean
- Default
-
false
Enable debug output in the frontend. When enabled, an HTML comment
<!-- Contexts Extension Debug Mode Active -->is added to the page header. Use in development only.
Note
Version 5.0.0 removed the contexts.matchMode and
contexts.cacheLifetimeModifier settings. Neither of them was ever
read by the extension. Remove them from your site configuration; they
have no replacement.
Page and Content Element Settings
Context visibility is configured directly on page and content element records via the Contexts tab in the TYPO3 backend.
Each context record appears with two options:
- Visible: yes — record is only shown when the context is active
- Visible: no — record is hidden when the context is active
The extension adds two database columns to controlled tables:
tx_contexts_enable- Comma-separated list of context UIDs that must be active for the record to be visible.
tx_contexts_disable- Comma-separated list of context UIDs that hide the record when active.
Caching Considerations
Context-dependent content affects page caching. The extension handles this through several mechanisms:
- Query restriction: The
ContextRestrictionclass automatically adds WHERE clauses to database queries, filtering records based on active contexts. - Cache hash modification: When query parameter contexts are active, the extension adds context identifiers to the page cache hash, ensuring separate cache entries per context combination.
- Menu filtering: Menu items are filtered based on context visibility settings, so navigation reflects the current context.
- Cache invalidation on context changes: TYPO3 caches the result
of
Modify- and with it theTypo Script Config Event config.entries this extension adds - under an identifier derived from the TypoScript sources, not from the context records. Saving, deleting or restoring a context record therefore flushes thelink Vars pagescache group (hash,pages,rootlineandtyposcript) from the DataHandler hook. No manual cache flush is needed after adding a GET parameter context.
New in version 5.0.0
Before 5.0.0 a new or renamed GET parameter context did not reach
config. until the caches were flushed by hand.
Tip
For pages that depend heavily on context state, consider using
config.no_cache = 1 in TypoScript or use context-aware
cache tags to ensure correct content delivery.