Hook: config_end_render

The config_end_render hook is executed at the end of the configuration file. This file is the first to load for every page in JScms, making this hook ideal for initializing settings, adding configurations, or extending functionality before the application logic begins.

Usage

DynamicHooks::executeHook('config_end_render', false, $jkv, $lang);
    

This hook is triggered using the DynamicHooks::executeHook() method with the following parameters:

• Hook Name: 'config_end_render' - The unique identifier for this hook.
• Default Value: false - The default return value if no callbacks are registered.
• Context Parameters:
• $jkv - The configuration array containing JScms settings.
• $lang - The active language for JScms.

Purpose

The config_end_render hook is useful for tasks that need to occur immediately after the configuration file is fully loaded. Examples include modifying or extending configuration values, setting global variables, or adding initialization logic for plugins or modules.

Example Implementation

DynamicHooks::addHook('config_end_render', function ($jkv, $lang) {
    // Add a custom setting to the configuration
    $jkv['custom_setting'] = 'custom_value';

    // Log the active language for debugging purposes
    error_log("Config file loaded with active language: " . $lang);

    // Initialize a custom service or library
    if (!isset($jkv['custom_library_initialized'])) {
        CustomLibrary::initialize($jkv, $lang);
        $jkv['custom_library_initialized'] = true;
    }
}, 'custom_plugin');
    

Best Practices

• Ensure changes made in this hook do not conflict with the core configuration values.
• Use this hook for tasks that need to run before any page-specific logic is processed.
• Keep logic efficient to avoid slowing down the application initialization process.

Troubleshooting

• If the hook does not execute, confirm that it is registered correctly with the appropriate namespace.
• Check for errors in the callback function, such as invalid configurations or missing dependencies.
• Use logging to debug any issues during execution.