Plugin Development

plugins/
└── my_plugin/
    ├── init.php      # required — the whole plugin definition
    ├── icon.png      # optional — shown in the plugin list
    ├── index.html    # optional — blocks directory listing

<?php
// prevent illegal run
if (! defined('IN_PLUGINS_SYSTEM')) {
    exit();
}

$kleeja_plugin['my_plugin']['information'] = [ /* ... */ ];
$kleeja_plugin['my_plugin']['first_run']['en'] = 'Thanks for installing!';
$kleeja_plugin['my_plugin']['install']   = function ($plg_id) { /* ... */ };
$kleeja_plugin['my_plugin']['update']    = function ($old_version, $new_version) { /* ... */ };
$kleeja_plugin['my_plugin']['uninstall'] = function ($plg_id) { /* ... */ };
$kleeja_plugin['my_plugin']['functions'] = [ /* hook_name => callable */ ];

$kleeja_plugin['my_plugin']['information'] = [
    'plugin_title' => [
        'en' => 'My Plugin',
        'ar' => 'إضافتي',
    ],
    'plugin_developer' => 'Your Name',
    'plugin_version'   => '1.0',
    'plugin_description' => [
        'en' => 'Does something useful',
        'ar' => 'تقوم بشيء مفيد',
    ],
    'plugin_kleeja_version_min' => '3.2.0',
    'plugin_kleeja_version_max' => '3.9',
    'plugin_priority'           => 0,
    'settings_page'             => 'cp=options&smt=my_plugin',
];

$kleeja_plugin['my_plugin']['first_run']['en'] = '
Thank you for installing this plugin. Report bugs to: <br>
info@example.com
';

$kleeja_plugin['my_plugin']['install'] = function ($plg_id) {
    add_config_r([
        'my_plugin_enabled' => [
            'value'  => '1',
            'html'   => configField('my_plugin_enabled', 'yesno'),
            'plg_id' => $plg_id,
            'type'   => 'my_plugin',
            'order'  => '1',
        ],
        'my_plugin_api_key' => [
            'value'  => '',
            'html'   => configField('my_plugin_api_key'),
            'plg_id' => $plg_id,
            'type'   => 'my_plugin',
            'order'  => '2',
        ],
    ]);

    add_olang([
        'CONFIG_KLJ_MENUS_MY_PLUGIN' => 'My Plugin settings',
        'MY_PLUGIN_ENABLED'          => 'Enable the plugin',
        'MY_PLUGIN_API_KEY'          => 'API key',
    ], 'en', $plg_id);
};

$kleeja_plugin['my_plugin']['update'] = function ($old_version, $new_version) {
    if (version_compare($old_version, '1.1', '<')) {
        add_config('my_plugin_timeout', '30', 3, configField('my_plugin_timeout'), 'my_plugin');
    }

    if (version_compare($old_version, '2.0', '<')) {
        update_config('my_plugin_api_key', '');
    }
};

$kleeja_plugin['my_plugin']['uninstall'] = function ($plg_id) {
    delete_config([
        'my_plugin_enabled',
        'my_plugin_api_key',
    ]);

    foreach (['ar', 'en'] as $language) {
        delete_olang(null, $language, $plg_id);
    }
};

is_array($plugin_run_result = Plugins::getInstance()->run('end_common', get_defined_vars()))
    ? extract($plugin_run_result)
    : null; //run hook

extract(runHook('begin_download_page', get_defined_vars()));

$kleeja_plugin['my_plugin']['functions'] = [
    // change a variable in the caller's scope
    'Saaheader_links_func' => function ($args) {
        $extra = $args['extra'] . '<meta name="generator" content="Kleeja">';

        return compact('extra');
    },

    // observe only — no return value
    'ok_added_users_register' => function ($args) {
        my_plugin_log('new user: ' . $args['username']);
    },
];

Plugins::getInstance()->run("require_admin_page_begin_{$go_to}", get_defined_vars());
Plugins::getInstance()->run("require_admin_page_end_{$go_to}", get_defined_vars());
Plugins::getInstance()->run("not_exists_{$go_to}", get_defined_vars());

add_config_r([
    'my_plugin_mode' => [
        'value'  => 'fast',
        'html'   => configField('my_plugin_mode', 'select', [
            'Fast'     => 'fast',
            'Accurate' => 'accurate',
        ]),
        'plg_id' => $plg_id,
        'type'   => 'my_plugin',
        'order'  => '1',
    ],
]);

add_olang([
    'CONFIG_KLJ_MENUS_MY_PLUGIN' => 'My Plugin settings',
    'MY_PLUGIN_MODE'             => 'Processing mode',
], 'en', $plg_id);

$kleeja_plugin['my_plugin']['functions'] = [
    'end_index_page' => function ($args) {
        global $config;

        if ($config['my_plugin_mode'] === 'fast') {
            // ...
        }
    },
];

add_olang(['MY_PLUGIN_TITLE' => 'My Plugin'], 'en', $plg_id);
add_olang(['MY_PLUGIN_TITLE' => 'إضافتي'], 'ar', $plg_id);

$kleeja_plugin['zaki_admin_theme']['functions'] = [
    'end_common' => function ($args) {
        if (! defined('IN_ADMIN')) {
            return;
        }

        global $config;

        $args['STYLE_PATH_ADMIN_ABS']   = PATH . 'plugins/zaki_admin_theme/zaki/';
        $args['DEFAULT_PATH_ADMIN_ABS'] = PATH . 'plugins/zaki_admin_theme/zaki/';
        $args['DEFAULT_PATH_ADMIN']     = $config['siteurl'] . 'plugins/zaki_admin_theme/zaki/';
        $args['STYLE_PATH_ADMIN']       = $config['siteurl'] . 'plugins/zaki_admin_theme/zaki/';

        return $args;
    },
];

$kleeja_plugin['my_plugin']['functions'] = [
    'default_go_page' => function ($args) {
        if (g('go', 'str') !== 'mypage') {
            return;
        }

        global $tpl;

        $tpl->assign('my_message', 'Hello from my plugin');

        $no_request = false;
        $stylee     = 'my_page';
        $styleePath = PATH . 'plugins/my_plugin/templates/';

        return compact('no_request', 'stylee', 'styleePath');
    },
];

'not_exists_mypanel' => function ($args) {
    $include_alternative = PATH . 'plugins/my_plugin/admin_page.php';

    return compact('include_alternative');
},

zip -r my_plugin.zip my_plugin -x "*.git*"

public function getDebugInfo(): array
{
    if (!defined('DEV_STAGE')) {
        return [];
    }

    return [
        'all_plugins_hooks' => $this->all_plugins_hooks,
        'installed_plugins' => $this->installed_plugins,
    ];
}

define('STOP_PLUGINS', true);

<?php
// prevent illegal run
if (! defined('IN_PLUGINS_SYSTEM')) {
    exit();
}

$kleeja_plugin['footer_note']['information'] = [
    'plugin_title' => [
        'en' => 'Footer Note',
        'ar' => 'ملاحظة التذييل',
    ],
    'plugin_developer' => 'Your Name',
    'plugin_version'   => '1.0',
    'plugin_description' => [
        'en' => 'Appends a custom note to the site footer',
        'ar' => 'تضيف ملاحظة مخصصة إلى تذييل الموقع',
    ],
    'plugin_kleeja_version_min' => '3.2.0',
    'plugin_kleeja_version_max' => '3.9',
    'plugin_priority'           => 0,
    'settings_page'             => 'cp=options&amp;smt=footer_note',
];

$kleeja_plugin['footer_note']['first_run']['en'] = 'Set your note in Admin → Settings → Footer note.';

$kleeja_plugin['footer_note']['install'] = function ($plg_id) {
    add_config_r([
        'footer_note_text' => [
            'value'  => '',
            'html'   => configField('footer_note_text'),
            'plg_id' => $plg_id,
            'type'   => 'footer_note',
            'order'  => '1',
        ],
    ]);

    add_olang([
        'CONFIG_KLJ_MENUS_FOOTER_NOTE' => 'Footer note',
        'FOOTER_NOTE_TEXT'             => 'Note text',
    ], 'en', $plg_id);

    add_olang([
        'CONFIG_KLJ_MENUS_FOOTER_NOTE' => 'ملاحظة التذييل',
        'FOOTER_NOTE_TEXT'             => 'نص الملاحظة',
    ], 'ar', $plg_id);
};

$kleeja_plugin['footer_note']['update'] = function ($old_version, $new_version) {
    // no migrations yet
};

$kleeja_plugin['footer_note']['uninstall'] = function ($plg_id) {
    delete_config(['footer_note_text']);

    foreach (['ar', 'en'] as $language) {
        delete_olang(null, $language, $plg_id);
    }
};

$kleeja_plugin['footer_note']['functions'] = [
    'print_Saafooter_func' => function ($args) {
        global $config;

        if (empty($config['footer_note_text'])) {
            return;
        }

        $note   = '<p class="footer-note">' . htmlspecialchars($config['footer_note_text']) . '</p>';
        $footer = str_replace('</body>', $note . '</body>', $args['footer']);

        return compact('footer');
    },
];