Plugin System Overview

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/itsmng/itsm-ng/llms.txt

Use this file to discover all available pages before exploring further.

​

Plugin Architecture

​

Plugin States

​

Plugin Directory Structure

plugins/myplugin/
├── setup.php           # Plugin configuration and registration
├── hook.php            # Hook implementations
├── locales/           # Translation files
│   ├── en_GB.mo
│   └── fr_FR.mo
├── inc/               # PHP classes
│   └── *.class.php
├── front/             # User interface files
│   └── *.php
└── ajax/              # AJAX handlers
    └── *.php

​

Core Plugin Files

​

setup.php

• plugin_version_myplugin() - Returns plugin metadata
• plugin_init_myplugin() - Initializes the plugin when loaded
• plugin_myplugin_install() - Installs the plugin (creates tables, etc.)
• plugin_myplugin_uninstall() - Uninstalls the plugin (removes data)

​

hook.php (Optional)

​

Plugin Capabilities

​

Registering Custom Item Types

Plugin::registerClass('PluginMyPluginItem', [
    'document_types' => true,
    'ticket_types' => true,
    'addtabon' => ['Computer', 'Ticket']
]);

• document_types - Allow documents to be attached
• ticket_types - Allow tickets to be created for this type
• networkport_types - Allow network ports
• addtabon - Add tabs to specified item types
• forwardentityfrom - Inherit entity from another item type

​

Hook System

• post_init - After all plugins are initialized
• post_plugin_install - After plugin installation
• post_plugin_uninstall - After plugin uninstallation
• post_plugin_enable - After plugin activation
• post_plugin_disable - After plugin deactivation
• post_plugin_clean - After plugin cleanup

​

Adding Search Options

function plugin_myplugin_getAddSearchOptionsNew($itemtype) {
    $options = [];
    
    if ($itemtype == 'Computer') {
        $options[] = [
            'id' => 9000,
            'table' => 'glpi_plugin_myplugin_items',
            'field' => 'custom_field',
            'name' => 'Custom Field'
        ];
    }
    
    return $options;
}

​

Database Relations

function plugin_myplugin_getDatabaseRelations() {
    return [
        'glpi_computers' => [
            'glpi_plugin_myplugin_items' => 'computers_id'
        ]
    ];
}

​

Custom Dropdowns

function plugin_myplugin_getDropdown() {
    return [
        'PluginMyPluginCategory' => __('My Plugin Category')
    ];
}

​

Plugin Requirements

​

Version Requirements

function plugin_version_myplugin() {
    return [
        'name' => 'My Plugin',
        'version' => '1.0.0',
        'author' => 'Your Name',
        'license' => 'GPLv2+',
        'homepage' => 'https://example.com',
        'requirements' => [
            'glpi' => [
                'min' => '10.0.0',
                'max' => '11.0.0'
            ],
            'php' => [
                'min' => '7.4.0',
                'exts' => ['curl', 'json']
            ]
        ]
    ];
}

​

CSRF Compliance

function plugin_init_myplugin() {
    global $PLUGIN_HOOKS;
    $PLUGIN_HOOKS['csrf_compliant']['myplugin'] = true;
}

​

Plugin Lifecycle

​

Initialization Flow

1. Discovery - ITSM-NG scans the plugins directory
2. Registration - Plugin information is stored in the database
3. Installation - plugin_myplugin_install() is called
4. Configuration - plugin_myplugin_check_config() validates setup
5. Activation - plugin_myplugin_check_prerequisites() is verified
6. Loading - plugin_init_myplugin() initializes the plugin

​

State Transitions

​

Plugin Directories

​

Localization

• Place translation files in locales/en_GB.mo, locales/fr_FR.mo, etc.
• Translations are automatically loaded when the plugin initializes
• Use standard gettext functions for translation

​

Best Practices

1. Always check prerequisites - Implement plugin_myplugin_check_prerequisites()
2. Validate configuration - Use plugin_myplugin_check_config() for required settings
3. Clean up on uninstall - Implement proper plugin_myplugin_uninstall()
4. Use namespaces - Prefix all classes, functions, and tables with your plugin name
5. CSRF compliance - Always set csrf_compliant hook to true
6. Version requirements - Specify clear GLPI and PHP version requirements
7. Database migrations - Handle version updates in your install function

​

Next Steps

• Installing Plugins - Learn how to install and manage plugins
• Developing Custom Plugins - Create your own ITSM-NG plugins