modX.switchContext
Last updated Apr 14th, 2021 | Page history | Improve this page | Report an issue
modX::switchContext¶
Switches the primary Context for the modX instance.
Be aware that switching contexts does not allow custom session handling classes to be loaded. The gateway defines the session handling that is applied to a single request. To create a context with a custom session handler you must create a unique context gateway that initializes that context directly.
Syntax¶
API Doc: modX::switchContext()
boolean switchContext (string $contextKey, [boolean $reload = false])
-
$contextKey(string) The key of the context to switch to. required -
$reload(boolean) Set to true to force the context data to be regenerated before being switched to
Example¶
Switch to the 'sports' Context.
$modx->switchContext('sports');