modX.initialize

modX::initialize¶

Initializes MODX engine into a Context.

This includes preparing the session, pre-loading some common classes and objects, and loading the current site and context settings. It also runs initialization classes that extension packages register to override session handling, error handling or other initialization.

Syntax¶

boolean initialize ([string $contextKey = 'web'], [array|null $options = null])

• $contextKey (string) Indicates the context to initialize
• $options (array|null) An array of options for the initialization

Returns true if the context was initialized successfully, or was already initialized; false otherwise:

if (!$modx->initialize('web')) {
    // initialization failed
}

Example¶

Initialize the 'sports' Context.

$modx->initialize('sports');

See Also¶

• Contexts