Jump to main content Jump to doc navigation

modX.switchContext

Mark Hamstra Anton Tarasov Ibochkarev

Last updated Apr 14th, 2021 | Page history | Improve this page | Report an issue

Support the team building MODX with a monthly donation.

The budget raised through OpenCollective is transparent, including payouts, and any contributor can apply to be paid for their work on MODX.

Backers

  • modmore
  • Jens Wittmann – Gestaltung & Entwicklung
  • eydolan
  • Nick Clark
  • deJaya
  • Following Sea
  • Lefthandmedia
  • YJ
  • Sepia River Studios
  • Murray Wood
  • Digital Penguin
  • Dannevang Digital
  • Richard
  • Anton Tarasov
  • Fabian Christen
  • Chris Fickling
  • CrewMark
  • Raffy
  • modmore

Budget

$307 per month—let's make that $500!

 Learn more

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');

See Also